[ aws . greengrassv2 ]

list-deployments

Description

Retrieves a paginated list of deployments.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-deployments is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: deployments

Synopsis

  list-deployments
[--target-arn <value>]
[--history-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--target-arn (string)

The ARN of the target AWS IoT thing or thing group.

--history-filter (string)

The filter for the list of deployments. Choose one of the following options:

• ALL – The list includes all deployments.

• LATEST_ONLY – The list includes only the latest revision of each deployment.

Default: LATEST_ONLY

Possible values:

• ALL

• LATEST_ONLY

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Examples

To list deployments

The following list-deployments example lists the latest revision of each deployment defined in your AWS account in the current Region.

aws greengrassv2 list-deployments

Output:

{
    "deployments": [
        {
            "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
            "revisionId": "14",
            "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "deploymentName": "Deployment for MyGreengrassCoreGroup",
            "creationTimestamp": "2021-01-07T17:21:20.691000-08:00",
            "deploymentStatus": "ACTIVE",
            "isLatestForTarget": false
        },
        {
            "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore",
            "revisionId": "1",
            "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "deploymentName": "Deployment for MyGreengrassCore",
            "creationTimestamp": "2021-01-06T16:10:42.407000-08:00",
            "deploymentStatus": "COMPLETED",
            "isLatestForTarget": false
        }
    ]
}

For more information, see Deploy components to devices in the AWS IoT Greengrass V2 Developer Guide.

Output

deployments -> (list)

A list that summarizes each deployment.

(structure)

Contains information about a deployment.

targetArn -> (string)

The ARN of the target AWS IoT thing or thing group.

revisionId -> (string)

The revision number of the deployment.

deploymentId -> (string)

The ID of the deployment.

deploymentName -> (string)

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName> , where targetType and targetName are the type and name of the deployment target.

creationTimestamp -> (timestamp)

The time at which the deployment was created, expressed in ISO 8601 format.

deploymentStatus -> (string)

The status of the deployment.

isLatestForTarget -> (boolean)

Whether or not the deployment is the latest revision for its target.

nextToken -> (string)

The token for the next set of results, or null if there are no additional results.