You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 API Reference.
GetBulkDeploymentStatus
Returns the status of a bulk deployment.
URI: GET
/greengrass/bulk/deployments/
BulkDeploymentId
/status
Produces: application/json
CLI:
aws greengrass get-bulk-deployment-status \ --bulk-deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "BulkDeploymentId": "string" }
Parameters:
- BulkDeploymentId
-
The ID of the bulk deployment.
where used: path; required: true
type: string
Responses:
- 200
-
Success. The response body contains the status of the bulk deployment.
GetBulkDeploymentStatusResponse
{ "BulkDeploymentStatus": "Initializing|Running|Completed|Stopping|Stopped|Failed", "BulkDeploymentMetrics": { "RecordsProcessed": 0, "InvalidInputRecords": 0, "RetryAttempts": 0 }, "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "CreatedAt": "string", "ErrorMessage": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
- GetBulkDeploymentStatusResponse
-
Information about the status of a bulk deployment at the time of the request.
type: object
- BulkDeploymentStatus
-
The current status of the bulk deployment.
type: string
enum: ["Initializing", "Running", "Completed", "Stopping", "Stopped", "Failed"]
- BulkDeploymentMetrics
-
Relevant metrics on input records processed during bulk deployment.
type: object
- RecordsProcessed
-
The total number of group records from the input file that have been processed or attempted so far.
type: integer
- InvalidInputRecords
-
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.
type: integer
- RetryAttempts
-
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.type: integer
- tags
-
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
- CreatedAt
-
The time, in ISO format, when the deployment was created.
type: string
- ErrorMessage
-
Error message
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string