AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
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.
{ "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, orFailure.type: string
- DeploymentType
-
The type of deployment. When used for
CreateDeployment, onlyNewDeploymentandRedeploymentare 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.
{ "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
