Amazon Chime

Returns a list of media capture pipelines.

See also: AWS API Documentation

Request Syntax

client.list_media_capture_pipelines(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token used to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Valid Range: 1 - 99.

rtype

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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • MediaCapturePipelines (list) --

    The media capture pipeline objects in the list.

    • (dict) --

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

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

  • NextToken (string) --

    The token used to retrieve the next page of results.

Creates a media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.create_media_capture_pipeline(
    SourceType='ChimeSdkMeeting',
    SourceArn='string',
    SinkType='S3Bucket',
    SinkArn='string',
    ClientRequestToken='string'
)

type SourceType

string

param SourceType

[REQUIRED]

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

type SourceArn

string

param SourceArn

[REQUIRED]

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

type SinkType

string

param SinkType

[REQUIRED]

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

type SinkArn

string

param SinkArn

[REQUIRED]

The ARN of the sink type.

type ClientRequestToken

string

param ClientRequestToken

The token assigned to the client making the pipeline request.

This field is autopopulated if not provided.

rtype

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)
    }
}

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.

Gets an existing media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.get_media_capture_pipeline(
    MediaPipelineId='string'
)

type MediaPipelineId

string

param MediaPipelineId

[REQUIRED]

The ID of the pipeline that you want to get.

rtype

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)
    }
}

Response Structure

• (dict) --

  • MediaCapturePipeline (dict) --

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

Deletes the media capture pipeline.

See also: AWS API Documentation

Request Syntax

client.delete_media_capture_pipeline(
    MediaPipelineId='string'
)

type MediaPipelineId

string

param MediaPipelineId

[REQUIRED]

The ID of the media capture pipeline being deleted.

returns

None