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

CreateMediaCapturePipeline

Creates a media pipeline.

Request Syntax


POST /sdk-media-capture-pipelines HTTP/1.1
Content-type: application/json

{
   "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" ]
         }
      }
   },
   "ClientRequestToken": "string",
   "SinkArn": "string",
   "SinkIamRoleArn": "string",
   "SinkType": "string",
   "SourceArn": "string",
   "SourceType": "string",
   "SseAwsKeyManagementParams": { 
      "AwsKmsEncryptionContext": "string",
      "AwsKmsKeyId": "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.

ChimeSdkMeetingConfiguration

The configuration for a specified media 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 unique token for each media pipeline request.

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

SinkIamRoleArn

The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

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 are captured. A Chime SDK Meeting is the only supported source.

Type: String

Valid Values: ChimeSdkMeeting

Required: Yes

SseAwsKeyManagementParams

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

Type: SseAwsKeyManagementParams object

Required: No

Tags

The tag key-value pairs.

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

{
   "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"
   }
}

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 pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media 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