AWS IoT Greengrass

(1)

AWS IoT Greengrass

API Reference, Version 2

(2)

AWS IoT Greengrass: API Reference, Version 2

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with AWS IoT Core and export IoT data to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and deploy applications to ﬂeets of edge devices for local operation.

AWS IoT Greengrass Version 2 provides a new major version of the AWS IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the AWS IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is AWS IoT Greengrass? in the AWS IoT Greengrass V2 Developer Guide.

This document was last published on March 6, 2022.

(11)

Actions

The following actions are supported:

• AssociateServiceRoleToAccount (p. 3)

• BatchAssociateClientDeviceWithCoreDevice (p. 5)

• BatchDisassociateClientDeviceFromCoreDevice (p. 8)

• CancelDeployment (p. 11)

• CreateComponentVersion (p. 13)

• CreateDeployment (p. 18)

• DeleteComponent (p. 23)

• DeleteCoreDevice (p. 25)

• DescribeComponent (p. 27)

• DisassociateServiceRoleFromAccount (p. 31)

• GetComponent (p. 33)

• GetComponentVersionArtifact (p. 36)

• GetConnectivityInfo (p. 39)

• GetCoreDevice (p. 41)

• GetDeployment (p. 44)

• GetServiceRoleForAccount (p. 49)

• ListClientDevicesAssociatedWithCoreDevice (p. 51)

• ListComponents (p. 54)

• ListComponentVersions (p. 57)

• ListCoreDevices (p. 60)

• ListDeployments (p. 63)

• ListEﬀectiveDeployments (p. 66)

• ListInstalledComponents (p. 69)

• ListTagsForResource (p. 72)

• ResolveComponentCandidates (p. 74)

• TagResource (p. 77)

• UntagResource (p. 79)

• UpdateConnectivityInfo (p. 81)

(12)

AssociateServiceRoleToAccount

Associates a Greengrass service role with AWS IoT Greengrass for your AWS account in this AWS Region.

AWS IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that deﬁnes equivalent permissions for the AWS IoT Greengrass features that you use. For more information, see Greengrass service role in the AWS IoT Greengrass Version 2 Developer Guide.

Request Syntax

PUT /greengrass/servicerole HTTP/1.1 Content-type: application/json { "RoleArn": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

RoleArn (p. 3)

The Amazon Resource Name (ARN) of the service role to associate with AWS IoT Greengrass for your AWS account in this AWS Region.

Type: String Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"AssociatedAt": "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.

AssociatedAt (p. 3)

The time when the service role was associated with AWS IoT Greengrass for your AWS account in this AWS Region.

(13)

Errors

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 135).

InternalServerException

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

HTTP Status Code: 500 ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

BatchAssociateClientDeviceWithCoreDevice

Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information and certiﬁcates. For more information, see Conﬁgure cloud discovery in the AWS IoT Greengrass V2 Developer Guide.

NoteClient devices are local IoT devices that connect to and communicate with an AWS IoT

Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to AWS IoT Core and interact with client devices in Greengrass components.

For more information, see Interact with local IoT devices in the AWS IoT Greengrass V2 Developer Guide.

Request Syntax

POST /greengrass/v2/coreDevices/coreDeviceThingName/associateClientDevices HTTP/1.1 Content-type: application/json

{

"entries": [ {

"thingName": "string"

} ] }

URI Request Parameters

The request uses the following URI parameters.

coreDeviceThingName (p. 5)

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

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

Required: Yes

Request Body

entries (p. 5)

The list of client devices to associate.

Type: Array of AssociateClientDeviceWithCoreDeviceEntry (p. 85) objects Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Response Syntax

HTTP/1.1 200

(15)

Response Elements

Content-type: application/json { "errorEntries": [

{

"code": "string", "message": "string", "thingName": "string"

} ]}

Response Elements

errorEntries (p. 5)

The list of any errors for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to associate.

Type: Array of AssociateClientDeviceWithCoreDeviceErrorEntry (p. 86) objects Array Members: Minimum number of 1 item. Maximum number of 100 items.

Errors

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403 InternalServerException

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.

(16)

See Also

BatchDisassociateClientDeviceFromCoreDevice

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certiﬁcates.

