GameSparks

Client

class GameSparks.Client

A low-level client representing GameSparks

client = session.create_client('gamesparks')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_game(**kwargs)

Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration .

See also: AWS API Documentation

Request Syntax

response = client.create_game(
    ClientToken='string',
    Description='string',
    GameName='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) -- A client-defined token. With an active client token in the request, this action is idempotent.
  • Description (string) -- The description of the game.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Tags (dict) --

    The list of tags to apply to the game.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Game': {
        'Arn': 'string',
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'EnableTerminationProtection': True|False,
        'LastUpdated': datetime(2015, 1, 1),
        'Name': 'string',
        'State': 'ACTIVE'|'DELETING',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Game (dict) --

      Details about the game that was created.

      • Arn (string) --

        The Amazon Resource Name (ARN) of this game.

      • Created (datetime) --

        The date when the game was created.

      • Description (string) --

        The description of the game.

      • EnableTerminationProtection (boolean) --

        Determines if the game can be deleted.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Name (string) --

        The name of the game.

      • State (string) --

        The state of the game.

      • Tags (dict) --

        The tags associated with the game.

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

Exceptions

create_snapshot(**kwargs)

Creates a snapshot of the game configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot(
    Description='string',
    GameName='string'
)
Parameters
  • Description (string) -- The description of the snapshot.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

Return type

dict

Returns

Response Syntax

{
    'Snapshot': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Id': 'string',
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • Snapshot (dict) --

      Properties that provide details of the created snapshot.

      • Created (datetime) --

        The timestamp of when the snapshot was created.

      • Description (string) --

        The description of the snapshot.

      • Id (string) --

        The identifier of the snapshot.

      • LastUpdated (datetime) --

        The timestamp of when the snapshot was last updated.

      • Sections (dict) --

        The sections in the snapshot.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

create_stage(**kwargs)

Creates a new stage for stage-by-stage game development and deployment.

See also: AWS API Documentation

Request Syntax

response = client.create_stage(
    ClientToken='string',
    Description='string',
    GameName='string',
    Role='string',
    StageName='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) -- A client-defined token. With an active client token in the request, this action is idempotent.
  • Description (string) -- The description of the stage.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Role (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the role to run the game with. This role can be a game-defined role or the default role that GameSparks created.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

  • Tags (dict) --

    The list of tags to apply to the stage.

    • (string) --
      • (string) --
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 describe 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

delete_game(**kwargs)

Deletes a game.

See also: AWS API Documentation

Request Syntax

response = client.delete_game(
    GameName='string'
)
Parameters
GameName (string) --

[REQUIRED]

The name of the game to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_stage(**kwargs)

Deletes a stage from a game, along with the associated game runtime.

See also: AWS API Documentation

Request Syntax

response = client.delete_stage(
    GameName='string',
    StageName='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • StageName (string) --

    [REQUIRED]

    The name of the stage to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

disconnect_player(**kwargs)

Disconnects a player from the game runtime.

If a player has multiple connections, this operation attempts to close all of them.

See also: AWS API Documentation

Request Syntax

response = client.disconnect_player(
    GameName='string',
    PlayerId='string',
    StageName='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • PlayerId (string) --

    [REQUIRED]

    The unique identifier representing a player.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

Return type

dict

Returns

Response Syntax

{
    'DisconnectFailures': [
        'string',
    ],
    'DisconnectSuccesses': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • DisconnectFailures (list) --

      The list of the connection ids that could not be disconnected.

      • (string) --
    • DisconnectSuccesses (list) --

      The list of the connection ids that were disconnected.

      • (string) --

Exceptions

export_snapshot(**kwargs)

Exports a game configuration snapshot.

See also: AWS API Documentation

Request Syntax

response = client.export_snapshot(
    GameName='string',
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot to export.

Return type

dict

Returns

Response Syntax

{
    'S3Url': 'string'
}

Response Structure

  • (dict) --

    • S3Url (string) --

      The presigned URL for the snapshot data.

      This URL will be available for 10 minutes, and can be used to download the snapshot content. If the URL expires, a new one can be requested using the same operation.

Exceptions

get_extension(**kwargs)

Gets details about a specified extension.

See also: AWS API Documentation

Request Syntax

response = client.get_extension(
    Name='string',
    Namespace='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the extension.

  • Namespace (string) --

    [REQUIRED]

    The namespace (qualifier) of the extension.

Return type

dict

Returns

Response Syntax

{
    'Extension': {
        'Description': 'string',
        'Name': 'string',
        'Namespace': 'string'
    }
}

Response Structure

  • (dict) --

    • Extension (dict) --

      Details about the extension.

      • Description (string) --

        The description of the extension.

      • Name (string) --

        The name of the extension.

      • Namespace (string) --

        The namespace (qualifier) of the extension.

Exceptions

get_extension_version(**kwargs)

Gets details about a specified extension version.

See also: AWS API Documentation

Request Syntax

response = client.get_extension_version(
    ExtensionVersion='string',
    Name='string',
    Namespace='string'
)
Parameters
  • ExtensionVersion (string) --

    [REQUIRED]

    The version of the extension.

  • Name (string) --

    [REQUIRED]

    The name of the extension.

  • Namespace (string) --

    [REQUIRED]

    The namespace (qualifier) of the extension.

Return type

dict

Returns

Response Syntax

{
    'ExtensionVersion': {
        'Name': 'string',
        'Namespace': 'string',
        'Schema': 'string',
        'Version': 'string'
    }
}

Response Structure

  • (dict) --

    • ExtensionVersion (dict) --

      The version of the extension.

      • Name (string) --

        The name of the extension.

      • Namespace (string) --

        The namespace (qualifier) of the extension.

      • Schema (string) --

        The model that defines the interface for this extension version.

      • Version (string) --

        The version of the extension.

Exceptions

get_game(**kwargs)

Gets details about a game.

See also: AWS API Documentation

Request Syntax

response = client.get_game(
    GameName='string'
)
Parameters
GameName (string) --

[REQUIRED]

The name of the game.

Return type
dict
Returns
Response Syntax
{
    'Game': {
        'Arn': 'string',
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'EnableTerminationProtection': True|False,
        'LastUpdated': datetime(2015, 1, 1),
        'Name': 'string',
        'State': 'ACTIVE'|'DELETING',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • Game (dict) --

      The details of the game.

      • Arn (string) --

        The Amazon Resource Name (ARN) of this game.

      • Created (datetime) --

        The date when the game was created.

      • Description (string) --

        The description of the game.

      • EnableTerminationProtection (boolean) --

        Determines if the game can be deleted.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Name (string) --

        The name of the game.

      • State (string) --

        The state of the game.

      • Tags (dict) --

        The tags associated with the game.

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

Exceptions

get_game_configuration(**kwargs)

Gets the configuration of the game.

See also: AWS API Documentation

Request Syntax

response = client.get_game_configuration(
    GameName='string',
    Sections=[
        'string',
    ]
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Sections (list) --

    The list of sections to return.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'GameConfiguration': {
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • GameConfiguration (dict) --

      Details about the game configuration.

      • Created (datetime) --

        The date when the game was created.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Sections (dict) --

        Configuration data, organized by section name.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

get_generated_code_job(**kwargs)

Gets details about a job that is generating code for a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_generated_code_job(
    GameName='string',
    JobId='string',
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • JobId (string) --

    [REQUIRED]

    The identifier of the code generation job.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot for the code generation job.

Return type

dict

Returns

Response Syntax

{
    'GeneratedCodeJob': {
        'Description': 'string',
        'ExpirationTime': datetime(2015, 1, 1),
        'GeneratedCodeJobId': 'string',
        'S3Url': 'string',
        'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PENDING'
    }
}

Response Structure

  • (dict) --

    • GeneratedCodeJob (dict) --

      Details about the generated code job.

      • Description (string) --

        The description of the generated code job.

      • ExpirationTime (datetime) --

        The expiration date and time for the download URL.

        The download URL us guaranteed to be available until at least this time.

      • GeneratedCodeJobId (string) --

        The identifier for the generated code job.

      • S3Url (string) --

        A presigned URL that can be used to download the generated code.

      • Status (string) --

        The status of the generated code job

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_player_connection_status(**kwargs)

Gets the status of a player's connection to the game runtime.

It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.

See also: AWS API Documentation

Request Syntax

response = client.get_player_connection_status(
    GameName='string',
    PlayerId='string',
    StageName='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • PlayerId (string) --

    [REQUIRED]

    The unique identifier representing a player.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'Created': datetime(2015, 1, 1),
            'Id': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Connections (list) --

      The list of connection ids, one for each connection in use by the player.

      • (dict) --

        Details about a WebSocket connection.

        • Created (datetime) --

          The date and time when the connection was created.

        • Id (string) --

          The identifier used to indicate a specific WebSocket connection.

Exceptions

get_snapshot(**kwargs)

Gets a copy of the game configuration in a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_snapshot(
    GameName='string',
    Sections=[
        'string',
    ],
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Sections (list) --

    The list of game configuration sections to be described.

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

    [REQUIRED]

    The identifier of the snapshot.

Return type

dict

Returns

Response Syntax

{
    'Snapshot': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Id': 'string',
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • Snapshot (dict) --

      Properties that provide details of the snapshot.

      • Created (datetime) --

        The timestamp of when the snapshot was created.

      • Description (string) --

        The description of the snapshot.

      • Id (string) --

        The identifier of the snapshot.

      • LastUpdated (datetime) --

        The timestamp of when the snapshot was last updated.

      • Sections (dict) --

        The sections in the snapshot.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

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

get_stage_deployment(**kwargs)

Gets information about a stage deployment.

See also: AWS API Documentation

Request Syntax

response = client.get_stage_deployment(
    DeploymentId='string',
    GameName='string',
    StageName='string'
)
Parameters
  • DeploymentId (string) -- The identifier of the stage deployment. StartStageDeployment returns the identifier that you use here.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

Return type

dict

Returns

Response Syntax

{
    'StageDeployment': {
        'Created': datetime(2015, 1, 1),
        'DeploymentAction': 'DEPLOY'|'UNDEPLOY',
        'DeploymentId': 'string',
        'DeploymentResult': {
            'Message': 'string',
            'ResultCode': 'SUCCESS'|'INVALID_ROLE_FAILURE'|'UNSPECIFIED_FAILURE'
        },
        'DeploymentState': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'LastUpdated': datetime(2015, 1, 1),
        'SnapshotId': 'string'
    }
}

Response Structure

  • (dict) --

    • StageDeployment (dict) --

      Properties that provide details of the stage deployment.

      • Created (datetime) --

        The timestamp of when the stage deployment was created.

      • DeploymentAction (string) --

        The type of action of the stage deployment.

      • DeploymentId (string) --

        The identifier of the deployment.

      • DeploymentResult (dict) --

        The result of the deployment.

        • Message (string) --

          Details about the deployment result.

        • ResultCode (string) --

          The type of deployment result.

      • DeploymentState (string) --

        The state of the deployment.

      • LastUpdated (datetime) --

        The timestamp of when the deployment was last updated.

      • SnapshotId (string) --

        The identifier of the snapshot associated with the stage deployment.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
import_game_configuration(**kwargs)

Imports a game configuration.

This operation replaces the current configuration of the game with the provided input. This is not a reversible operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new snapshot before importing.

See also: AWS API Documentation

Request Syntax

response = client.import_game_configuration(
    GameName='string',
    ImportSource={
        'File': b'bytes'
    }
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • ImportSource (dict) --

    [REQUIRED]

    The source used to import configuration sections.

    • File (bytes) -- [REQUIRED]

      The JSON string containing the configuration sections.

Return type

dict

Returns

Response Syntax

{
    'GameConfiguration': {
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • GameConfiguration (dict) --

      Details about the game configuration.

      • Created (datetime) --

        The date when the game was created.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Sections (dict) --

        Configuration data, organized by section name.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

list_extension_versions(**kwargs)

Gets a paginated list of available versions for the extension.

Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.

See also: AWS API Documentation

Request Syntax

response = client.list_extension_versions(
    MaxResults=123,
    Name='string',
    Namespace='string',
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • Name (string) --

    [REQUIRED]

    The name of the extension.

  • Namespace (string) --

    [REQUIRED]

    The namespace (qualifier) of the extension.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'ExtensionVersions': [
        {
            'Name': 'string',
            'Namespace': 'string',
            'Schema': 'string',
            'Version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ExtensionVersions (list) --

      The list of extension versions.

      • (dict) --

        Details about the extension version.

        • Name (string) --

          The name of the extension.

        • Namespace (string) --

          The namespace (qualifier) of the extension.

        • Schema (string) --

          The model that defines the interface for this extension version.

        • Version (string) --

          The version of the extension.

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

Exceptions

list_extensions(**kwargs)

Gets a paginated list of available extensions.

Extensions provide features that games can use from scripts.

See also: AWS API Documentation

Request Syntax

response = client.list_extensions(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'Extensions': [
        {
            'Description': 'string',
            'Name': 'string',
            'Namespace': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Extensions (list) --

      The list of extensions.

      • (dict) --

        Details about the extension.

        • Description (string) --

          The description of the extension.

        • Name (string) --

          The name of the extension.

        • Namespace (string) --

          The namespace (qualifier) of the extension.

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

Exceptions

list_games(**kwargs)

Gets a paginated list of games.

See also: AWS API Documentation

Request Syntax

response = client.list_games(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'Games': [
        {
            'Description': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Games (list) --

      The list of games.

      • (dict) --

        The summary of the properties of a game.

        • Description (string) --

          The description of the game.

        • Name (string) --

          The name of the game.

        • State (string) --

          The state of the game.

        • Tags (dict) --

          The tags associated with the game.

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

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

Exceptions

list_generated_code_jobs(**kwargs)

Gets a paginated list of code generation jobs for a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.list_generated_code_jobs(
    GameName='string',
    MaxResults=123,
    NextToken='string',
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot.

Return type

dict

Returns

Response Syntax

{
    'GeneratedCodeJobs': [
        {
            'Description': 'string',
            'ExpirationTime': datetime(2015, 1, 1),
            'GeneratedCodeJobId': 'string',
            'S3Url': 'string',
            'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PENDING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • GeneratedCodeJobs (list) --

      The list of generated code jobs.

      • (dict) --

        Details about a generated code job.

        • Description (string) --

          The description of the generated code job.

        • ExpirationTime (datetime) --

          The expiration date and time for the download URL.

          The download URL us guaranteed to be available until at least this time.

        • GeneratedCodeJobId (string) --

          The identifier for the generated code job.

        • S3Url (string) --

          A presigned URL that can be used to download the generated code.

        • Status (string) --

          The status of the generated code job

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

Exceptions

list_snapshots(**kwargs)

Gets a paginated list of snapshot summaries from the game.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshots(
    GameName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Snapshots': [
        {
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'LastUpdated': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

    • Snapshots (list) --

      A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

      • (dict) --

        The summary of the properties of a snapshot.

        • Created (datetime) --

          The timestamp of when the snapshot was created.

        • Description (string) --

          The description of the snapshot.

        • Id (string) --

          The identifier of the snapshot.

        • LastUpdated (datetime) --

          Then timestamp of when the snapshot was last updated.

Exceptions

list_stage_deployments(**kwargs)

Gets a paginated list of stage deployment summaries from the game.

See also: AWS API Documentation

Request Syntax

response = client.list_stage_deployments(
    GameName='string',
    MaxResults=123,
    NextToken='string',
    StageName='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'StageDeployments': [
        {
            'DeploymentAction': 'DEPLOY'|'UNDEPLOY',
            'DeploymentId': 'string',
            'DeploymentResult': {
                'Message': 'string',
                'ResultCode': 'SUCCESS'|'INVALID_ROLE_FAILURE'|'UNSPECIFIED_FAILURE'
            },
            'DeploymentState': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'LastUpdated': datetime(2015, 1, 1),
            'SnapshotId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

    • StageDeployments (list) --

      A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.

      • (dict) --

        The summary of the properties of a stage deployment.

        • DeploymentAction (string) --

          The type of action of the deployment.

        • DeploymentId (string) --

          The identifier of the deployment.

        • DeploymentResult (dict) --

          The result of the deployment.

          • Message (string) --

            Details about the deployment result.

          • ResultCode (string) --

            The type of deployment result.

        • DeploymentState (string) --

          The state of the deployment.

        • LastUpdated (datetime) --

          The timestamp of when the deployment was last updated.

        • SnapshotId (string) --

          The identifier of the snapshot associated with the stage deployment.

Exceptions

list_stages(**kwargs)

Gets a paginated list of stage summaries from the game.

See also: AWS API Documentation

Request Syntax

response = client.list_stages(
    GameName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • MaxResults (integer) --

    The maximum number of results to return.

    Use this parameter with NextToken to get results as a set of sequential pages.

  • NextToken (string) --

    The token that indicates the start of the next sequential page of results.

    Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Stages': [
        {
            'Description': 'string',
            'GameKey': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token that indicates the start of the next sequential page of results.

      Use this value when making the next call to this operation to continue where the last one finished.

    • Stages (list) --

      A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

      • (dict) --

        The summary of the properties of a stage.

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

        • Name (string) --

          The name of the stage.

        • State (string) --

          The state of the stage.

        • Tags (dict) --

          The tags associated with the stage.

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

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags associated with a GameSparks resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the GameSparks resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The tags associated with the resource.

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

Exceptions

start_generated_code_job(**kwargs)

Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.

See also: AWS API Documentation

Request Syntax

response = client.start_generated_code_job(
    GameName='string',
    Generator={
        'GameSdkVersion': 'string',
        'Language': 'string',
        'TargetPlatform': 'string'
    },
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Generator (dict) --

    [REQUIRED]

    Properties of the generator to use for the job.

    • GameSdkVersion (string) --

      The target version of the GameSparks Game SDK.

    • Language (string) --

      The programming language for the generated code.

      Not all languages are supported for each platform. For cases where multiple languages are supported, this parameter specifies the language to be used. If this value is omitted, the default language for the target platform will be used.

    • TargetPlatform (string) --

      The platform that will be used to run the generated code.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot for which to generate code.

Return type

dict

Returns

Response Syntax

{
    'GeneratedCodeJobId': 'string'
}

Response Structure

  • (dict) --

    • GeneratedCodeJobId (string) --

      The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

Exceptions

start_stage_deployment(**kwargs)

Deploys a snapshot to the stage and creates a new game runtime.

After you call this operation, you can check the deployment status by using GetStageDeployment .

If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.

See also: AWS API Documentation

Request Syntax

response = client.start_stage_deployment(
    ClientToken='string',
    GameName='string',
    SnapshotId='string',
    StageName='string'
)
Parameters
  • ClientToken (string) -- A client-defined token. With an active client token in the request, this action is idempotent.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot to deploy.

  • StageName (string) --

    [REQUIRED]

    The name of the stage to deploy the snapshot onto.

Return type

dict

Returns

Response Syntax

{
    'StageDeployment': {
        'Created': datetime(2015, 1, 1),
        'DeploymentAction': 'DEPLOY'|'UNDEPLOY',
        'DeploymentId': 'string',
        'DeploymentResult': {
            'Message': 'string',
            'ResultCode': 'SUCCESS'|'INVALID_ROLE_FAILURE'|'UNSPECIFIED_FAILURE'
        },
        'DeploymentState': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'LastUpdated': datetime(2015, 1, 1),
        'SnapshotId': 'string'
    }
}

Response Structure

  • (dict) --

    • StageDeployment (dict) --

      Properties that describe the stage deployment.

      • Created (datetime) --

        The timestamp of when the stage deployment was created.

      • DeploymentAction (string) --

        The type of action of the stage deployment.

      • DeploymentId (string) --

        The identifier of the deployment.

      • DeploymentResult (dict) --

        The result of the deployment.

        • Message (string) --

          Details about the deployment result.

        • ResultCode (string) --

          The type of deployment result.

      • DeploymentState (string) --

        The state of the deployment.

      • LastUpdated (datetime) --

        The timestamp of when the deployment was last updated.

      • SnapshotId (string) --

        The identifier of the snapshot associated with the stage deployment.

Exceptions

tag_resource(**kwargs)

Adds tags to a GameSparks resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to add the tags to.

  • tags (dict) --

    [REQUIRED]

    The tags to add to the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from a GameSparks resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to remove the tags from.

  • tagKeys (list) --

    [REQUIRED]

    The keys of the tags to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_game(**kwargs)

Updates details of the game.

See also: AWS API Documentation

Request Syntax

response = client.update_game(
    Description='string',
    GameName='string'
)
Parameters
  • Description (string) -- The description of the game.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

Return type

dict

Returns

Response Syntax

{
    'Game': {
        'Arn': 'string',
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'EnableTerminationProtection': True|False,
        'LastUpdated': datetime(2015, 1, 1),
        'Name': 'string',
        'State': 'ACTIVE'|'DELETING',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Game (dict) --

      The details of the game.

      • Arn (string) --

        The Amazon Resource Name (ARN) of this game.

      • Created (datetime) --

        The date when the game was created.

      • Description (string) --

        The description of the game.

      • EnableTerminationProtection (boolean) --

        Determines if the game can be deleted.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Name (string) --

        The name of the game.

      • State (string) --

        The state of the game.

      • Tags (dict) --

        The tags associated with the game.

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

Exceptions

update_game_configuration(**kwargs)

Updates one or more sections of the game configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_game_configuration(
    GameName='string',
    Modifications=[
        {
            'Operation': 'ADD'|'REMOVE'|'REPLACE',
            'Path': 'string',
            'Section': 'string',
            'Value': {...}|[...]|123|123.4|'string'|True|None
        },
    ]
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Modifications (list) --

    [REQUIRED]

    The list of modifications to make.

    • (dict) --

      A single modification to the configuration section.

      • Operation (string) -- [REQUIRED]

        The operation to be performed on a configuration section.

        Content can be added, deleted, or replaced within a section.

      • Path (string) -- [REQUIRED]

        The path within the section content to be modified.

      • Section (string) -- [REQUIRED]

        The name of the section to be modified.

      • Value (document) --

        For add and replace operations, this is the value that will be used.

        This field should be omitted for delete operations.

Return type

dict

Returns

Response Syntax

{
    'GameConfiguration': {
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • GameConfiguration (dict) --

      Details about the game configuration.

      • Created (datetime) --

        The date when the game was created.

      • LastUpdated (datetime) --

        The date when the game was last modified.

      • Sections (dict) --

        Configuration data, organized by section name.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

update_snapshot(**kwargs)

Updates the metadata of a GameSparks snapshot.

See also: AWS API Documentation

Request Syntax

response = client.update_snapshot(
    Description='string',
    GameName='string',
    SnapshotId='string'
)
Parameters
  • Description (string) -- The description of the snapshot.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot.

Return type

dict

Returns

Response Syntax

{
    'Snapshot': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Id': 'string',
        'LastUpdated': datetime(2015, 1, 1),
        'Sections': {
            'string': {
                'Attributes': {...}|[...]|123|123.4|'string'|True|None,
                'Name': 'string',
                'Size': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • Snapshot (dict) --

      Properties that provide details of the updated snapshot.

      • Created (datetime) --

        The timestamp of when the snapshot was created.

      • Description (string) --

        The description of the snapshot.

      • Id (string) --

        The identifier of the snapshot.

      • LastUpdated (datetime) --

        The timestamp of when the snapshot was last updated.

      • Sections (dict) --

        The sections in the snapshot.

        • (string) --

          • (dict) --

            The configuration section.

            • Attributes (document) --

              The content of a configuration section.

            • Name (string) --

              The name of the section.

            • Size (integer) --

              The size, in bytes, of the section contents.

Exceptions

update_stage(**kwargs)

Updates the metadata of a stage.

See also: AWS API Documentation

Request Syntax

response = client.update_stage(
    Description='string',
    GameName='string',
    Role='string',
    StageName='string'
)
Parameters
  • Description (string) -- The description of the stage.
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • Role (string) -- The Amazon Resource Name (ARN) of the role to use for the game snapshots deployed to this stage.
  • 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 updated 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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class GameSparks.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.ConflictException

The resource already exists, or another operation is in progress.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource already exists, or another operation is in progress.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.InternalServerException

The service encountered an internal error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service encountered an internal error.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.ResourceNotFoundException

The resource specified in the request does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource specified in the request does not exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.ServiceQuotaExceededException

The request would result in exceeding service quota.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would result in exceeding service quota.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.ThrottlingException

The request throughput limit was exceeded.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request throughput limit was exceeded.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GameSparks.Client.exceptions.ValidationException

One of the parameters in the request is invalid.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One of the parameters in the request is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class GameSparks.Paginator.ListExtensionVersions
paginator = client.get_paginator('list_extension_versions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_extension_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Name='string',
    Namespace='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the extension.

  • Namespace (string) --

    [REQUIRED]

    The namespace (qualifier) of the extension.

  • 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

{
    'ExtensionVersions': [
        {
            'Name': 'string',
            'Namespace': 'string',
            'Schema': 'string',
            'Version': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • ExtensionVersions (list) --

      The list of extension versions.

      • (dict) --

        Details about the extension version.

        • Name (string) --

          The name of the extension.

        • Namespace (string) --

          The namespace (qualifier) of the extension.

        • Schema (string) --

          The model that defines the interface for this extension version.

        • Version (string) --

          The version of the extension.

class GameSparks.Paginator.ListExtensions
paginator = client.get_paginator('list_extensions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_extensions().

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
{
    'Extensions': [
        {
            'Description': 'string',
            'Name': 'string',
            'Namespace': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • Extensions (list) --

      The list of extensions.

      • (dict) --

        Details about the extension.

        • Description (string) --

          The description of the extension.

        • Name (string) --

          The name of the extension.

        • Namespace (string) --

          The namespace (qualifier) of the extension.

class GameSparks.Paginator.ListGames
paginator = client.get_paginator('list_games')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_games().

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
{
    'Games': [
        {
            'Description': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --
    • Games (list) --

      The list of games.

      • (dict) --

        The summary of the properties of a game.

        • Description (string) --

          The description of the game.

        • Name (string) --

          The name of the game.

        • State (string) --

          The state of the game.

        • Tags (dict) --

          The tags associated with the game.

          • (string) --
            • (string) --
class GameSparks.Paginator.ListGeneratedCodeJobs
paginator = client.get_paginator('list_generated_code_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_generated_code_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GameName='string',
    SnapshotId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot.

  • 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

{
    'GeneratedCodeJobs': [
        {
            'Description': 'string',
            'ExpirationTime': datetime(2015, 1, 1),
            'GeneratedCodeJobId': 'string',
            'S3Url': 'string',
            'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PENDING'
        },
    ],

}

Response Structure

  • (dict) --

    • GeneratedCodeJobs (list) --

      The list of generated code jobs.

      • (dict) --

        Details about a generated code job.

        • Description (string) --

          The description of the generated code job.

        • ExpirationTime (datetime) --

          The expiration date and time for the download URL.

          The download URL us guaranteed to be available until at least this time.

        • GeneratedCodeJobId (string) --

          The identifier for the generated code job.

        • S3Url (string) --

          A presigned URL that can be used to download the generated code.

        • Status (string) --

          The status of the generated code job

class GameSparks.Paginator.ListSnapshots
paginator = client.get_paginator('list_snapshots')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_snapshots().

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the game.

  • 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

{
    'Snapshots': [
        {
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'LastUpdated': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • Snapshots (list) --

      A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

      • (dict) --

        The summary of the properties of a snapshot.

        • Created (datetime) --

          The timestamp of when the snapshot was created.

        • Description (string) --

          The description of the snapshot.

        • Id (string) --

          The identifier of the snapshot.

        • LastUpdated (datetime) --

          Then timestamp of when the snapshot was last updated.

class GameSparks.Paginator.ListStageDeployments
paginator = client.get_paginator('list_stage_deployments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_stage_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GameName='string',
    StageName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • StageName (string) --

    [REQUIRED]

    The name of the stage.

  • 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

{
    'StageDeployments': [
        {
            'DeploymentAction': 'DEPLOY'|'UNDEPLOY',
            'DeploymentId': 'string',
            'DeploymentResult': {
                'Message': 'string',
                'ResultCode': 'SUCCESS'|'INVALID_ROLE_FAILURE'|'UNSPECIFIED_FAILURE'
            },
            'DeploymentState': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'LastUpdated': datetime(2015, 1, 1),
            'SnapshotId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • StageDeployments (list) --

      A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.

      • (dict) --

        The summary of the properties of a stage deployment.

        • DeploymentAction (string) --

          The type of action of the deployment.

        • DeploymentId (string) --

          The identifier of the deployment.

        • DeploymentResult (dict) --

          The result of the deployment.

          • Message (string) --

            Details about the deployment result.

          • ResultCode (string) --

            The type of deployment result.

        • DeploymentState (string) --

          The state of the deployment.

        • LastUpdated (datetime) --

          The timestamp of when the deployment was last updated.

        • SnapshotId (string) --

          The identifier of the snapshot associated with the stage deployment.

class GameSparks.Paginator.ListStages
paginator = client.get_paginator('list_stages')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GameSparks.Client.list_stages().

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the game.

  • 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

{
    'Stages': [
        {
            'Description': 'string',
            'GameKey': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Stages (list) --

      A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

      • (dict) --

        The summary of the properties of a stage.

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

        • Name (string) --

          The name of the stage.

        • State (string) --

          The state of the stage.

        • Tags (dict) --

          The tags associated with the stage.

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