get_stage

GameSparks.Client.get_stage(**kwargs)

Gets information about a stage.

See also: AWS API Documentation

Request Syntax

response = client.get_stage(
    GameName='string',
    StageName='string'
)

Parameters

• GameName (string) --

  [REQUIRED]

  The name of the game.

• StageName (string) --

  [REQUIRED]

  The name of the stage.

Return type

dict

Returns

Response Syntax

{
    'Stage': {
        'Arn': 'string',
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'GameKey': 'string',
        'LastUpdated': datetime(2015, 1, 1),
        'LogGroup': 'string',
        'Name': 'string',
        'Role': 'string',
        'State': 'ACTIVE'|'DELETING',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Stage (dict) --

    Properties that provide details of the stage.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the stage.

    • Created (datetime) --

      The timestamp of when the stage was created.

    • Description (string) --

      The description of the stage.

    • GameKey (string) --

      The game key associated with the stage.

      The game key is a unique identifier that the game client uses to connect to the GameSparks backend.

    • LastUpdated (datetime) --

      The timestamp of when the stage was last updated.

    • LogGroup (string) --

      The Amazon CloudWatch log group for game runtimes deployed to the stage.

    • Name (string) --

      The name of the stage.

    • Role (string) --

      The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.

    • State (string) --

      The state of the stage.

    • Tags (dict) --

      The tags associated with the stage.

      • (string) --
        • (string) --

Exceptions

• GameSparks.Client.exceptions.ValidationException
• GameSparks.Client.exceptions.AccessDeniedException
• GameSparks.Client.exceptions.ThrottlingException
• GameSparks.Client.exceptions.ResourceNotFoundException
• GameSparks.Client.exceptions.InternalServerException