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(
    filterByStageArn='string',
    filterByEncoderConfigurationArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • 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 nextToken response field.

  • maxResults (integer) – Maximum number of results to return. Default: 100.

Return type:

dict

Returns:

Response Syntax

{
    'compositions': [
        {
            'arn': 'string',
            'stageArn': 'string',
            'destinations': [
                {
                    'id': 'string',
                    'state': 'STARTING'|'ACTIVE'|'STOPPING'|'RECONNECTING'|'FAILED'|'STOPPED',
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1)
                },
            ],
            'state': 'STARTING'|'ACTIVE'|'STOPPING'|'FAILED'|'STOPPED',
            'tags': {
                'string': 'string'
            },
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1)
        },
    ],
    '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.

        • stageArn (string) –

          ARN of the attached stage.

        • destinations (list) –

          Array of Destination objects.

          • (dict) –

            Summary information about a Destination.

            • id (string) –

              Unique identifier for this destination, assigned by IVS.

            • state (string) –

              State of the Composition Destination.

            • startTime (datetime) –

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

            • endTime (datetime) –

              UTC time of the destination end. 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 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.

          • (string) –

            • (string) –

        • startTime (datetime) –

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

        • endTime (datetime) –

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

    • nextToken (string) –

      If there are more compositions than maxResults, use nextToken in the request to get the next set.

Exceptions