---
title: "POST /ListCompositions"
method: POST
path: "/ListCompositions"
---

# POST /ListCompositions

`POST /ListCompositions`

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

## Request body

- object
  - `filterByStageArn` string — Filters the Composition list to match the specified Stage ARN.
  - `filterByEncoderConfigurationArn` string — Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
  - `nextToken` string — The first Composition to retrieve. This is used for pagination; see the <code>nextToken</code> response field.
  - `maxResults` integer — Maximum number of results to return. Default: 100.

## Response `200`

Success

- ListCompositionsResponse
  - `compositions` CompositionSummary[], required — List of the matching Compositions (summary information only).
    - `arn` string, required — ARN of the Composition resource.
    - `stageArn` string, required — ARN of the attached stage.
    - `destinations` DestinationSummary[], required — Array of Destination objects.
      - `id` string, required — Unique identifier for this destination, assigned by IVS.
      - `state` 'STARTING' | 'ACTIVE' | 'STOPPING' | 'RECONNECTING' | 'FAILED' | 'STOPPED', required — State of the Composition Destination.
      - `startTime` string, date-time — UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
      - `endTime` string, date-time — UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
    - `state` 'STARTING' | 'ACTIVE' | 'STOPPING' | 'FAILED' | 'STOPPED', required — State of the Composition resource.
    - `tags` object — Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
    - `startTime` string, date-time — UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
    - `endTime` string, date-time — UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
  - `nextToken` string — If there are more compositions than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException
- `482` — InternalServerException
- `483` — ServiceQuotaExceededException
- `484` — ConflictException

---

[API](https://skmtc.net/aws/apis/ivs-realtime.md) · [All operations](https://skmtc.net/aws/apis/ivs-realtime/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ivs-realtime/versions/f8857274a50f/schema)