# 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](#API_ListCompositions_RequestSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-request-filterByEncoderConfigurationArn"></a>
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](#API_ListCompositions_RequestSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-request-filterByStageArn"></a>
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](#API_ListCompositions_RequestSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-request-maxResults"></a>
Maximum number of results to return. Default: 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListCompositions_RequestSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-request-nextToken"></a>
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](#API_ListCompositions_ResponseSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-response-compositions"></a>
List of the matching Compositions (summary information only).  
Type: Array of [CompositionSummary](API_CompositionSummary.md) objects

 ** [nextToken](#API_ListCompositions_ResponseSyntax) **   <a name="ivsrealtimeeapireference-ListCompositions-response-nextToken"></a>
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 Error Types](CommonErrors.md).

 ** AccessDeniedException **   
    
 ** exceptionMessage **   
User does not have sufficient access to perform this action.
HTTP Status Code: 403

 ** ConflictException **   
    
 ** exceptionMessage **   
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409

 ** InternalServerException **   
    
 ** exceptionMessage **   
Unexpected error during processing of request.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
    
 ** exceptionMessage **   
Request would cause a service quota to be exceeded.
HTTP Status Code: 402

 ** ValidationException **   
    
 ** exceptionMessage **   
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ivs-realtime-2020-07-14/ListCompositions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ivs-realtime-2020-07-14/ListCompositions)