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

ListCompositions

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Request Syntax


POST /ListCompositions HTTP/1.1
Content-type: application/json

{
   "filterByEncoderConfigurationArn": "string",
   "filterByStageArn": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterByEncoderConfigurationArn

Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

Type: String

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

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+

Required: No

filterByStageArn

Filters the Composition list to match the specified Stage ARN.

Type: String

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

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+

Required: No

maxResults

Maximum number of results to return. Default: 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The first Composition to retrieve. This is used for pagination; see the nextToken response field.

Type: String

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

Pattern: [a-zA-Z0-9+/=_-]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "compositions": [ 
      { 
         "arn": "string",
         "destinations": [ 
            { 
               "endTime": "string",
               "id": "string",
               "startTime": "string",
               "state": "string"
            }
         ],
         "endTime": "string",
         "stageArn": "string",
         "startTime": "string",
         "state": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "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.

compositions

List of the matching Compositions (summary information only).

Type: Array of CompositionSummary objects

nextToken

If there are more compositions than maxResults, use nextToken in the request to get the next set.

Type: String

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

Pattern: [a-zA-Z0-9+/=_-]*

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

ServiceQuotaExceededException

HTTP Status Code: 402

ValidationException

HTTP Status Code: 400