Request Syntax

POST /greengrass/v2/coreDevices/coreDeviceThingName/disassociateClientDevices HTTP/1.1 Content-type: application/json

{ "entries": [ {

"thingName": "string"

} ]}

URI Request Parameters

Required: Yes

Request Body

entries (p. 8)

The list of client devices to disassociate.

Type: Array of DisassociateClientDeviceFromCoreDeviceEntry (p. 108) objects Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "errorEntries": [

{

"code": "string",

(18)

Response Elements

"message": "string", "thingName": "string"

} ] }

Response Elements

errorEntries (p. 8)

The list of any errors for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to disassociate.

Type: Array of DisassociateClientDeviceFromCoreDeviceErrorEntry (p. 109) objects Array Members: Minimum number of 1 item. Maximum number of 100 items.

Errors

CancelDeployment

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

Request Syntax

POST /greengrass/v2/deployments/deploymentId/cancel HTTP/1.1

URI Request Parameters

deploymentId (p. 11)

The ID of the deployment.

Length Constraints: Minimum length of 1.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "message": "string"

}

Response Elements

message (p. 11)

A message that communicates if the cancel was successful.

Type: String

Errors

(21)

See Also

HTTP Status Code: 403 ConﬂictException

Your request has conﬂicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateComponentVersion

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to AWS IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:

• Create components from recipes

Create a component from a recipe, which is a ﬁle that deﬁnes the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see AWS IoT

Greengrass component recipe reference in the AWS IoT Greengrass V2 Developer Guide.

To create a component from a recipe, specify inlineRecipe when you call this operation.

• Create components from Lambda functions

Create a component from an AWS Lambda function that runs on AWS IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from AWS IoT Greengrass V1 to AWS IoT Greengrass V2.

This function only accepts Lambda functions that use the following runtimes:

• Python 2.7 – python2.7

• Java 8 – java8

• Node.js 10 – nodejs10.x

• Node.js 12 – nodejs12.x

To create a component from a Lambda function, specify lambdaFunction when you call this operation.

NoteAWS IoT Greengrass currently supports Lambda functions on only Linux core devices.

Request Syntax

POST /greengrass/v2/createComponentVersion HTTP/1.1 Content-type: application/json

{ "clientToken": "string", "inlineRecipe": blob, "lambdaFunction": {

"componentDependencies": { "string" : {

"dependencyType": "string", "versionRequirement": "string"

} },

"componentLambdaParameters": { "environmentVariables": { "string" : "string"

},

"eventSources": [ {

"topic": "string",

(23)

URI Request Parameters

"type": "string"

} ],

"execArgs": [ "string" ],

"inputPayloadEncodingType": "string", "linuxProcessParams": {

"containerParams": { "devices": [ {

"addGroupOwner": boolean, "path": "string",

"permission": "string"

} ],

"memorySizeInKB": number, "mountROSysfs": boolean, "volumes": [

{

"addGroupOwner": boolean, "destinationPath": "string", "permission": "string", "sourcePath": "string"

} ] },

"isolationMode": "string"

},

"maxIdleTimeInSeconds": number, "maxInstancesCount": number, "maxQueueSize": number, "pinned": boolean,

"statusTimeoutInSeconds": number, "timeoutInSeconds": number

},

"componentName": "string", "componentPlatforms": [ {

"attributes": { "string" : "string"

},

"name": "string"

} ],

"componentVersion": "string", "lambdaArn": "string"

},

"tags": {

"string" : "string"

} }

URI Request Parameters

Request Body

clientToken (p. 13)

A unique, case-sensitive identiﬁer that you can provide to ensure that the request is idempotent.

Idempotency means that the request is successfully processed only once, even if you send the

(24)

Response Syntax

request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the AWS IoT Greengrass V2 service returns the successful response that it caches from the previous request. AWS IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Required: No inlineRecipe (p. 13)

The recipe to use to create the component. The recipe deﬁnes the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.

You must specify either inlineRecipe or lambdaFunction.

Type: Base64-encoded binary data object Required: No

lambdaFunction (p. 13)

The parameters to create a component from a Lambda function.

You must specify either inlineRecipe or lambdaFunction.

Type: LambdaFunctionRecipeSource (p. 126) object Required: No

tags (p. 13)

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 201

Content-type: application/json { "arn": "string",

"componentName": "string", "componentVersion": "string", "creationTimestamp": number, "status": {

"componentState": "string",

(25)

Response Elements

"errors": {

"string" : "string"

},

"message": "string"

}}

Response Elements

arn (p. 15)

The ARN of the component version.

Type: String

Pattern: arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:

[^:]+:versions:[^:]+

componentName (p. 15)

The name of the component.

Type: String

Pattern: [a-zA-Z0-9-_.]+

componentVersion (p. 15) The version of the component.

Type: String

Pattern: [0-9a-zA-Z-.+]+

creationTimestamp (p. 15)

The time at which the component was created, expressed in ISO 8601 format.

Type: Timestamp status (p. 15)

The status of the component version in AWS IoT Greengrass V2. This status is diﬀerent from the status of the component on a core device.

Type: CloudComponentStatus (p. 88) object

Errors

(26)

See Also

RequestAlreadyInProgressException

The request is already in progress. This exception occurs when you use a client token for multiple requests while AWS IoT Greengrass is still processing an earlier request that uses the same client token.

HTTP Status Code: 400 ServiceQuotaExceededException

Your request exceeds a service quota. For example, you might have the maximum number of components that you can create.

CreateDeployment

Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.

When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.

You can deﬁne one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you deﬁne for a target. Use this operation to create a new revision of an existing deployment.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.

Request Syntax

POST /greengrass/v2/deployments HTTP/1.1 Content-type: application/json

{

"clientToken": "string", "components": {

"string" : {

"componentVersion": "string", "configurationUpdate": { "merge": "string", "reset": [ "string" ] },

"runWith": {

"posixUser": "string", "systemResourceLimits": { "cpus": number,

"memory": number },

"windowsUser": "string"

} } },

"deploymentName": "string", "deploymentPolicies": { "componentUpdatePolicy": { "action": "string", "timeoutInSeconds": number },

"configurationValidationPolicy": { "timeoutInSeconds": number },

"failureHandlingPolicy": "string"

},

"iotJobConfiguration": { "abortConfig": { "criteriaList": [ {

"action": "string", "failureType": "string",

"minNumberOfExecutedThings": number, "thresholdPercentage": number }

] },

(28)

URI Request Parameters

"jobExecutionsRolloutConfig": { "exponentialRate": {

"baseRatePerMinute": number, "incrementFactor": number, "rateIncreaseCriteria": {

"numberOfNotifiedThings": number, "numberOfSucceededThings": number }

},

"maximumPerMinute": number },

"timeoutConfig": {

"inProgressTimeoutInMinutes": number }

},

"tags": {

"string" : "string"

},

"targetArn": "string"

}

URI Request Parameters

Request Body

clientToken (p. 18)

A unique, case-sensitive identiﬁer that you can provide to ensure that the request is idempotent.

Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the AWS IoT Greengrass V2 service returns the successful response that it caches from the previous request. AWS IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Required: No components (p. 18)

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and conﬁguration to deploy for that component.

Type: String to ComponentDeploymentSpeciﬁcation (p. 93) object map Key Length Constraints: Minimum length of 1.

Required: No

deploymentName (p. 18)

The name of the deployment.

Type: String

(29)

Response Syntax

Required: No

deploymentPolicies (p. 18)

The deployment policies for the deployment. These policies deﬁne how the deployment updates components and handles failure.

Type: DeploymentPolicies (p. 107) object Required: No

iotJobConﬁguration (p. 18)

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Type: DeploymentIoTJobConﬁguration (p. 106) object Required: No

tags (p. 18)

Required: No targetArn (p. 18)

The ARN of the target AWS IoT thing or thing group.

Type: String

Pattern: arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:(thing|thinggroup)/.+

Required: Yes

Response Syntax

HTTP/1.1 201

Content-type: application/json { "deploymentId": "string", "iotJobArn": "string", "iotJobId": "string"

}

Response Elements

(30)

Errors

Type: String

iotJobArn (p. 20)

The ARN of the AWS IoT job that applies the deployment to target devices.

Type: String

Pattern: arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:job/.+

iotJobId (p. 20)

The ID of the AWS IoT job that applies the deployment to target devices.

Type: String

Errors

RequestAlreadyInProgressException

The request is already in progress. This exception occurs when you use a client token for multiple requests while AWS IoT Greengrass is still processing an earlier request that uses the same client token.

(31)

See Also

ValidationException

DeleteComponent

Deletes a version of a component from AWS IoT Greengrass.

NoteThis operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.

Request Syntax

DELETE /greengrass/v2/components/arn HTTP/1.1

URI Request Parameters

arn (p. 23)

Required: Yes

Request Body

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

(33)

See Also

DeleteCoreDevice

Deletes a Greengrass core device, which is an AWS IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more information about how to delete the AWS IoT thing, see DeleteThing in the AWS IoT API Reference.

Request Syntax

DELETE /greengrass/v2/coreDevices/coreDeviceThingName HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

(35)

See Also

DescribeComponent

Retrieves metadata for a version of a component.

Request Syntax

GET /greengrass/v2/components/arn/metadata HTTP/1.1

URI Request Parameters

arn (p. 27)

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"arn": "string",

"componentName": "string", "componentVersion": "string", "creationTimestamp": number, "description": "string", "platforms": [

{

"attributes": { "string" : "string"

},

"name": "string"

} ],

"publisher": "string", "status": {

"componentState": "string", "errors": {

},

"message": "string"

},

"tags": {

}}

(37)

Response Elements

arn (p. 27)

Type: String

componentName (p. 27)

The name of the component.

Type: String

Pattern: [a-zA-Z0-9-_.]+

componentVersion (p. 27) The version of the component.

Type: String

Pattern: [0-9a-zA-Z-.+]+

The time at which the component was created, expressed in ISO 8601 format.

Type: Timestamp description (p. 27)

The description of the component version.

Type: String platforms (p. 27)

The platforms that the component version supports.

Type: Array of ComponentPlatform (p. 96) objects publisher (p. 27)

The publisher of the component version.

Type: String status (p. 27)

The status of the component version in AWS IoT Greengrass V2. This status is diﬀerent from the status of the component on a core device.

Type: CloudComponentStatus (p. 88) object

(38)

Errors

tags (p. 27)

Errors

DisassociateServiceRoleFromAccount

Disassociates the Greengrass service role from AWS IoT Greengrass for your AWS account in this AWS Region. Without a service role, AWS IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the AWS IoT Greengrass Version 2 Developer Guide.

Request Syntax

DELETE /greengrass/servicerole HTTP/1.1

URI Request Parameters

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "DisassociatedAt": "string"

}

Response Elements

DisassociatedAt (p. 31)

The time when the service role was disassociated from AWS IoT Greengrass for your AWS account in this AWS Region.

Type: String

Errors

(41)

See Also

GetComponent

Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.

Request Syntax

GET /greengrass/v2/components/arn?recipeOutputFormat=recipeOutputFormat HTTP/1.1

URI Request Parameters

arn (p. 33)

Required: Yes

recipeOutputFormat (p. 33) The format of the recipe.

Valid Values: JSON | YAML

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "recipe": blob,

"recipeOutputFormat": "string", "tags": {

}}

Response Elements

recipe (p. 33)

The recipe of the component version.

(43)

Errors

Type: Base64-encoded binary data object recipeOutputFormat (p. 33)

The format of the recipe.

Type: String

Valid Values: JSON | YAML tags (p. 33)

Errors

GetComponentVersionArtifact

Gets the pre-signed URL to download a public component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

Request Syntax

GET /greengrass/v2/components/arn/artifacts/artifactName+ HTTP/1.1

URI Request Parameters

arn (p. 36)

The ARN of the component version. Specify the ARN of a public component version.

Required: Yes artifactName (p. 36)

The name of the artifact.

You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"preSignedUrl": "string"

}

Response Elements

(46)

Errors

preSignedUrl (p. 36) The URL of the artifact.

Type: String

Errors

GetConnectivityInfo

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the AWS IoT Greengrass discovery API, AWS IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the AWS IoT Greengrass Version 2 Developer Guide.

Request Syntax

GET /greengrass/things/thingName/connectivityInfo HTTP/1.1

URI Request Parameters

thingName (p. 39)

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ConnectivityInfo": [ {

"HostAddress": "string", "Id": "string",

"Metadata": "string", "PortNumber": number }

],

"Message": "string"

}

Response Elements

(49)

Errors

ConnectivityInfo (p. 39)

The connectivity information for the core device.

Type: Array of ConnectivityInfo (p. 100) objects Message (p. 39)

A message about the connectivity information request.

Type: String

Errors

GetCoreDevice

Retrieves metadata for a Greengrass core device.

Request Syntax

GET /greengrass/v2/coreDevices/coreDeviceThingName HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"architecture": "string", "coreDeviceThingName": "string", "coreVersion": "string",

"lastStatusUpdateTimestamp": number, "platform": "string",

"status": "string", "tags": {

}}

Response Elements

architecture (p. 41)

The computer architecture of the core device.

Type: String

(51)

Errors

Type: String

coreVersion (p. 41)

The version of the AWS IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.

Type: String

lastStatusUpdateTimestamp (p. 41)

The time at which the core device's status last updated, expressed in ISO 8601 format.

Type: Timestamp platform (p. 41)

The operating system platform that the core device runs.

Type: String

status (p. 41)

The status of the core device. The core device status can be:

• HEALTHY – The AWS IoT Greengrass Core software and all components run on the core device without issue.

• UNHEALTHY – The AWS IoT Greengrass Core software or a component is in a failed state on the core device.

Type: String

Valid Values: HEALTHY | UNHEALTHY tags (p. 41)

Errors

(52)

See Also

GetDeployment

Gets a deployment. Deployments deﬁne the components that run on Greengrass core devices.

Request Syntax

GET /greengrass/v2/deployments/deploymentId HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"components": { "string" : {

"componentVersion": "string", "configurationUpdate": { "merge": "string", "reset": [ "string" ] },

"runWith": {

"posixUser": "string", "systemResourceLimits": { "cpus": number,

"memory": number },

"windowsUser": "string"

} } },

"creationTimestamp": number, "deploymentId": "string", "deploymentName": "string", "deploymentPolicies": { "componentUpdatePolicy": { "action": "string",

"timeoutInSeconds": number },

"configurationValidationPolicy": { "timeoutInSeconds": number

(54)

Response Elements

},

"failureHandlingPolicy": "string"

},

"deploymentStatus": "string", "iotJobArn": "string",

"iotJobConfiguration": { "abortConfig": { "criteriaList": [ {

"action": "string", "failureType": "string",

"minNumberOfExecutedThings": number, "thresholdPercentage": number }

] },

"jobExecutionsRolloutConfig": { "exponentialRate": {

"baseRatePerMinute": number, "incrementFactor": number, "rateIncreaseCriteria": {

"numberOfNotifiedThings": number, "numberOfSucceededThings": number }

},

"maximumPerMinute": number },

"timeoutConfig": {

"inProgressTimeoutInMinutes": number }

},

"iotJobId": "string",

"isLatestForTarget": boolean, "revisionId": "string", "tags": {

},

"targetArn": "string"

}

Response Elements

components (p. 44)

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and conﬁguration to deploy for that component.

Type: String to ComponentDeploymentSpeciﬁcation (p. 93) object map Key Length Constraints: Minimum length of 1.

The time at which the deployment was created, expressed in ISO 8601 format.

Type: Timestamp deploymentId (p. 44)

AWS IoT Greengrass

AWS IoT Greengrass

API Reference, Version 2

AWS IoT Greengrass: API Reference, Version 2

Table of Contents

Welcome

Actions

AssociateServiceRoleToAccount

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

BatchAssociateClientDeviceWithCoreDevice

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

BatchDisassociateClientDeviceFromCoreDevice

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CancelDeployment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateComponentVersion

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateDeployment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteComponent

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteCoreDevice

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DescribeComponent

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DisassociateServiceRoleFromAccount