CreateMediaLiveConnectorPipeline
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
Request Syntax
POST /sdk-media-live-connector-pipelines HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "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"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientRequestToken
-
The token assigned to the client making the request.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Pattern:
[-_a-zA-Z0-9]*Required: No
- Sinks
-
The media live connector pipeline's data sinks.
Type: Array of LiveConnectorSinkConfiguration objects
Array Members: Fixed number of 1 item.
Required: Yes
- Sources
-
The media live connector pipeline's data sources.
Type: Array of LiveConnectorSourceConfiguration objects
Array Members: Fixed number of 1 item.
Required: Yes
- Tags
-
The tags associated with the media live connector pipeline.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"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"
}
}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.
- MediaLiveConnectorPipeline
-
The new media live connector pipeline.
Type: MediaLiveConnectorPipeline 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
- ResourceLimitExceededException
-
The request exceeds the resource limit.
- RequestId
-
The request ID associated with the call responsible for the exception.
HTTP Status Code: 400
- 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:
