MediaConnect / Client / describe_flow_source_metadata

describe_flow_source_metadata#

MediaConnect.Client.describe_flow_source_metadata(**kwargs)#

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.

Request Syntax

response = client.describe_flow_source_metadata(
    FlowArn='string'
)

Parameters:

FlowArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'FlowArn': 'string',
    'Messages': [
        {
            'Code': 'string',
            'Message': 'string',
            'ResourceName': 'string'
        },
    ],
    'Timestamp': datetime(2015, 1, 1),
    'TransportMediaInfo': {
        'Programs': [
            {
                'PcrPid': 123,
                'ProgramName': 'string',
                'ProgramNumber': 123,
                'ProgramPid': 123,
                'Streams': [
                    {
                        'Channels': 123,
                        'Codec': 'string',
                        'FrameRate': 'string',
                        'FrameResolution': {
                            'FrameHeight': 123,
                            'FrameWidth': 123
                        },
                        'Pid': 123,
                        'SampleRate': 123,
                        'SampleSize': 123,
                        'StreamType': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) –
- FlowArn (string) –
  
  The ARN of the flow that DescribeFlowSourceMetadata was performed on.
- Messages (list) –
  
  Provides a status code and message regarding issues found with the flow source metadata.
  - (dict) –
    
    The details of an error message.
    - Code (string) –
      
      The error code.
    - Message (string) –
      
      The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
    - ResourceName (string) –
      
      The name of the resource.
- Timestamp (datetime) –
  
  The timestamp of the most recent change in metadata for this flow’s source.
- TransportMediaInfo (dict) –
  
  Information about the flow’s transport media.
  - Programs (list) –
    
    The list of transport stream programs in the current flow’s source.
    - (dict) –
      
      The metadata of a single transport stream program.
      - PcrPid (integer) –
        
        The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.
      - ProgramName (string) –
        
        The program name as it is reported in the Program Association Table.
      - ProgramNumber (integer) –
        
        The program number as it is reported in the Program Association Table.
      - ProgramPid (integer) –
        
        The program Packet ID (PID) as it is reported in the Program Association Table.
      - Streams (list) –
        
        The list of elementary transport streams in the program. The list includes video, audio, and data streams.
        
        (dict) –
        
        The metadata of an elementary transport stream.
        
        Channels (integer) –
        
        The number of channels in the audio stream.
        
        Codec (string) –
        
        The codec used by the stream.
        
        FrameRate (string) –
        
        The frame rate used by the video stream.
        
        FrameResolution (dict) –
        
        The frame resolution used by the video stream.
        
        FrameHeight (integer) –
        
        The number of pixels in the height of the video frame.
        
        FrameWidth (integer) –
        
        The number of pixels in the width of the video frame.
        
        Pid (integer) –
        
        The Packet ID (PID) as it is reported in the Program Map Table.
        
        SampleRate (integer) –
        
        The sample rate used by the audio stream.
        
        SampleSize (integer) –
        
        The sample bit size used by the audio stream.
        
        StreamType (string) –
        
        The Stream Type as it is reported in the Program Map Table.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ForbiddenException
MediaConnect.Client.exceptions.NotFoundException
MediaConnect.Client.exceptions.ServiceUnavailableException