Chime / Client / list_media_capture_pipelines

list_media_capture_pipelines#

Chime.Client.list_media_capture_pipelines(**kwargs)#

Returns a list of media capture 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',
            'SourceType': 'ChimeSdkMeeting',
            'SourceArn': 'string',
            'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
            'SinkType': 'S3Bucket',
            'SinkArn': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'ChimeSdkMeetingConfiguration': {
                'SourceConfiguration': {
                    'SelectedVideoStreams': {
                        'AttendeeIds': [
                            'string',
                        ],
                        'ExternalUserIds': [
                            'string',
                        ]
                    }
                },
                'ArtifactsConfiguration': {
                    'Audio': {
                        'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
                    },
                    'Video': {
                        'State': 'Enabled'|'Disabled',
                        'MuxType': 'VideoOnly'
                    },
                    'Content': {
                        'State': 'Enabled'|'Disabled',
                        'MuxType': 'ContentOnly'
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • MediaCapturePipelines (list) –

      The media capture pipeline objects in the list.

      • (dict) –

        A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

        • MediaPipelineId (string) –

          The ID of a media capture pipeline.

        • SourceType (string) –

          Source type from which media artifacts are saved. You must use ChimeMeeting.

        • SourceArn (string) –

          ARN of the source from which the media artifacts will be saved.

        • Status (string) –

          The status of the media capture pipeline.

        • SinkType (string) –

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

        • SinkArn (string) –

          ARN of the destination to which the media artifacts are saved.

        • CreatedTimestamp (datetime) –

          The time at which the capture pipeline was created, in ISO 8601 format.

        • UpdatedTimestamp (datetime) –

          The time at which the capture pipeline was updated, in ISO 8601 format.

        • ChimeSdkMeetingConfiguration (dict) –

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

          • SourceConfiguration (dict) –

            The source configuration for a specified media capture pipline.

            • SelectedVideoStreams (dict) –

              The selected video streams to capture for a specified media capture pipeline. The number of video streams can’t exceed 25.

              • AttendeeIds (list) –

                The attendee IDs of the streams selected for a media capture pipeline.

                • (string) –

              • ExternalUserIds (list) –

                The external user IDs of the streams selected for a media capture pipeline.

                • (string) –

          • ArtifactsConfiguration (dict) –

            The configuration for the artifacts in an Amazon Chime SDK meeting.

            • Audio (dict) –

              The configuration for the audio artifacts.

              • MuxType (string) –

                The MUX type of the audio artifact configuration object.

            • Video (dict) –

              The configuration for the video artifacts.

              • State (string) –

                Indicates whether the video artifact is enabled or disabled.

              • MuxType (string) –

                The MUX type of the video artifact configuration object.

            • Content (dict) –

              The configuration for the content artifacts.

              • State (string) –

                Indicates whether the content artifact is enabled or disabled.

              • MuxType (string) –

                The MUX type of the artifact configuration.

    • NextToken (string) –

      The token used to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException