IVS / Client / update_failover_slate_configuration

update_failover_slate_configuration

IVS.Client.update_failover_slate_configuration(**kwargs)

Updates a specified failover slate configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_failover_slate_configuration(
    arn='string',
    name='string',
    activationThresholdSeconds=123,
    minSlateDisplaySeconds=123,
    maxSlateDisplaySeconds=123
)
Parameters:

  • arn (string) –

    [REQUIRED]

    ARN of the failover slate configuration to be updated.

  • name (string) – Failover-slate-configuration name. The value does not need to be unique.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'failoverSlateConfiguration': {
        'arn': 'string',
        'name': 'string',
        'activationThresholdSeconds': 123,
        'minSlateDisplaySeconds': 123,
        'maxSlateDisplaySeconds': 123,
        'state': 'CREATING'|'CREATE_FAILED'|'CREATED'|'UPDATING',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • failoverSlateConfiguration (dict) –

      Object specifying the updated 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) –

Exceptions