Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . greengrass ]

get-deployment-status

Description

Returns the status of a deployment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

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

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Examples

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"

Output:

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

Output

DeploymentStatus -> (string)

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

DeploymentType -> (string)

The type of the deployment.

ErrorDetails -> (list)

Error details

(structure)

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.