start_stage_deployment

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

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