GameSparks / Paginator / ListStageDeployments

ListStageDeployments

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.