AWS Greengrass
API Reference

/greengrass/groups/GroupId/deployments/DeploymentId/status

GET

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

Operation ID: GetDeploymentStatus

Returns the status of a deployment.

Produces: application/json

Path Parameters

GroupId

The ID of the AWS Greengrass group.

where used: path; required: true

type: string

DeploymentId

The ID of the deployment.

where used: path; required: true

type: string

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" }

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.

type: string

DeploymentType

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 containing 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

On this page: