ivsrealtime / Client / list_compositions
list_compositions#
- ivsrealtime.Client.list_compositions(**kwargs)#
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
response = client.list_compositions( filterByEncoderConfigurationArn='string', filterByStageArn='string', maxResults=123, nextToken='string' )
- Parameters:
filterByEncoderConfigurationArn (string) – Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
filterByStageArn (string) – Filters the Composition list to match the specified Stage ARN.
maxResults (integer) – Maximum number of results to return. Default: 100.
nextToken (string) – The first Composition to retrieve. This is used for pagination; see the
nextToken
response field.
- Return type:
dict
- Returns:
Response Syntax
{ 'compositions': [ { 'arn': 'string', 'destinations': [ { 'endTime': datetime(2015, 1, 1), 'id': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'STARTING'|'ACTIVE'|'STOPPING'|'RECONNECTING'|'FAILED'|'STOPPED' }, ], 'endTime': datetime(2015, 1, 1), 'stageArn': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'STARTING'|'ACTIVE'|'STOPPING'|'FAILED'|'STOPPED', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
compositions (list) –
List of the matching Compositions (summary information only).
(dict) –
Summary information about a Composition.
arn (string) –
ARN of the Composition resource.
destinations (list) –
Array of Destination objects.
(dict) –
Summary information about a Destination.
endTime (datetime) –
UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
id (string) –
Unique identifier for this destination, assigned by IVS.
startTime (datetime) –
UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
state (string) –
State of the Composition Destination.
endTime (datetime) –
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
stageArn (string) –
ARN of the attached stage.
startTime (datetime) –
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 resource.
tags (dict) –
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Tagging AWS Resources 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.(string) –
(string) –
nextToken (string) –
If there are more compositions than
maxResults
, usenextToken
in the request to get the next set.
Exceptions
ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException
ivsrealtime.Client.exceptions.InternalServerException
ivsrealtime.Client.exceptions.ServiceQuotaExceededException
ivsrealtime.Client.exceptions.ConflictException