Skip to content

describe_flow_source_metadata

describe_flow_source_metadata(
    flow_arn: FlowArn, *, config_overrides: Optional[MediaConnectClientConfig] = None
) -> DescribeFlowSourceMetadataResponse

The DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data.

Parameters:

  • flow_arn (FlowArn) –

    The Amazon Resource Name (ARN) of the flow.

Raises:

Source code in docs_src/capo_mediaconnect/_services/media_connect.py
def describe_flow_source_metadata(
    self,
    flow_arn: "capo_mediaconnect.types.flow_arn.FlowArn",
    *,
    config_overrides: Optional[MediaConnectClientConfig] = None,
) -> "capo_mediaconnect.types.describe_flow_source_metadata_response.DescribeFlowSourceMetadataResponse":
    """<p> The <code>DescribeFlowSourceMetadata</code> API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data. </p>

    Args:
        flow_arn: <p> The Amazon Resource Name (ARN) of the flow.</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.
    """

    def _handler(
        req: "OperationRequest[capo_mediaconnect.types.describe_flow_source_metadata_request.DescribeFlowSourceMetadataRequest]",
    ) -> OperationResponse[
        "capo_mediaconnect.types.describe_flow_source_metadata_response.DescribeFlowSourceMetadataResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.describe_flow_source_metadata

        output, http_response = (
            capo_mediaconnect._operations.media_connect.describe_flow_source_metadata.describe_flow_source_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlowSourceMetadata")
    )
    input_: capo_mediaconnect.types.describe_flow_source_metadata_request.DescribeFlowSourceMetadataRequest = {
        "flow_arn": flow_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output