[ aws . greengrass ]



Returns the status of a deployment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--deployment-id <value>
--group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--deployment-id (string) The ID of the deployment.

--group-id (string) The ID of the Greengrass group.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


To retrieve the status of a deployment

The following get-deployment-status example retrieves the status for the specified deployment of the specified Greengrass group. To get the deployment ID, use the list-deployments command and specify the group ID.

aws greengrass get-deployment-status \
    --group-id "1013db12-8b58-45ff-acc7-704248f66731" \
    --deployment-id "1065b8a0-812b-4f21-9d5d-e89b232a530f"


    "DeploymentStatus": "Success",
    "DeploymentType": "NewDeployment",
    "UpdatedAt": "2019-06-18T17:04:44.761Z"


DeploymentStatus -> (string)

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

DeploymentType -> (string)

The type of the deployment.

ErrorDetails -> (list)

Error details


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.