CreateMediaCapturePipeline - Amazon Chime

The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.


Creates a media capture pipeline.


This API is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax

POST /media-capture-pipelines HTTP/1.1 Content-type: application/json { "ChimeSdkMeetingConfiguration": { "ArtifactsConfiguration": { "Audio": { "MuxType": "string" }, "Content": { "MuxType": "string", "State": "string" }, "Video": { "MuxType": "string", "State": "string" } }, "SourceConfiguration": { "SelectedVideoStreams": { "AttendeeIds": [ "string" ], "ExternalUserIds": [ "string" ] } } }, "ClientRequestToken": "string", "SinkArn": "string", "SinkType": "string", "SourceArn": "string", "SourceType": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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

Type: ChimeSdkMeetingConfiguration object

Required: No


The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No


The ARN of the sink type.

Type: String

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

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

Required: Yes


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

Type: String

Valid Values: S3Bucket

Required: Yes


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

Type: String

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

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

Required: Yes


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

Type: String

Valid Values: ChimeSdkMeeting

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "MediaCapturePipeline": { "ChimeSdkMeetingConfiguration": { "ArtifactsConfiguration": { "Audio": { "MuxType": "string" }, "Content": { "MuxType": "string", "State": "string" }, "Video": { "MuxType": "string", "State": "string" } }, "SourceConfiguration": { "SelectedVideoStreams": { "AttendeeIds": [ "string" ], "ExternalUserIds": [ "string" ] } } }, "CreatedTimestamp": "string", "MediaPipelineId": "string", "SinkArn": "string", "SinkType": "string", "SourceArn": "string", "SourceType": "string", "Status": "string", "UpdatedTimestamp": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.


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

Type: MediaCapturePipeline object


For information about the errors that are common to all actions, see Common Errors.


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The request exceeds the resource limit.

HTTP Status Code: 400


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

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