Chime / Client / create_media_capture_pipeline

create_media_capture_pipeline#

Chime.Client.create_media_capture_pipeline(**kwargs)#

Creates a media capture 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'
            },
            'Video': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'VideoOnly'
            },
            'Content': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'ContentOnly'
            }
        }
    }
)
Parameters:
  • SourceType (string) –

    [REQUIRED]

    Source type from which the media artifacts will be 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 different token for different media pipeline requests.

    This field is autopopulated if not provided.

  • ChimeSdkMeetingConfiguration (dict) –

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

    • SourceConfiguration (dict) –

      The source configuration for a specified media capture pipeline.

      • SelectedVideoStreams (dict) –

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

        • AttendeeIds (list) –

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

          • (string) –

        • ExternalUserIds (list) –

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

          • (string) –

    • ArtifactsConfiguration (dict) –

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

      • Audio (dict) – [REQUIRED]

        The configuration for the audio artifacts.

        • MuxType (string) – [REQUIRED]

          The MUX type of the audio artifact configuration object.

      • Video (dict) – [REQUIRED]

        The configuration for the video artifacts.

        • State (string) – [REQUIRED]

          Indicates whether the video artifact is enabled or disabled.

        • MuxType (string) –

          The MUX type of the video artifact configuration object.

      • Content (dict) – [REQUIRED]

        The configuration for the content artifacts.

        • State (string) – [REQUIRED]

          Indicates whether the content artifact is enabled or disabled.

        • MuxType (string) –

          The MUX type of the artifact configuration.

Return type:

dict

Returns:

Response Syntax

{
    'MediaCapturePipeline': {
        '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'
                }
            }
        }
    }
}

Response Structure

  • (dict) –

    • MediaCapturePipeline (dict) –

      A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.

      • MediaPipelineId (string) –

        The ID of a media capture pipeline.

      • 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 pipeline.

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

Exceptions

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException