ChimeSDKMediaPipelines / Client / create_media_concatenation_pipeline

create_media_concatenation_pipeline#

ChimeSDKMediaPipelines.Client.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 or disables the configuration object.

            • 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'|'Paused'|'NotStarted',
        '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 concatenated.

        • (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 or disables the configuration object.

                • 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