compositions

Creates, updates, deletes, gets or lists a compositions resource.

Overview

Name	compositions
Type	Resource
Id	aws.ivs_realtime.compositions

Fields

The following fields are returned by SELECT queries:

get_composition

Name	Datatype	Description
arn	string	ARN of the Composition resource. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+</code>)
destinations	array	Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
end_time	string (date-time)	UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
layout	object	Layout object to configure composition parameters.
stage_arn	string	ARN of the stage used as input (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+</code>)
start_time	string (date-time)	UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
state	string	State of the Composition. (STARTING, ACTIVE, STOPPING, FAILED, STOPPED)
tags	object	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.

list_compositions

Name	Datatype	Description
compositions	array	List of the matching Compositions (summary information only).
next_token	string	If there are more compositions than maxResults, use nextToken in the request to get the next set. (pattern: <code>[a-zA-Z0-9+/=_-]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_composition	select	region		Get information about the specified Composition resource.
list_compositions	select	region		Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_composition

Get information about the specified Composition resource.

SELECT
arn,
destinations,
end_time,
layout,
stage_arn,
start_time,
state,
tags
FROM aws.ivs_realtime.compositions
WHERE region = '{{ region }}' -- required
;

list_compositions

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

SELECT
compositions,
next_token
FROM aws.ivs_realtime.compositions
WHERE region = '{{ region }}' -- required
;