[ aws . greengrassv2 ]

list-effective-deployments

Description

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-effective-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: effectiveDeployments

Synopsis

  list-effective-deployments
--core-device-thing-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--core-device-thing-name (string)

The name of the core device. This is also the name of the IoT thing.

--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 deployment jobs

The following list-effective-deployments example lists the deployments that apply to an AWS IoT Greengrass core device.

aws greengrassv2 list-effective-deployments \
    --core-device-thing-name MyGreengrassCore

Output:

{
    "effectiveDeployments": [
        {
            "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "deploymentName": "Deployment for MyGreengrassCore",
            "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore",
            "coreDeviceExecutionStatus": "COMPLETED",
            "reason": "SUCCESSFUL",
            "creationTimestamp": "2021-01-06T16:10:42.442000-08:00",
            "modifiedTimestamp": "2021-01-08T17:21:27.830000-08:00"
        },
        {
            "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "deploymentName": "Deployment for MyGreengrassCoreGroup",
            "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup",
            "coreDeviceExecutionStatus": "SUCCEEDED",
            "reason": "SUCCESSFUL",
            "creationTimestamp": "2021-01-07T17:19:20.394000-08:00",
            "modifiedTimestamp": "2021-01-07T17:21:20.721000-08:00"
        }
    ]
}

For more information, see Check core device status in the AWS IoT Greengrass V2 Developer Guide.

Output

effectiveDeployments -> (list)

A list that summarizes each deployment on the core device.

(structure)

Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

deploymentId -> (string)

The ID of the deployment.

deploymentName -> (string)

The name of the deployment.

iotJobId -> (string)

The ID of the IoT job that applies the deployment to target devices.

iotJobArn -> (string)

The ARN of the IoT job that applies the deployment to target devices.

description -> (string)

The description of the deployment job.

targetArn -> (string)

The ARN of the target IoT thing or thing group.

coreDeviceExecutionStatus -> (string)

The status of the deployment job on the Greengrass core device.

reason -> (string)

The reason code for the update, if the job was updated.

creationTimestamp -> (timestamp)

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

modifiedTimestamp -> (timestamp)

The time at which the deployment job was last modified, expressed in ISO 8601 format.

nextToken -> (string)

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