MediaCapturePipeline - Amazon Chime SDK

MediaCapturePipeline

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

Contents

ChimeSdkMeetingConfiguration

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

Type: ChimeSdkMeetingConfiguration object

Required: No

CreatedTimestamp

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

Type: Timestamp

Required: No

MediaPipelineArn

The ARN of the media capture pipeline

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

MediaPipelineId

The ID of a media pipeline.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

SinkArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

SinkIamRoleArn

The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

SinkType

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

Type: String

Valid Values: S3Bucket

Required: No

SourceArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

SourceType

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

Type: String

Valid Values: ChimeSdkMeeting

Required: No

SseAwsKeyManagementParams

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

Type: SseAwsKeyManagementParams object

Required: No

Status

The status of the media pipeline.

Type: String

Valid Values: Initializing | InProgress | Failed | Stopping | Stopped | Paused | NotStarted

Required: No

UpdatedTimestamp

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: