list_stage_deployments

GameSparks.Client.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

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