2022/08/18 - Amazon Chime SDK Media Pipelines - 5 new 2 updated api methods
Changes The Amazon Chime SDK now supports live streaming of real-time video from the Amazon Chime SDK sessions to streaming platforms such as Amazon IVS and Amazon Elemental MediaLive. We have also added support for concatenation to create a single media capture file.
Gets an existing media pipeline.
See also: AWS API Documentation
Request Syntax
client.get_media_pipeline(
MediaPipelineId='string'
)
string
[REQUIRED]
The ID of the pipeline that you want to get.
dict
Response Syntax
{
'MediaPipeline': {
'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'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
}
},
'MediaLiveConnectorPipeline': {
'Sources': [
{
'SourceType': 'ChimeSdkMeeting',
'ChimeSdkMeetingLiveConnectorConfiguration': {
'Arn': 'string',
'MuxType': 'AudioWithCompositedVideo'|'AudioWithActiveSpeakerVideo',
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
},
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
}
}
},
],
'Sinks': [
{
'SinkType': 'RTMP',
'RTMPConfiguration': {
'Url': 'string',
'AudioChannels': 'Stereo'|'Mono',
'AudioSampleRate': 'string'
}
},
],
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
'MediaConcatenationPipeline': {
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string',
'Sources': [
{
'Type': 'MediaCapturePipeline',
'MediaCapturePipelineSourceConfiguration': {
'MediaPipelineArn': 'string',
'ChimeSdkMeetingConfiguration': {
'ArtifactsConfiguration': {
'Audio': {
'State': 'Enabled'
},
'Video': {
'State': 'Enabled'|'Disabled'
},
'Content': {
'State': 'Enabled'|'Disabled'
},
'DataChannel': {
'State': 'Enabled'|'Disabled'
},
'TranscriptionMessages': {
'State': 'Enabled'|'Disabled'
},
'MeetingEvents': {
'State': 'Enabled'|'Disabled'
},
'CompositedVideo': {
'State': 'Enabled'|'Disabled'
}
}
}
}
},
],
'Sinks': [
{
'Type': 'S3Bucket',
'S3BucketSinkConfiguration': {
'Destination': 'string'
}
},
],
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
MediaPipeline (dict) --
The media pipeline object.
MediaCapturePipeline (dict) --
A pipeline that enables users to capture audio and video.
MediaPipelineId (string) --
The ID of a media pipeline.
MediaPipelineArn (string) --
The ARN of the 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 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 pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media pipline.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media 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.
CompositedVideo (dict) --
Enables video compositing.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
MediaLiveConnectorPipeline (dict) --
The connector pipeline of the media pipeline.
Sources (list) --
The connector pipeline's data sources.
(dict) --
The data source configuration object of a streaming media pipeline.
SourceType (string) --
The source configuration's media source type.
ChimeSdkMeetingLiveConnectorConfiguration (dict) --
The configuration settings of the connector pipeline.
Arn (string) --
The configuration object's Chime SDK meeting ARN.
MuxType (string) --
The configuration object's multiplex type.
CompositedVideo (dict) --
The media pipeline's composited video.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
SourceConfiguration (dict) --
The source configuration settings of the media pipeline's configuration object.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media pipeline.
(string) --
Sinks (list) --
The connector pipeline's data sinks.
(dict) --
The media pipeline's sink configuration settings.
SinkType (string) --
The sink configuration's sink type.
RTMPConfiguration (dict) --
The sink configuration's RTMP configuration setttings.
Url (string) --
The URL of the RTMP configuration.
AudioChannels (string) --
The audio channels set for the RTMP configuration
AudioSampleRate (string) --
The audio sample rate set for the RTMP configuration. Default: 48000.
MediaPipelineId (string) --
The connector pipeline's ID.
MediaPipelineArn (string) --
The connector pipeline's ARN.
Status (string) --
The connector pipeline's status.
CreatedTimestamp (datetime) --
Thetime at which the connector pipeline was created.
UpdatedTimestamp (datetime) --
The time at which the connector pipeline was last updated.
MediaConcatenationPipeline (dict) --
The media concatenation pipeline in a media pipeline.
MediaPipelineId (string) --
The ID of the media pipeline being concatenated.
MediaPipelineArn (string) --
The ARN of the media pipeline that you specify in the SourceConfiguration object.
Sources (list) --
The data sources being concatnated.
(dict) --
The source type and media pipeline configuration settings in a configuration object.
Type (string) --
The type of concatenation source in a configuration object.
MediaCapturePipelineSourceConfiguration (dict) --
The concatenation settings for the media pipeline in a configuration object.
MediaPipelineArn (string) --
The media pipeline ARN in the configuration object of a media capture pipeline.
ChimeSdkMeetingConfiguration (dict) --
The meeting configuration settings in a media capture pipeline configuration object.
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.
Audio (dict) --
The configuration for the audio artifacts concatenation.
State (string) --
Enables the name object, where name is the name of the configuration object, such as AudioConcatenation .
Video (dict) --
The configuration for the video artifacts concatenation.
State (string) --
Enables or disables the configuration object.
Content (dict) --
The configuration for the content artifacts concatenation.
State (string) --
Enables or disables the configuration object.
DataChannel (dict) --
The configuration for the data channel artifacts concatenation.
State (string) --
Enables or disables the configuration object.
TranscriptionMessages (dict) --
The configuration for the transcription messages artifacts concatenation.
State (string) --
Enables or disables the configuration object.
MeetingEvents (dict) --
The configuration for the meeting events artifacts concatenation.
State (string) --
Enables or disables the configuration object.
CompositedVideo (dict) --
The configuration for the composited video artifacts concatenation.
State (string) --
Enables or disables the configuration object.
Sinks (list) --
The data sinks of the concatenation pipeline.
(dict) --
The data sink of the configuration object.
Type (string) --
The type of data sink in the configuration object.
S3BucketSinkConfiguration (dict) --
The configuration settings for an Amazon S3 bucket sink.
Destination (string) --
The destination URL of the S3 bucket.
Status (string) --
The status of the concatenation pipeline.
CreatedTimestamp (datetime) --
The time at which the concatenation pipeline was created.
UpdatedTimestamp (datetime) --
The time at which the concatenation pipeline was last updated.
Creates a media concatenation pipeline.
See also: AWS API Documentation
Request Syntax
client.create_media_concatenation_pipeline(
Sources=[
{
'Type': 'MediaCapturePipeline',
'MediaCapturePipelineSourceConfiguration': {
'MediaPipelineArn': 'string',
'ChimeSdkMeetingConfiguration': {
'ArtifactsConfiguration': {
'Audio': {
'State': 'Enabled'
},
'Video': {
'State': 'Enabled'|'Disabled'
},
'Content': {
'State': 'Enabled'|'Disabled'
},
'DataChannel': {
'State': 'Enabled'|'Disabled'
},
'TranscriptionMessages': {
'State': 'Enabled'|'Disabled'
},
'MeetingEvents': {
'State': 'Enabled'|'Disabled'
},
'CompositedVideo': {
'State': 'Enabled'|'Disabled'
}
}
}
}
},
],
Sinks=[
{
'Type': 'S3Bucket',
'S3BucketSinkConfiguration': {
'Destination': 'string'
}
},
],
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
list
[REQUIRED]
An object that specifies the sources for the media concatenation pipeline.
(dict) --
The source type and media pipeline configuration settings in a configuration object.
Type (string) -- [REQUIRED]
The type of concatenation source in a configuration object.
MediaCapturePipelineSourceConfiguration (dict) -- [REQUIRED]
The concatenation settings for the media pipeline in a configuration object.
MediaPipelineArn (string) -- [REQUIRED]
The media pipeline ARN in the configuration object of a media capture pipeline.
ChimeSdkMeetingConfiguration (dict) -- [REQUIRED]
The meeting configuration settings in a media capture pipeline configuration object.
ArtifactsConfiguration (dict) -- [REQUIRED]
The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.
Audio (dict) -- [REQUIRED]
The configuration for the audio artifacts concatenation.
State (string) -- [REQUIRED]
Enables the name object, where name is the name of the configuration object, such as AudioConcatenation .
Video (dict) -- [REQUIRED]
The configuration for the video artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
Content (dict) -- [REQUIRED]
The configuration for the content artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
DataChannel (dict) -- [REQUIRED]
The configuration for the data channel artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
TranscriptionMessages (dict) -- [REQUIRED]
The configuration for the transcription messages artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
MeetingEvents (dict) -- [REQUIRED]
The configuration for the meeting events artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
CompositedVideo (dict) -- [REQUIRED]
The configuration for the composited video artifacts concatenation.
State (string) -- [REQUIRED]
Enables or disables the configuration object.
list
[REQUIRED]
An object that specifies the data sinks for the media concatenation pipeline.
(dict) --
The data sink of the configuration object.
Type (string) -- [REQUIRED]
The type of data sink in the configuration object.
S3BucketSinkConfiguration (dict) -- [REQUIRED]
The configuration settings for an Amazon S3 bucket sink.
Destination (string) -- [REQUIRED]
The destination URL of the S3 bucket.
string
The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.
This field is autopopulated if not provided.
list
The tags associated with the media concatenation 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.
dict
Response Syntax
{
'MediaConcatenationPipeline': {
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string',
'Sources': [
{
'Type': 'MediaCapturePipeline',
'MediaCapturePipelineSourceConfiguration': {
'MediaPipelineArn': 'string',
'ChimeSdkMeetingConfiguration': {
'ArtifactsConfiguration': {
'Audio': {
'State': 'Enabled'
},
'Video': {
'State': 'Enabled'|'Disabled'
},
'Content': {
'State': 'Enabled'|'Disabled'
},
'DataChannel': {
'State': 'Enabled'|'Disabled'
},
'TranscriptionMessages': {
'State': 'Enabled'|'Disabled'
},
'MeetingEvents': {
'State': 'Enabled'|'Disabled'
},
'CompositedVideo': {
'State': 'Enabled'|'Disabled'
}
}
}
}
},
],
'Sinks': [
{
'Type': 'S3Bucket',
'S3BucketSinkConfiguration': {
'Destination': 'string'
}
},
],
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
MediaConcatenationPipeline (dict) --
A media concatenation pipeline object, the ID, source type, MediaPipelineARN , and sink of a media concatenation pipeline object.
MediaPipelineId (string) --
The ID of the media pipeline being concatenated.
MediaPipelineArn (string) --
The ARN of the media pipeline that you specify in the SourceConfiguration object.
Sources (list) --
The data sources being concatnated.
(dict) --
The source type and media pipeline configuration settings in a configuration object.
Type (string) --
The type of concatenation source in a configuration object.
MediaCapturePipelineSourceConfiguration (dict) --
The concatenation settings for the media pipeline in a configuration object.
MediaPipelineArn (string) --
The media pipeline ARN in the configuration object of a media capture pipeline.
ChimeSdkMeetingConfiguration (dict) --
The meeting configuration settings in a media capture pipeline configuration object.
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.
Audio (dict) --
The configuration for the audio artifacts concatenation.
State (string) --
Enables the name object, where name is the name of the configuration object, such as AudioConcatenation .
Video (dict) --
The configuration for the video artifacts concatenation.
State (string) --
Enables or disables the configuration object.
Content (dict) --
The configuration for the content artifacts concatenation.
State (string) --
Enables or disables the configuration object.
DataChannel (dict) --
The configuration for the data channel artifacts concatenation.
State (string) --
Enables or disables the configuration object.
TranscriptionMessages (dict) --
The configuration for the transcription messages artifacts concatenation.
State (string) --
Enables or disables the configuration object.
MeetingEvents (dict) --
The configuration for the meeting events artifacts concatenation.
State (string) --
Enables or disables the configuration object.
CompositedVideo (dict) --
The configuration for the composited video artifacts concatenation.
State (string) --
Enables or disables the configuration object.
Sinks (list) --
The data sinks of the concatenation pipeline.
(dict) --
The data sink of the configuration object.
Type (string) --
The type of data sink in the configuration object.
S3BucketSinkConfiguration (dict) --
The configuration settings for an Amazon S3 bucket sink.
Destination (string) --
The destination URL of the S3 bucket.
Status (string) --
The status of the concatenation pipeline.
CreatedTimestamp (datetime) --
The time at which the concatenation pipeline was created.
UpdatedTimestamp (datetime) --
The time at which the concatenation pipeline was last updated.
Creates a streaming media pipeline in an Amazon Chime SDK meeting.
See also: AWS API Documentation
Request Syntax
client.create_media_live_connector_pipeline(
Sources=[
{
'SourceType': 'ChimeSdkMeeting',
'ChimeSdkMeetingLiveConnectorConfiguration': {
'Arn': 'string',
'MuxType': 'AudioWithCompositedVideo'|'AudioWithActiveSpeakerVideo',
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
},
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
}
}
},
],
Sinks=[
{
'SinkType': 'RTMP',
'RTMPConfiguration': {
'Url': 'string',
'AudioChannels': 'Stereo'|'Mono',
'AudioSampleRate': 'string'
}
},
],
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
list
[REQUIRED]
The media pipeline's data sources.
(dict) --
The data source configuration object of a streaming media pipeline.
SourceType (string) -- [REQUIRED]
The source configuration's media source type.
ChimeSdkMeetingLiveConnectorConfiguration (dict) -- [REQUIRED]
The configuration settings of the connector pipeline.
Arn (string) -- [REQUIRED]
The configuration object's Chime SDK meeting ARN.
MuxType (string) -- [REQUIRED]
The configuration object's multiplex type.
CompositedVideo (dict) --
The media pipeline's composited video.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) -- [REQUIRED]
The GridView configuration setting.
ContentShareLayout (string) -- [REQUIRED]
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
SourceConfiguration (dict) --
The source configuration settings of the media pipeline's configuration object.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media pipeline.
(string) --
list
[REQUIRED]
The media pipeline's data sinks.
(dict) --
The media pipeline's sink configuration settings.
SinkType (string) -- [REQUIRED]
The sink configuration's sink type.
RTMPConfiguration (dict) -- [REQUIRED]
The sink configuration's RTMP configuration setttings.
Url (string) -- [REQUIRED]
The URL of the RTMP configuration.
AudioChannels (string) --
The audio channels set for the RTMP configuration
AudioSampleRate (string) --
The audio sample rate set for the RTMP configuration. Default: 48000.
string
The token assigned to the client making the request.
This field is autopopulated if not provided.
list
The tags associated with 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.
dict
Response Syntax
{
'MediaLiveConnectorPipeline': {
'Sources': [
{
'SourceType': 'ChimeSdkMeeting',
'ChimeSdkMeetingLiveConnectorConfiguration': {
'Arn': 'string',
'MuxType': 'AudioWithCompositedVideo'|'AudioWithActiveSpeakerVideo',
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
},
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
}
}
},
],
'Sinks': [
{
'SinkType': 'RTMP',
'RTMPConfiguration': {
'Url': 'string',
'AudioChannels': 'Stereo'|'Mono',
'AudioSampleRate': 'string'
}
},
],
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
MediaLiveConnectorPipeline (dict) --
The new media pipeline.
Sources (list) --
The connector pipeline's data sources.
(dict) --
The data source configuration object of a streaming media pipeline.
SourceType (string) --
The source configuration's media source type.
ChimeSdkMeetingLiveConnectorConfiguration (dict) --
The configuration settings of the connector pipeline.
Arn (string) --
The configuration object's Chime SDK meeting ARN.
MuxType (string) --
The configuration object's multiplex type.
CompositedVideo (dict) --
The media pipeline's composited video.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
SourceConfiguration (dict) --
The source configuration settings of the media pipeline's configuration object.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media pipeline.
(string) --
Sinks (list) --
The connector pipeline's data sinks.
(dict) --
The media pipeline's sink configuration settings.
SinkType (string) --
The sink configuration's sink type.
RTMPConfiguration (dict) --
The sink configuration's RTMP configuration setttings.
Url (string) --
The URL of the RTMP configuration.
AudioChannels (string) --
The audio channels set for the RTMP configuration
AudioSampleRate (string) --
The audio sample rate set for the RTMP configuration. Default: 48000.
MediaPipelineId (string) --
The connector pipeline's ID.
MediaPipelineArn (string) --
The connector pipeline's ARN.
Status (string) --
The connector pipeline's status.
CreatedTimestamp (datetime) --
Thetime at which the connector pipeline was created.
UpdatedTimestamp (datetime) --
The time at which the connector pipeline was last updated.
Returns a list of media pipelines.
See also: AWS API Documentation
Request Syntax
client.list_media_pipelines(
NextToken='string',
MaxResults=123
)
string
The token used to retrieve the next page of results.
integer
The maximum number of results to return in a single call. Valid Range: 1 - 99.
dict
Response Syntax
{
'MediaPipelines': [
{
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MediaPipelines (list) --
The media pipeline objects in the list.
(dict) --
The summary of the media pipeline.
MediaPipelineId (string) --
The ID of the media pipeline in the summary.
MediaPipelineArn (string) --
The ARN of the media pipeline in the summary.
NextToken (string) --
The token used to retrieve the next page of results.
Deletes the media pipeline.
See also: AWS API Documentation
Request Syntax
client.delete_media_pipeline(
MediaPipelineId='string'
)
string
[REQUIRED]
The ID of the media pipeline to delete.
None
{'ChimeSdkMeetingConfiguration': {'ArtifactsConfiguration': {'Audio': {'MuxType': {'AudioWithCompositedVideo'}},
'CompositedVideo': {'GridViewConfiguration': {'ContentShareLayout': 'PresenterOnly '
'| '
'Horizontal '
'| '
'Vertical',
'PresenterOnlyConfiguration': {'PresenterPosition': 'TopLeft '
'| '
'TopRight '
'| '
'BottomLeft '
'| '
'BottomRight'}},
'Layout': 'GridView',
'Resolution': 'HD '
'| '
'FHD'}}}}
Response {'MediaCapturePipeline': {'ChimeSdkMeetingConfiguration': {'ArtifactsConfiguration': {'Audio': {'MuxType': {'AudioWithCompositedVideo'}},
'CompositedVideo': {'GridViewConfiguration': {'ContentShareLayout': 'PresenterOnly '
'| '
'Horizontal '
'| '
'Vertical',
'PresenterOnlyConfiguration': {'PresenterPosition': 'TopLeft '
'| '
'TopRight '
'| '
'BottomLeft '
'| '
'BottomRight'}},
'Layout': 'GridView',
'Resolution': 'HD '
'| '
'FHD'}}}}}
Creates a media 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'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
string
[REQUIRED]
ARN of the source from which the media artifacts are captured.
string
[REQUIRED]
Destination type to which the media artifacts are saved. You must use an S3 bucket.
string
[REQUIRED]
The ARN of the sink type.
string
The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
This field is autopopulated if not provided.
dict
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media pipline.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media 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.
CompositedVideo (dict) --
Enables video compositing.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) -- [REQUIRED]
The GridView configuration setting.
ContentShareLayout (string) -- [REQUIRED]
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
list
The tag key-value pairs.
(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.
dict
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'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.
MediaPipelineId (string) --
The ID of a media pipeline.
MediaPipelineArn (string) --
The ARN of the 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 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 pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media pipline.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media 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.
CompositedVideo (dict) --
Enables video compositing.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
{'MediaCapturePipeline': {'ChimeSdkMeetingConfiguration': {'ArtifactsConfiguration': {'Audio': {'MuxType': {'AudioWithCompositedVideo'}},
'CompositedVideo': {'GridViewConfiguration': {'ContentShareLayout': 'PresenterOnly '
'| '
'Horizontal '
'| '
'Vertical',
'PresenterOnlyConfiguration': {'PresenterPosition': 'TopLeft '
'| '
'TopRight '
'| '
'BottomLeft '
'| '
'BottomRight'}},
'Layout': 'GridView',
'Resolution': 'HD '
'| '
'FHD'}}}}}
Gets an existing media pipeline.
See also: AWS API Documentation
Request Syntax
client.get_media_capture_pipeline(
MediaPipelineId='string'
)
string
[REQUIRED]
The ID of the pipeline that you want to get.
dict
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'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
The media pipeline object.
MediaPipelineId (string) --
The ID of a media pipeline.
MediaPipelineArn (string) --
The ARN of the 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 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 pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media pipline.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media 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.
CompositedVideo (dict) --
Enables video compositing.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .