ListEffectiveDeployments - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListEffectiveDeployments

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

Request Syntax

GET /greengrass/v2/coreDevices/coreDeviceThingName/effectiveDeployments?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

coreDeviceThingName

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

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

maxResults

The maximum number of results to be returned per paginated request.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to be used for the next set of paginated results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "effectiveDeployments": [ { "coreDeviceExecutionStatus": "string", "creationTimestamp": number, "deploymentId": "string", "deploymentName": "string", "description": "string", "iotJobArn": "string", "iotJobId": "string", "modifiedTimestamp": number, "reason": "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.

effectiveDeployments

A list that summarizes each deployment on the core device.

Type: Array of EffectiveDeployment 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

Amazon IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

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 Amazon SDKs, see the following: