ListDeployments
Retrieves a paginated list of deployments.
Request Syntax
GET /greengrass/v2/deployments?historyFilter=historyFilter&maxResults=maxResults&nextToken=nextToken&parentTargetArn=parentTargetArn&targetArn=targetArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- historyFilter
-
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_ONLYValid Values:
ALL | LATEST_ONLY -
- maxResults
-
The maximum number of results to be returned per paginated request.
Default:
50Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token to be used for the next set of paginated results.
- parentTargetArn
-
The parent deployment's target ARN within a subdeployment.
Pattern:
arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+ - targetArn
-
The ARN of the target AWS IoT thing or thing group.
Pattern:
arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"deployments": [
{
"creationTimestamp": number,
"deploymentId": "string",
"deploymentName": "string",
"deploymentStatus": "string",
"isLatestForTarget": boolean,
"parentTargetArn": "string",
"revisionId": "string",
"targetArn": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- deployments
-
A list that summarizes each deployment.
Type: Array of Deployment objects
- nextToken
-
The token for the next set of results, or null if there are no additional results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
HTTP Status Code: 403
- InternalServerException
-
AWS IoT Greengrass can't process your request right now. Try again later.
HTTP Status Code: 500
- ThrottlingException
-
Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
