GetMediaPipeline
Gets an existing media pipeline.
Request Syntax
GET /sdk-media-pipelines/mediaPipelineId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- mediaPipelineId
-
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
{
"MediaPipeline": {
"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",
"SinkIamRoleArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"SseAwsKeyManagementParams": {
"AwsKmsEncryptionContext": "string",
"AwsKmsKeyId": "string"
},
"Status": "string",
"UpdatedTimestamp": "string"
},
"MediaConcatenationPipeline": {
"CreatedTimestamp": "string",
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"S3BucketSinkConfiguration": {
"Destination": "string"
},
"Type": "string"
}
],
"Sources": [
{
"MediaCapturePipelineSourceConfiguration": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"State": "string"
},
"CompositedVideo": {
"State": "string"
},
"Content": {
"State": "string"
},
"DataChannel": {
"State": "string"
},
"MeetingEvents": {
"State": "string"
},
"TranscriptionMessages": {
"State": "string"
},
"Video": {
"State": "string"
}
}
},
"MediaPipelineArn": "string"
},
"Type": "string"
}
],
"Status": "string",
"UpdatedTimestamp": "string"
},
"MediaInsightsPipeline": {
"CreatedTimestamp": "string",
"ElementStatuses": [
{
"Status": "string",
"Type": "string"
}
],
"KinesisVideoStreamRecordingSourceRuntimeConfiguration": {
"FragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"Streams": [
{
"StreamArn": "string"
}
]
},
"KinesisVideoStreamSourceRuntimeConfiguration": {
"MediaEncoding": "string",
"MediaSampleRate": number,
"Streams": [
{
"FragmentNumber": "string",
"StreamArn": "string",
"StreamChannelDefinition": {
"ChannelDefinitions": [
{
"ChannelId": number,
"ParticipantRole": "string"
}
],
"NumberOfChannels": number
}
}
]
},
"MediaInsightsPipelineConfigurationArn": "string",
"MediaInsightsRuntimeMetadata": {
"string" : "string"
},
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"S3RecordingSinkRuntimeConfiguration": {
"Destination": "string",
"RecordingFileFormat": "string"
},
"Status": "string"
},
"MediaLiveConnectorPipeline": {
"CreatedTimestamp": "string",
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"RTMPConfiguration": {
"AudioChannels": "string",
"AudioSampleRate": "string",
"Url": "string"
},
"SinkType": "string"
}
],
"Sources": [
{
"ChimeSdkMeetingLiveConnectorConfiguration": {
"Arn": "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"
},
"MuxType": "string",
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"SourceType": "string"
}
],
"Status": "string",
"UpdatedTimestamp": "string"
},
"MediaStreamPipeline": {
"CreatedTimestamp": "string",
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"MediaStreamType": "string",
"ReservedStreamCapacity": number,
"SinkArn": "string",
"SinkType": "string"
}
],
"Sources": [
{
"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.
- MediaPipeline
-
The media pipeline object.
Type: MediaPipeline object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
- RequestId
-
The request id associated with the call responsible for the exception.
HTTP Status Code: 403
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
