Skip to content

update_flow_media_stream async

update_flow_media_stream(
    flow_arn: FlowArn,
    media_stream_name: str,
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    attributes: Optional[MediaStreamAttributesRequest] = None,
    clock_rate: Optional[int] = None,
    description: Optional[str] = None,
    media_stream_type: Optional[MediaStreamType] = None,
    video_format: Optional[str] = None,
) -> UpdateFlowMediaStreamResponse

Updates an existing media stream.

Parameters:

  • attributes (Optional[MediaStreamAttributesRequest], default: None ) –

    The attributes that you want to assign to the media stream.

  • clock_rate (Optional[int], default: None ) –

    The sample rate for the stream. This value in measured in kHz.

  • description (Optional[str], default: None ) –

    A description that can help you quickly identify what your media stream is used for.

  • flow_arn (FlowArn) –

    The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.

  • media_stream_name (str) –

    The media stream that you updated.

  • media_stream_type (Optional[MediaStreamType], default: None ) –

    The type of media stream.

  • video_format (Optional[str], default: None ) –

    The resolution of the video.

Raises:

Source code in docs_src/capo_mediaconnect/_services/async_media_connect.py
async def update_flow_media_stream(
    self,
    flow_arn: "capo_mediaconnect.types.flow_arn.FlowArn",
    media_stream_name: str,
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    attributes: Optional[
        "capo_mediaconnect.types.media_stream_attributes_request.MediaStreamAttributesRequest"
    ] = None,
    clock_rate: Optional[int] = None,
    description: Optional[str] = None,
    media_stream_type: Optional[
        "capo_mediaconnect.types.media_stream_type.MediaStreamType"
    ] = None,
    video_format: Optional[str] = None,
) -> "capo_mediaconnect.types.update_flow_media_stream_response.UpdateFlowMediaStreamResponse":
    """<p> Updates an existing media stream.</p>

    Args:
        attributes: <p> The attributes that you want to assign to the media stream.</p>
        clock_rate: <p>The sample rate for the stream. This value in measured in kHz. </p>
        description: <p>A description that can help you quickly identify what your media stream is used for. </p>
        flow_arn: <p> The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.</p>
        media_stream_name: <p> The media stream that you updated.</p>
        media_stream_type: <p>The type of media stream. </p>
        video_format: <p>The resolution of the video. </p>

    Raises:
        capo_mediaconnect.errors.bad_request_exception.BadRequestException: <p>This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message. </p>
        capo_mediaconnect.errors.forbidden_exception.ForbiddenException: <p>You do not have sufficient access to perform this action. </p>
        capo_mediaconnect.errors.internal_server_error_exception.InternalServerErrorException: <p>The server encountered an internal error and is unable to complete the request. </p>
        capo_mediaconnect.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system. </p>
        capo_mediaconnect.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable or busy. </p>
        capo_mediaconnect.errors.too_many_requests_exception.TooManyRequestsException: <p>The request was denied due to request throttling. </p>
        capo_mediaconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mediaconnect.types.update_flow_media_stream_request.UpdateFlowMediaStreamRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediaconnect.types.update_flow_media_stream_response.UpdateFlowMediaStreamResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.update_flow_media_stream

        (
            output,
            http_response,
        ) = await capo_mediaconnect._operations.media_connect.update_flow_media_stream.async_update_flow_media_stream(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFlowMediaStream")
    )
    input_: capo_mediaconnect.types.update_flow_media_stream_request.UpdateFlowMediaStreamRequest = {
        "flow_arn": flow_arn,
        "media_stream_name": media_stream_name,
    }
    if attributes is not None:
        input_["attributes"] = attributes
    if clock_rate is not None:
        input_["clock_rate"] = clock_rate
    if description is not None:
        input_["description"] = description
    if media_stream_type is not None:
        input_["media_stream_type"] = media_stream_type
    if video_format is not None:
        input_["video_format"] = video_format

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