ChimeSDKMediaPipelines / Client / create_media_stream_pipeline

create_media_stream_pipeline#

ChimeSDKMediaPipelines.Client.create_media_stream_pipeline(**kwargs)#

Creates a streaming media pipeline.

Request Syntax

response = client.create_media_stream_pipeline(
    Sources=[
        {
            'SourceType': 'ChimeSdkMeeting',
            'SourceArn': 'string'
        },
    ],
    Sinks=[
        {
            'SinkArn': 'string',
            'SinkType': 'KinesisVideoStreamPool',
            'ReservedStreamCapacity': 123,
            'MediaStreamType': 'MixedAudio'|'IndividualAudio'
        },
    ],
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Sources (list) –
[REQUIRED]

The data sources for the media pipeline.
- (dict) –
  
  Structure that contains the settings for media stream sources.
  - SourceType (string) – [REQUIRED]
    
    The type of media stream source.
  - SourceArn (string) – [REQUIRED]
    
    The ARN of the meeting.
Sinks (list) –
[REQUIRED]

The data sink for the media pipeline.
- (dict) –
  
  Structure that contains the settings for a media stream sink.
  - SinkArn (string) – [REQUIRED]
    
    The ARN of the Kinesis Video Stream pool returned by the CreateMediaPipelineKinesisVideoStreamPool API.
  - SinkType (string) – [REQUIRED]
    
    The media stream sink’s type.
  - ReservedStreamCapacity (integer) – [REQUIRED]
    
    Specifies the number of streams that the sink can accept.
  - MediaStreamType (string) – [REQUIRED]
    
    The media stream sink’s media stream type.
ClientRequestToken (string) –
The token assigned to the client making the request.

This field is autopopulated if not provided.
Tags (list) –
The tags assigned to the media pipeline.
- (dict) –
  
  A key/value pair that grants users access to meeting resources.
  - Key (string) – [REQUIRED]
    
    The key half of a tag.
  - Value (string) – [REQUIRED]
    
    The value half of a tag.

Return type:

dict

Returns:

Response Syntax

{
    'MediaStreamPipeline': {
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped'|'Paused'|'NotStarted',
        'Sources': [
            {
                'SourceType': 'ChimeSdkMeeting',
                'SourceArn': 'string'
            },
        ],
        'Sinks': [
            {
                'SinkArn': 'string',
                'SinkType': 'KinesisVideoStreamPool',
                'ReservedStreamCapacity': 123,
                'MediaStreamType': 'MixedAudio'|'IndividualAudio'
            },
        ]
    }
}

Response Structure

(dict) –
- MediaStreamPipeline (dict) –
  
  The requested media pipeline.
  - MediaPipelineId (string) –
    
    The ID of the media stream pipeline
  - MediaPipelineArn (string) –
    
    The ARN of the media stream pipeline.
  - CreatedTimestamp (datetime) –
    
    The time at which the media stream pipeline was created.
  - UpdatedTimestamp (datetime) –
    
    The time at which the media stream pipeline was updated.
  - Status (string) –
    
    The status of the media stream pipeline.
  - Sources (list) –
    
    The media stream pipeline’s data sources.
    - (dict) –
      
      Structure that contains the settings for media stream sources.
      - SourceType (string) –
        
        The type of media stream source.
      - SourceArn (string) –
        
        The ARN of the meeting.
  - Sinks (list) –
    
    The media stream pipeline’s data sinks.
    - (dict) –
      
      Structure that contains the settings for a media stream sink.
      - SinkArn (string) –
        
        The ARN of the Kinesis Video Stream pool returned by the CreateMediaPipelineKinesisVideoStreamPool API.
      - SinkType (string) –
        
        The media stream sink’s type.
      - ReservedStreamCapacity (integer) –
        
        Specifies the number of streams that the sink can accept.
      - MediaStreamType (string) –
        
        The media stream sink’s media stream type.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException