AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/bulk/deployments/BulkDeploymentId/detailed-reports
GET
GET
/greengrass/bulk/deployments/BulkDeploymentId/detailed-reports
Operation ID: ListBulkDeploymentDetailedReports
Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
Produces: application/json
Path Parameters
- BulkDeploymentId
-
The ID of the bulk deployment.
where used: path; required: true
type: string
Query Parameters
- MaxResults
-
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
CLI
aws greengrass list-bulk-deployment-detailed-reports \ --bulk-deployment-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"BulkDeploymentId": "string",
"MaxResults": "integer",
"NextToken": "string"
}Responses
- 200
-
Success. The response body contains the list of deployments for the given group.
ListBulkDeploymentDetailedReportsResponse
{ "Deployments": [ { "DeploymentId": "string", "DeploymentArn": "string", "GroupArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string", "DeploymentStatus": "string", "ErrorMessage": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] } ], "NextToken": "string" }- ListBulkDeploymentDetailedReportsResponse
-
type: object
- Deployments
-
type: array
items: BulkDeploymentResult
- BulkDeploymentResult
-
Information about an individual group deployment in a bulk deployment operation.
type: object
- DeploymentId
-
The ID of the group deployment.
type: string
- DeploymentArn
-
The ARN of the group deployment.
type: string
- GroupArn
-
The ARN of the Greengrass group.
type: string
- DeploymentType
-
The type of deployment. When used for
CreateDeployment, onlyNewDeploymentandRedeploymentare valid.type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
- CreatedAt
-
The time, in ISO format, when the deployment was created.
type: string
- DeploymentStatus
-
The current status of the group deployment: `
Building, `InProgress,Success, orFailure``.type: string
- ErrorMessage
-
The error message for a failed deployment.
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
- NextToken
-
The token for the next set of results, or
nullif there are no more results.in: query
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
