GetDeploymentStatus - Amazon IoT Greengrass
CLI: Parameters: Responses:
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

You are viewing the documentation for Amazon IoT Greengrass Version 1. Amazon IoT Greengrass Version 2 is the latest major version of Amazon IoT Greengrass. For more information about the Amazon IoT Greengrass V2 API, see the Amazon IoT Greengrass Version 2 API Reference.

GetDeploymentStatus

Returns the status of a deployment.

URI: GET /greengrass/groups/GroupId/deployments/DeploymentId/status

Produces: application/json

CLI:

aws greengrass get-deployment-status \
  --group-id <value> \
  --deployment-id <value>  \
  [--cli-input-json <value>] \
  [--generate-cli-skeleton]

cli-input-json format:

{
"GroupId": "string",
"DeploymentId": "string"
}

Parameters:

GroupId

The ID of the Greengrass group.

where used: path; required: true

type: string

DeploymentId

The ID of the deployment.

where used: path; required: true

type: string

Responses:

200

Success. The response body contains the status of the deployment for the group.

GetDeploymentStatusResponse 

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

Information about the status of a deployment for a group.

type: object

DeploymentStatus

The status of the deployment: Building, InProgress, Success, or Failure.

type: string

DeploymentType

The type of deployment. When used for CreateDeployment, only NewDeployment and Redeployment are valid.

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]

UpdatedAt

The time, in milliseconds since the epoch, when the deployment status was updated.

type: string

ErrorMessage

Error message

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

400

Invalid request.

GeneralError 

{
"Message": "string",
"ErrorDetails": [
  {
    "DetailedErrorCode": "string",
    "DetailedErrorMessage": "string"
  }
]
}
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message that contains information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string