ChimeSDKMediaPipelines

Client

class ChimeSDKMediaPipelines.Client

A low-level client representing Amazon Chime SDK Media Pipelines

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipleines, see Amazon Chime SDK media pipelines .

client = session.create_client('chime-sdk-media-pipelines')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_media_capture_pipeline(**kwargs)

Creates a media pipeline.

See also: AWS API Documentation

Request Syntax

response = 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'
        },
    ]
)
Parameters
  • SourceType (string) --

    [REQUIRED]

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

  • SourceArn (string) --

    [REQUIRED]

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

  • SinkType (string) --

    [REQUIRED]

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

  • SinkArn (string) --

    [REQUIRED]

    The ARN of the sink type.

  • ClientRequestToken (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.

  • 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) -- [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 .

  • Tags (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.

Return type

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'|'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 .

Exceptions

create_media_concatenation_pipeline(**kwargs)

Creates a media concatenation pipeline.

See also: AWS API Documentation

Request Syntax

response = 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'
        },
    ]
)
Parameters
  • Sources (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.

  • Sinks (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.

  • ClientRequestToken (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.

  • Tags (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.

Return type

dict

Returns

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.

Exceptions

create_media_live_connector_pipeline(**kwargs)

Creates a streaming media pipeline in an Amazon Chime SDK meeting.

See also: AWS API Documentation

Request Syntax

response = 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'
        },
    ]
)
Parameters
  • Sources (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) --
  • Sinks (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.

  • ClientRequestToken (string) --

    The token assigned to the client making the request.

    This field is autopopulated if not provided.

  • Tags (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.

Return type

dict

Returns

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.

Exceptions

delete_media_capture_pipeline(**kwargs)

Deletes the media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.delete_media_capture_pipeline(
    MediaPipelineId='string'
)
Parameters
MediaPipelineId (string) --

[REQUIRED]

The ID of the media pipeline being deleted.

Returns
None

Exceptions

delete_media_pipeline(**kwargs)

Deletes the media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.delete_media_pipeline(
    MediaPipelineId='string'
)
Parameters
MediaPipelineId (string) --

[REQUIRED]

The ID of the media pipeline to delete.

Returns
None

Exceptions

get_media_capture_pipeline(**kwargs)

Gets an existing media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.get_media_capture_pipeline(
    MediaPipelineId='string'
)
Parameters
MediaPipelineId (string) --

[REQUIRED]

The ID of the pipeline that you want to get.

Return type
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'|'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 .

Exceptions

get_media_pipeline(**kwargs)

Gets an existing media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.get_media_pipeline(
    MediaPipelineId='string'
)
Parameters
MediaPipelineId (string) --

[REQUIRED]

The ID of the pipeline that you want to get.

Return type
dict
Returns
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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_media_capture_pipelines(**kwargs)

Returns a list of media pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_media_capture_pipelines(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token used to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call. Valid Range: 1 - 99.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • MediaCapturePipelines (list) --

      The media pipeline objects in the list.

      • (dict) --

        The summary data of a media capture 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.

Exceptions

list_media_pipelines(**kwargs)

Returns a list of media pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_media_pipelines(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token used to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call. Valid Range: 1 - 99.
Return type

dict

Returns

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.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags available for a media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters
ResourceARN (string) --

[REQUIRED]

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      The tags associated with the specified media pipeline.

      • (dict) --

        A key/value pair that grants users access to meeting resources.

        • Key (string) --

          The key half of a tag.

        • Value (string) --

          The value half of a tag.

Exceptions

tag_resource(**kwargs)

The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.

  • Tags (list) --

    [REQUIRED]

    The tags associated with the specified 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

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes any tags from a media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The ARN of the pipeline that you want to untag.

  • TagKeys (list) --

    [REQUIRED]

    The key/value pairs in the tag that you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ChimeSDKMediaPipelines.Client.exceptions.BadRequestException

The input parameters don't match the service's restrictions.

Example

try:
  ...
except client.exceptions.BadRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input parameters don't match the service's restrictions.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException

The client is permanently forbidden from making the request.

Example

try:
  ...
except client.exceptions.ForbiddenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The client is permanently forbidden from making the request.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.NotFoundException

One or more of the resources in the request does not exist in the system.

Example

try:
  ...
except client.exceptions.NotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more of the resources in the request does not exist in the system.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException

The request exceeds the resource limit.

Example

try:
  ...
except client.exceptions.ResourceLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request exceeds the resource limit.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

The service encountered an unexpected error.

Example

try:
  ...
except client.exceptions.ServiceFailureException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service encountered an unexpected error.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException

The service is currently unavailable.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service is currently unavailable.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException

The client exceeded its request rate limit.

Example

try:
  ...
except client.exceptions.ThrottledClientException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The client exceeded its request rate limit.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException

The client is not currently authorized to make the request.

Example

try:
  ...
except client.exceptions.UnauthorizedClientException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Code': 'BadRequest'|'Forbidden'|'NotFound'|'ResourceLimitExceeded'|'ServiceFailure'|'ServiceUnavailable'|'Throttling',
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The client is not currently authorized to make the request.

    • Code (string) --

    • Message (string) --

    • RequestId (string) --

      The request id associated with the call responsible for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: