Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Composition - Amazon IVS

Composition

Object specifying a Composition resource.

Contents

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

destinations

Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

Type: Array of Destination objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

layout

Layout object to configure composition parameters.

Type: LayoutConfiguration object

Required: Yes

stageArn

ARN of the stage used as input

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: Yes

state

State of the Composition.

Type: String

Valid Values: STARTING | ACTIVE | STOPPING | FAILED | STOPPED

Required: Yes

endTime

UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

Type: Timestamp

Required: No

startTime

UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

Type: Timestamp

Required: No

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor 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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.