[ aws . greengrass ]

get-bulk-deployment-status

Description

Returns the status of a bulk deployment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-bulk-deployment-status
--bulk-deployment-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

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

Examples

To check the status of your bulk deployment

The following get-bulk-deployment-status example retrieves status information for the specified bulk deployment operation. In this example, the file that specified the groups to be deployed has an invalid input record.

aws greengrass get-bulk-deployment-status \
    --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267"

Output:

{
    "BulkDeploymentMetrics": {
        "InvalidInputRecords": 1,
        "RecordsProcessed": 1,
        "RetryAttempts": 0
    },
    "BulkDeploymentStatus": "Completed",
    "CreatedAt": "2019-06-25T16:11:33.265Z",
    "tags": {}
}

For more information, see Create Bulk Deployments for Groups in the AWS IoT Greengrass Developer Guide.

Output

BulkDeploymentMetrics -> (structure)

Relevant metrics on input records processed during bulk deployment.

InvalidInputRecords -> (integer)

The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn’t grant permission to deploy a group or group version.

RecordsProcessed -> (integer)

The total number of group records from the input file that have been processed so far, or attempted.

RetryAttempts -> (integer)

The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ‘’StartBulkDeployment’’ retries a group deployment up to five times.

BulkDeploymentStatus -> (string)

The status of the bulk deployment.

CreatedAt -> (string)

The time, in ISO format, when the deployment was created.

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

tags -> (map)

Tag(s) attached to the resource arn.

key -> (string)

value -> (string)