ivsrealtime / Client / update_stage

update_stage#

ivsrealtime.Client.update_stage(**kwargs)#

Updates a stage’s configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_stage(
    arn='string',
    name='string'
)
Parameters:

  • arn (string) –

    [REQUIRED]

    ARN of the stage to be updated.

  • name (string) – Name of the stage to be updated.

Return type:

dict

Returns:

Response Syntax

{
    'stage': {
        'activeSessionId': 'string',
        'arn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • stage (dict) –

      The updated stage.

      • activeSessionId (string) –

        ID of the active session within the stage.

      • arn (string) –

        Stage ARN.

      • name (string) –

        Stage name.

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

Exceptions

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException

  • ivsrealtime.Client.exceptions.ServiceQuotaExceededException

  • ivsrealtime.Client.exceptions.PendingVerification