get_deployment_status

get_deployment_status(**kwargs)

Returns the status of a deployment.

See also: AWS API Documentation

Request Syntax

response = client.get_deployment_status(
    DeploymentId='string',
    GroupId='string'
)
Parameters
  • DeploymentId (string) -- [REQUIRED] The ID of the deployment.
  • GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
Return type

dict

Returns

Response Syntax

{
    'DeploymentStatus': 'string',
    'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
    'ErrorDetails': [
        {
            'DetailedErrorCode': 'string',
            'DetailedErrorMessage': 'string'
        },
    ],
    'ErrorMessage': 'string',
    'UpdatedAt': 'string'
}

Response Structure

  • (dict) -- Success. The response body contains the status of the deployment for the group.
    • DeploymentStatus (string) -- The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
    • DeploymentType (string) -- The type of the deployment.
    • ErrorDetails (list) -- Error details
      • (dict) -- Details about the error.
        • DetailedErrorCode (string) -- A detailed error code.
        • DetailedErrorMessage (string) -- A detailed error message.
    • ErrorMessage (string) -- Error message
    • UpdatedAt (string) -- The time, in milliseconds since the epoch, when the deployment status was updated.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException