GameSparks / Client / get_stage_deployment
get_stage_deployment#
- GameSparks.Client.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
GameSparks.Client.exceptions.ValidationException
GameSparks.Client.exceptions.AccessDeniedException
GameSparks.Client.exceptions.ThrottlingException
GameSparks.Client.exceptions.ResourceNotFoundException
GameSparks.Client.exceptions.InternalServerException