Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMediaCapturePipeline

Creates a media capture pipeline.

Important

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.

ChimeSdkMeetingConfiguration

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

Type: ChimeSdkMeetingConfiguration object

Required: No

ClientRequestToken

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

SinkArn

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

SinkType

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

Type: String

Valid Values: S3Bucket

Required: Yes

SourceArn

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

SourceType

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.

MediaCapturePipeline

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

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