AWS API Changes

2022/04/27 - Amazon Chime SDK Media Pipelines - 7 new api methods

Changes For Amazon Chime SDK meetings, the Amazon Chime Media Pipelines SDK allows builders to capture audio, video, and content share streams. You can also capture meeting events, live transcripts, and data messages. The pipelines save the artifacts to an Amazon S3 bucket that you designate.

GetMediaCapturePipeline (new)

Link ¶

Gets an existing media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.get_media_capture_pipeline(
    MediaPipelineId='string'
)

type MediaPipelineId:

string

param MediaPipelineId:

[REQUIRED]

The ID of the pipeline that you want to get.

rtype:

dict

returns:

Response Syntax

{
    'MediaCapturePipeline': {
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'SourceType': 'ChimeSdkMeeting',
        'SourceArn': 'string',
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'SinkType': 'S3Bucket',
        'SinkArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ChimeSdkMeetingConfiguration': {
            'SourceConfiguration': {
                'SelectedVideoStreams': {
                    'AttendeeIds': [
                        'string',
                    ],
                    'ExternalUserIds': [
                        'string',
                    ]
                }
            },
            'ArtifactsConfiguration': {
                'Audio': {
                    'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
                },
                'Video': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'VideoOnly'
                },
                'Content': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'ContentOnly'
                }
            }
        }
    }
}

Response Structure

(dict) --
- MediaCapturePipeline (dict) --
  
  The media capture pipeline object.
  - MediaPipelineId (string) --
    
    The ID of a media capture pipeline.
  - MediaPipelineArn (string) --
    
    The ARN of a media capture pipeline.
  - SourceType (string) --
    
    Source type from which media artifacts are saved. You must use ChimeMeeting.
  - SourceArn (string) --
    
    ARN of the source from which the media artifacts are saved.
  - Status (string) --
    
    The status of the media capture pipeline.
  - SinkType (string) --
    
    Destination type to which the media artifacts are saved. You must use an S3 Bucket.
  - SinkArn (string) --
    
    ARN of the destination to which the media artifacts are saved.
  - CreatedTimestamp (datetime) --
    
    The time at which the capture pipeline was created, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the capture pipeline was updated, in ISO 8601 format.
  - ChimeSdkMeetingConfiguration (dict) --
    
    The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
    - SourceConfiguration (dict) --
      
      The source configuration for a specified media capture pipline.
      - SelectedVideoStreams (dict) --
        
        The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
        
        AttendeeIds (list) --
        
        The attendee IDs of the streams selected for a media capture pipeline.
        
        (string) --
        
        ExternalUserIds (list) --
        
        The external user IDs of the streams selected for a media capture pipeline.
        
        (string) --
    - ArtifactsConfiguration (dict) --
      
      The configuration for the artifacts in an Amazon Chime SDK meeting.
      - Audio (dict) --
        
        The configuration for the audio artifacts.
        
        MuxType (string) --
        
        The MUX type of the audio artifact configuration object.
      - Video (dict) --
        
        The configuration for the video artifacts.
        
        State (string) --
        
        Indicates whether the video artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the video artifact configuration object.
      - Content (dict) --
        
        The configuration for the content artifacts.
        
        State (string) --
        
        Indicates whether the content artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the artifact configuration.

ListMediaCapturePipelines (new)

Link ¶

Returns a list of media capture pipelines.

See also: AWS API Documentation

Request Syntax

