IVS / Client / list_failover_slate_configurations

list_failover_slate_configurations

IVS.Client.list_failover_slate_configurations(**kwargs)

Gets summary information about all failover slate configurations in your account, in the Amazon Web Services region where the API request is processed.

See also: AWS API Documentation

Request Syntax

response = client.list_failover_slate_configurations(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The first failover slate configuration to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of failover slate configurations to return. Default: your service quota or 100, whichever is smaller.

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) –

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

Exceptions