CreateMediaLiveConnectorPipeline - Amazon Chime SDK

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": { "ContentShareLayout": "string", "PresenterOnlyConfiguration": { "PresenterPosition": "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 50 items.

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "MediaLiveConnectorPipeline": { "CreatedTimestamp": number, "MediaPipelineArn": "string", "MediaPipelineId": "string", "Sinks": [ { "RTMPConfiguration": { "AudioChannels": "string", "AudioSampleRate": "string", "Url": "string" }, "SinkType": "string" } ], "Sources": [ { "ChimeSdkMeetingLiveConnectorConfiguration": { "Arn": "string", "CompositedVideo": { "GridViewConfiguration": { "ContentShareLayout": "string", "PresenterOnlyConfiguration": { "PresenterPosition": "string" } }, "Layout": "string", "Resolution": "string" }, "MuxType": "string", "SourceConfiguration": { "SelectedVideoStreams": { "AttendeeIds": [ "string" ], "ExternalUserIds": [ "string" ] } } }, "SourceType": "string" } ], "Status": "string", "UpdatedTimestamp": number } }

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.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

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: