IVS / Paginator / ListFailoverSlateConfigurations

ListFailoverSlateConfigurations

class IVS.Paginator.ListFailoverSlateConfigurations

paginator = client.get_paginator('list_failover_slate_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IVS.Client.list_failover_slate_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'failoverSlateConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'activationThresholdSeconds': 123,
            'minSlateDisplaySeconds': 123,
            'maxSlateDisplaySeconds': 123,
            'state': 'CREATING'|'CREATE_FAILED'|'CREATED'|'UPDATING',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • failoverSlateConfigurations (list) –

    List of the matching failover slate configurations.

    • (dict) –

      Summary information about a failover slate configuration.

      • arn (string) –

        Failover-slate-configuration ARN.

      • name (string) –

        Failover-slate-configuration name.

      • activationThresholdSeconds (integer) –

        Number of seconds of ingest interruption before the failover slate activates. Default: 3.

      • minSlateDisplaySeconds (integer) –

        Minimum number of seconds that the failover slate displays after activation. Default: 3.

      • maxSlateDisplaySeconds (integer) –

        Maximum number of seconds that the failover slate displays. Default: 60.

      • state (string) –

        Current state of the failover slate configuration.

      • tags (dict) –

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.