client.list_media_capture_pipelines(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

The token used to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call. Valid Range: 1 - 99.

rtype:

dict

returns:

Response Syntax

{
    'MediaCapturePipelines': [
        {
            'MediaPipelineId': 'string',
            'MediaPipelineArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- MediaCapturePipelines (list) --
  
  The media capture pipeline objects in the list.
  - (dict) --
    
    A summary of a media capture pipeline.
    - MediaPipelineId (string) --
      
      The ID of a media capture pipeline.
    - MediaPipelineArn (string) --
      
      The ARN of a media capture pipeline.
- NextToken (string) --
  
  The token used to retrieve the next page of results.

TagResource (new)

Link ¶

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type Tags:

list

param Tags:

[REQUIRED]

The tag key-value pairs.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteMediaCapturePipeline (new)

Link ¶

Deletes the media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.delete_media_capture_pipeline(
    MediaPipelineId='string'
)

type MediaPipelineId:

string

param MediaPipelineId:

[REQUIRED]

The ID of the media capture pipeline being deleted.

returns:

None

CreateMediaCapturePipeline (new)

Link ¶

Creates a media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.create_media_capture_pipeline(
    SourceType='ChimeSdkMeeting',
    SourceArn='string',
    SinkType='S3Bucket',
    SinkArn='string',
    ClientRequestToken='string',
    ChimeSdkMeetingConfiguration={
        'SourceConfiguration': {
            'SelectedVideoStreams': {
                'AttendeeIds': [
                    'string',
                ],
                'ExternalUserIds': [
                    'string',
                ]
            }
        },
        'ArtifactsConfiguration': {
            'Audio': {
                'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
            },
            'Video': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'VideoOnly'
            },
            'Content': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'ContentOnly'
            }
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type SourceType:

string

param SourceType:

[REQUIRED]

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

type SourceArn:

string

param SourceArn:

[REQUIRED]

ARN of the source from which the media artifacts are captured.

type SinkType:

string

param SinkType:

[REQUIRED]

Destination type to which the media artifacts are saved. You must use an S3 bucket.

type SinkArn:

string

param SinkArn:

[REQUIRED]

The ARN of the sink type.

type ClientRequestToken:

string

param ClientRequestToken:

The token assigned to the client making the pipeline request.

This field is autopopulated if not provided.

type ChimeSdkMeetingConfiguration:

dict

param ChimeSdkMeetingConfiguration:

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

SourceConfiguration (dict) --

The source configuration for a specified media capture pipline.
- SelectedVideoStreams (dict) --
  
  The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
  - AttendeeIds (list) --
    
    The attendee IDs of the streams selected for a media capture pipeline.
    - (string) --
  - ExternalUserIds (list) --
    
    The external user IDs of the streams selected for a media capture pipeline.
    - (string) --
ArtifactsConfiguration (dict) --

The configuration for the artifacts in an Amazon Chime SDK meeting.
- Audio (dict) -- [REQUIRED]
  
  The configuration for the audio artifacts.
  - MuxType (string) -- [REQUIRED]
    
    The MUX type of the audio artifact configuration object.
- Video (dict) -- [REQUIRED]
  
  The configuration for the video artifacts.
  - State (string) -- [REQUIRED]
    
    Indicates whether the video artifact is enabled or disabled.
  - MuxType (string) --
    
    The MUX type of the video artifact configuration object.
- Content (dict) -- [REQUIRED]
  
  The configuration for the content artifacts.
  - State (string) -- [REQUIRED]
    
    Indicates whether the content artifact is enabled or disabled.
  - MuxType (string) --
    
    The MUX type of the artifact configuration.

type Tags:

list

param Tags:

The list of tags.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

rtype:

dict

returns:

Response Syntax

{
    'MediaCapturePipeline': {
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'SourceType': 'ChimeSdkMeeting',
        'SourceArn': 'string',
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'SinkType': 'S3Bucket',
        'SinkArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ChimeSdkMeetingConfiguration': {
            'SourceConfiguration': {
                'SelectedVideoStreams': {
                    'AttendeeIds': [
                        'string',
                    ],
                    'ExternalUserIds': [
                        'string',
                    ]
                }
            },
            'ArtifactsConfiguration': {
                'Audio': {
                    'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
                },
                'Video': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'VideoOnly'
                },
                'Content': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'ContentOnly'
                }
            }
        }
    }
}

Response Structure

(dict) --
- MediaCapturePipeline (dict) --
  
  A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
  - MediaPipelineId (string) --
    
    The ID of a media capture pipeline.
  - MediaPipelineArn (string) --
    
    The ARN of a media capture pipeline.
  - SourceType (string) --
    
    Source type from which media artifacts are saved. You must use ChimeMeeting.
  - SourceArn (string) --
    
    ARN of the source from which the media artifacts are saved.
  - Status (string) --
    
    The status of the media capture pipeline.
  - SinkType (string) --
    
    Destination type to which the media artifacts are saved. You must use an S3 Bucket.
  - SinkArn (string) --
    
    ARN of the destination to which the media artifacts are saved.
  - CreatedTimestamp (datetime) --
    
    The time at which the capture pipeline was created, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the capture pipeline was updated, in ISO 8601 format.
  - ChimeSdkMeetingConfiguration (dict) --
    
    The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
    - SourceConfiguration (dict) --
      
      The source configuration for a specified media capture pipline.
      - SelectedVideoStreams (dict) --
        
        The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
        
        AttendeeIds (list) --
        
        The attendee IDs of the streams selected for a media capture pipeline.
        
        (string) --
        
        ExternalUserIds (list) --
        
        The external user IDs of the streams selected for a media capture pipeline.
        
        (string) --
    - ArtifactsConfiguration (dict) --
      
      The configuration for the artifacts in an Amazon Chime SDK meeting.
      - Audio (dict) --
        
        The configuration for the audio artifacts.
        
        MuxType (string) --
        
        The MUX type of the audio artifact configuration object.
      - Video (dict) --
        
        The configuration for the video artifacts.
        
        State (string) --
        
        Indicates whether the video artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the video artifact configuration object.
      - Content (dict) --
        
        The configuration for the content artifacts.
        
        State (string) --
        
        Indicates whether the content artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the artifact configuration.

UntagResource (new)

Link ¶

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The tag keys.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListTagsForResource (new)

Link ¶

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

rtype:

dict

returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  
  The tag key-value pairs.
  - (dict) --
    
    Describes a tag applied to a resource.
    - Key (string) --
      
      The key of the tag.
    - Value (string) --
      
      The value of the tag.