GetMediaCapturePipeline - Amazon Chime SDK


Gets an existing media pipeline.

Request Syntax

GET /sdk-media-capture-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the pipeline that you want to get.

Length Constraints: Fixed length of 36.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MediaCapturePipeline": { "ChimeSdkMeetingConfiguration": { "ArtifactsConfiguration": { "Audio": { "MuxType": "string" }, "CompositedVideo": { "GridViewConfiguration": { "ActiveSpeakerOnlyConfiguration": { "ActiveSpeakerPosition": "string" }, "CanvasOrientation": "string", "ContentShareLayout": "string", "HorizontalLayoutConfiguration": { "TileAspectRatio": "string", "TileCount": number, "TileOrder": "string", "TilePosition": "string" }, "PresenterOnlyConfiguration": { "PresenterPosition": "string" }, "VerticalLayoutConfiguration": { "TileAspectRatio": "string", "TileCount": number, "TileOrder": "string", "TilePosition": "string" }, "VideoAttribute": { "BorderColor": "string", "BorderThickness": number, "CornerRadius": number, "HighlightColor": "string" } }, "Layout": "string", "Resolution": "string" }, "Content": { "MuxType": "string", "State": "string" }, "Video": { "MuxType": "string", "State": "string" } }, "SourceConfiguration": { "SelectedVideoStreams": { "AttendeeIds": [ "string" ], "ExternalUserIds": [ "string" ] } } }, "CreatedTimestamp": "string", "MediaPipelineArn": "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 200 response.

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


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


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


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: