Skip to content

update_media_pipeline_kinesis_video_stream_pool async

update_media_pipeline_kinesis_video_stream_pool(
    identifier: NonEmptyString,
    *,
    config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
    stream_configuration: Optional[KinesisVideoStreamConfigurationUpdate] = None,
) -> UpdateMediaPipelineKinesisVideoStreamPoolResponse

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Parameters:

  • identifier (NonEmptyString) –

    The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

  • stream_configuration (Optional[KinesisVideoStreamConfigurationUpdate], default: None ) –

    The configuration settings for the video stream.

Raises:

Source code in docs_src/capo_chime_sdk_media_pipelines/_services/async_chime_sdk_media_pipelines.py
async def update_media_pipeline_kinesis_video_stream_pool(
    self,
    identifier: "capo_chime_sdk_media_pipelines.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
    stream_configuration: Optional[
        "capo_chime_sdk_media_pipelines.types.kinesis_video_stream_configuration_update.KinesisVideoStreamConfigurationUpdate"
    ] = None,
) -> "capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_response.UpdateMediaPipelineKinesisVideoStreamPoolResponse":
    """<p>Updates an Amazon Kinesis Video Stream pool in a media pipeline.</p>

    Args:
        identifier: <p>The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.</p>
        stream_configuration: <p>The configuration settings for the video stream.</p>

    Raises:
        capo_chime_sdk_media_pipelines.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_media_pipelines.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_media_pipelines.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_media_pipelines.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime_sdk_media_pipelines.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_media_pipelines.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_media_pipelines.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_media_pipelines.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_media_pipelines.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_request.UpdateMediaPipelineKinesisVideoStreamPoolRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_response.UpdateMediaPipelineKinesisVideoStreamPoolResponse"
    ]:
        import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.update_media_pipeline_kinesis_video_stream_pool

        (
            output,
            http_response,
        ) = await capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.update_media_pipeline_kinesis_video_stream_pool.async_update_media_pipeline_kinesis_video_stream_pool(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_response.UpdateMediaPipelineKinesisVideoStreamPoolResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_response

        return capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateMediaPipelineKinesisVideoStreamPool",
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_media_pipelines.types.update_media_pipeline_kinesis_video_stream_pool_request.UpdateMediaPipelineKinesisVideoStreamPoolRequest = {
        "identifier": identifier
    }
    if stream_configuration is not None:
        input_["stream_configuration"] = stream_configuration

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output