GetComposition
Get information about the specified Composition resource.
Request Syntax
POST /GetComposition HTTP/1.1
Content-type: application/json
{
"arn": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- arn
-
ARN of the Composition resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"composition": {
"arn": "string",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "string",
"encoderConfigurationArn": "string"
},
"name": "string",
"s3": {
"encoderConfigurationArns": [ "string" ],
"recordingConfiguration": {
"format": "string",
"hlsConfiguration": {
"targetSegmentDurationSeconds": number
}
},
"storageConfigurationArn": "string",
"thumbnailConfigurations": [
{
"storage": [ "string" ],
"targetIntervalSeconds": number
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "string"
}
},
"endTime": "string",
"id": "string",
"startTime": "string",
"state": "string"
}
],
"endTime": "string",
"layout": {
"grid": {
"featuredParticipantAttribute": "string",
"gridGap": number,
"omitStoppedVideo": boolean,
"videoAspectRatio": "string",
"videoFillMode": "string"
},
"pip": {
"featuredParticipantAttribute": "string",
"gridGap": number,
"omitStoppedVideo": boolean,
"pipBehavior": "string",
"pipHeight": number,
"pipOffset": number,
"pipParticipantAttribute": "string",
"pipPosition": "string",
"pipWidth": number,
"videoFillMode": "string"
}
},
"stageArn": "string",
"startTime": "string",
"state": "string",
"tags": {
"string" : "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.
- composition
-
The Composition that was returned.
Type: Composition object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ConflictException
-
HTTP Status Code: 409
- InternalServerException
-
HTTP Status Code: 500
- ResourceNotFoundException
-
HTTP Status Code: 404
- ServiceQuotaExceededException
-
HTTP Status Code: 402
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
