2020/12/15 - AWS IoT Greengrass V2 - 20 new api methods
Changes Update greengrassv2 client to latest version
Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices.
See also: AWS API Documentation
Request Syntax
client.list_effective_deployments(
coreDeviceThingName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the core device. This is also the name of the AWS IoT thing.
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'effectiveDeployments': [
{
'deploymentId': 'string',
'deploymentName': 'string',
'iotJobId': 'string',
'iotJobArn': 'string',
'description': 'string',
'targetArn': 'string',
'coreDeviceExecutionStatus': 'IN_PROGRESS'|'QUEUED'|'FAILED'|'COMPLETED'|'TIMED_OUT'|'CANCELED'|'REJECTED',
'reason': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'modifiedTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
effectiveDeployments (list) --
A list that summarizes each deployment on the core device.
(dict) --
Contains information about a deployment job that AWS IoT Greengrass sends to a AWS IoT Greengrass core device.
deploymentId (string) --
The ID of the deployment.
deploymentName (string) --
The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
iotJobId (string) --
The ID of the AWS IoT job that applies the deployment to target devices.
iotJobArn (string) --
The ARN of the AWS IoT job that applies the deployment to target devices.
description (string) --
The description of the deployment job.
targetArn (string) --
The ARN of the target AWS IoT thing or thing group.
coreDeviceExecutionStatus (string) --
The status of the deployment job on the AWS IoT Greengrass core device.
reason (string) --
The reason code for the update, if the job was updated.
creationTimestamp (datetime) --
The time at which the deployment was created, expressed in ISO 8601 format.
modifiedTimestamp (datetime) --
The time at which the deployment job was last modified, expressed in ISO 8601 format.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves metadata for a AWS IoT Greengrass core device.
See also: AWS API Documentation
Request Syntax
client.get_core_device(
coreDeviceThingName='string'
)
string
[REQUIRED]
The name of the core device. This is also the name of the AWS IoT thing.
dict
Response Syntax
{
'coreDeviceThingName': 'string',
'coreVersion': 'string',
'platform': 'string',
'architecture': 'string',
'status': 'HEALTHY'|'UNHEALTHY',
'lastStatusUpdateTimestamp': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
coreDeviceThingName (string) --
The name of the core device. This is also the name of the AWS IoT thing.
coreVersion (string) --
The version of the AWS IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the AWS IoT Greengrass nucleus component that runs on the core device. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
platform (string) --
The operating system platform that the core device runs.
architecture (string) --
The computer architecture of the core device.
status (string) --
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.
lastStatusUpdateTimestamp (datetime) --
The time at which the core device's status last updated, expressed in ISO 8601 format.
tags (dict) --
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.
(string) --
(string) --
Deletes a AWS IoT 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.
See also: AWS API Documentation
Request Syntax
client.delete_core_device(
coreDeviceThingName='string'
)
string
[REQUIRED]
The name of the core device. This is also the name of the AWS IoT thing.
None
Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
deploymentId='string'
)
string
[REQUIRED]
The ID of the deployment.
dict
Response Syntax
{
'targetArn': 'string',
'revisionId': 'string',
'deploymentId': 'string',
'deploymentName': 'string',
'deploymentStatus': 'ACTIVE'|'COMPLETED'|'CANCELED'|'FAILED'|'INACTIVE',
'iotJobId': 'string',
'iotJobArn': 'string',
'components': {
'string': {
'componentVersion': 'string',
'configurationUpdate': {
'merge': 'string',
'reset': [
'string',
]
},
'runWith': {
'posixUser': 'string'
}
}
},
'deploymentPolicies': {
'failureHandlingPolicy': 'ROLLBACK'|'DO_NOTHING',
'componentUpdatePolicy': {
'timeoutInSeconds': 123,
'action': 'NOTIFY_COMPONENTS'|'SKIP_NOTIFY_COMPONENTS'
},
'configurationValidationPolicy': {
'timeoutInSeconds': 123
}
},
'iotJobConfiguration': {
'jobExecutionsRolloutConfig': {
'exponentialRate': {
'baseRatePerMinute': 123,
'incrementFactor': 123.0,
'rateIncreaseCriteria': {
'numberOfNotifiedThings': 123,
'numberOfSucceededThings': 123
}
},
'maximumPerMinute': 123
},
'abortConfig': {
'criteriaList': [
{
'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
'action': 'CANCEL',
'thresholdPercentage': 123.0,
'minNumberOfExecutedThings': 123
},
]
},
'timeoutConfig': {
'inProgressTimeoutInMinutes': 123
}
},
'creationTimestamp': datetime(2015, 1, 1),
'isLatestForTarget': True|False,
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
targetArn (string) --
The ARN of the target AWS IoT thing or thing group.
revisionId (string) --
The revision number of the deployment.
deploymentId (string) --
The ID of the deployment.
deploymentName (string) --
The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
deploymentStatus (string) --
The status of the deployment.
iotJobId (string) --
The ID of the AWS IoT job that applies the deployment to target devices.
iotJobArn (string) --
The ARN of the AWS IoT job that applies the deployment to target devices.
components (dict) --
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 configuration to deploy for that component.
(string) --
(dict) --
Contains information about a component to deploy.
componentVersion (string) --
The version of the component.
configurationUpdate (dict) --
The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide.
merge (string) --
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the AWS IoT Greengrass V2 Developer Guide.
reset (list) --
The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash ( /) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the AWS IoT Greengrass V2 Developer Guide.
(string) --
runWith (dict) --
The system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the AWS IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide.
posixUser (string) --
The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon ( :) in the following format: user:group. The group is optional. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group.
deploymentPolicies (dict) --
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
failureHandlingPolicy (string) --
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
componentUpdatePolicy (dict) --
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.
timeoutInSeconds (integer) --
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
action (string) --
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
configurationValidationPolicy (dict) --
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
timeoutInSeconds (integer) --
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
iotJobConfiguration (dict) --
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
jobExecutionsRolloutConfig (dict) --
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
exponentialRate (dict) --
The exponential rate to increase the job rollout rate.
baseRatePerMinute (integer) --
The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.
incrementFactor (float) --
The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example, you can specify 1.5, but not 1.55).
rateIncreaseCriteria (dict) --
The criteria to increase the rollout rate for the job.
numberOfNotifiedThings (integer) --
The number of devices to receive the job notification before the rollout rate increases.
numberOfSucceededThings (integer) --
The number of devices to successfully run the configuration job before the rollout rate increases.
maximumPerMinute (integer) --
The maximum number of devices that receive a pending job notification, per minute.
abortConfig (dict) --
The stop configuration for the job. This configuration defines when and how to stop a job rollout.
criteriaList (list) --
The list of criteria that define when and how to cancel the configuration deployment.
(dict) --
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
The number of things that receive the deployment exceeds the minNumberOfExecutedThings.
The percentage of failures with type failureType exceeds the thresholdPercentage.
failureType (string) --
The type of job deployment failure that can cancel a job.
action (string) --
The action to perform when the criteria are met.
thresholdPercentage (float) --
The minimum percentage of failureType failures that occur before the job can cancel.
This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).
minNumberOfExecutedThings (integer) --
The minimum number of things that receive the configuration before the job can cancel.
timeoutConfig (dict) --
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
inProgressTimeoutInMinutes (integer) --
The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to IN_PROGRESS. If the job status doesn't change to a terminal state before the time expires, then the job status is set to TIMED_OUT.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
creationTimestamp (datetime) --
The time at which the deployment was created, expressed in ISO 8601 format.
isLatestForTarget (boolean) --
Whether or not the deployment is the latest revision for its target.
tags (dict) --
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.
(string) --
(string) --
Retrieves a paginated list of component summaries. This list includes components that you have permission to view.
See also: AWS API Documentation
Request Syntax
client.list_components(
scope='PRIVATE'|'PUBLIC',
maxResults=123,
nextToken='string'
)
string
The scope of the components to list.
Default: PRIVATE
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'components': [
{
'arn': 'string',
'componentName': 'string',
'latestVersion': {
'arn': 'string',
'componentVersion': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'description': 'string',
'publisher': 'string',
'platforms': [
{
'name': 'string',
'attributes': {
'string': 'string'
}
},
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
components (list) --
A list that summarizes each component.
(dict) --
Contains information about a component.
arn (string) --
The ARN of the component version.
componentName (string) --
The name of the component.
latestVersion (dict) --
The latest version of the component and its details.
arn (string) --
The ARN of the component version.
componentVersion (string) --
The version of the component.
creationTimestamp (datetime) --
The time at which the component was created, expressed in ISO 8601 format.
description (string) --
The description of the component version.
publisher (string) --
The publisher of the component version.
platforms (list) --
The platforms that the component version supports.
(dict) --
Contains information about a platform that a component supports.
name (string) --
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and architecture of the platform.
attributes (dict) --
A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
(string) --
(string) --
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Creates a continuous deployment for a target, which is a AWS IoT 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 define 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 define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_deployment(
targetArn='string',
deploymentName='string',
components={
'string': {
'componentVersion': 'string',
'configurationUpdate': {
'merge': 'string',
'reset': [
'string',
]
},
'runWith': {
'posixUser': 'string'
}
}
},
iotJobConfiguration={
'jobExecutionsRolloutConfig': {
'exponentialRate': {
'baseRatePerMinute': 123,
'incrementFactor': 123.0,
'rateIncreaseCriteria': {
'numberOfNotifiedThings': 123,
'numberOfSucceededThings': 123
}
},
'maximumPerMinute': 123
},
'abortConfig': {
'criteriaList': [
{
'failureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
'action': 'CANCEL',
'thresholdPercentage': 123.0,
'minNumberOfExecutedThings': 123
},
]
},
'timeoutConfig': {
'inProgressTimeoutInMinutes': 123
}
},
deploymentPolicies={
'failureHandlingPolicy': 'ROLLBACK'|'DO_NOTHING',
'componentUpdatePolicy': {
'timeoutInSeconds': 123,
'action': 'NOTIFY_COMPONENTS'|'SKIP_NOTIFY_COMPONENTS'
},
'configurationValidationPolicy': {
'timeoutInSeconds': 123
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the target AWS IoT thing or thing group.
string
The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
dict
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 configuration to deploy for that component.
(string) --
(dict) --
Contains information about a component to deploy.
componentVersion (string) --
The version of the component.
configurationUpdate (dict) --
The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide.
merge (string) --
A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see Merge configuration updates in the AWS IoT Greengrass V2 Developer Guide.
reset (list) --
The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash ( /) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the AWS IoT Greengrass V2 Developer Guide.
(string) --
runWith (dict) --
The system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the AWS IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide.
posixUser (string) --
The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon ( :) in the following format: user:group. The group is optional. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group.
dict
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
jobExecutionsRolloutConfig (dict) --
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
exponentialRate (dict) --
The exponential rate to increase the job rollout rate.
baseRatePerMinute (integer) -- [REQUIRED]
The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.
incrementFactor (float) -- [REQUIRED]
The exponential factor to increase the rollout rate for the job.
This parameter supports up to one digit after the decimal (for example, you can specify 1.5, but not 1.55).
rateIncreaseCriteria (dict) -- [REQUIRED]
The criteria to increase the rollout rate for the job.
numberOfNotifiedThings (integer) --
The number of devices to receive the job notification before the rollout rate increases.
numberOfSucceededThings (integer) --
The number of devices to successfully run the configuration job before the rollout rate increases.
maximumPerMinute (integer) --
The maximum number of devices that receive a pending job notification, per minute.
abortConfig (dict) --
The stop configuration for the job. This configuration defines when and how to stop a job rollout.
criteriaList (list) -- [REQUIRED]
The list of criteria that define when and how to cancel the configuration deployment.
(dict) --
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
The number of things that receive the deployment exceeds the minNumberOfExecutedThings.
The percentage of failures with type failureType exceeds the thresholdPercentage.
failureType (string) -- [REQUIRED]
The type of job deployment failure that can cancel a job.
action (string) -- [REQUIRED]
The action to perform when the criteria are met.
thresholdPercentage (float) -- [REQUIRED]
The minimum percentage of failureType failures that occur before the job can cancel.
This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).
minNumberOfExecutedThings (integer) -- [REQUIRED]
The minimum number of things that receive the configuration before the job can cancel.
timeoutConfig (dict) --
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
inProgressTimeoutInMinutes (integer) --
The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to IN_PROGRESS. If the job status doesn't change to a terminal state before the time expires, then the job status is set to TIMED_OUT.
The timeout interval must be between 1 minute and 7 days (10080 minutes).
dict
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
failureHandlingPolicy (string) --
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
componentUpdatePolicy (dict) --
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.
timeoutInSeconds (integer) --
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60
action (string) --
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
configurationValidationPolicy (dict) --
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
timeoutInSeconds (integer) --
The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.
Default: 30
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'deploymentId': 'string',
'iotJobId': 'string',
'iotJobArn': 'string'
}
Response Structure
(dict) --
deploymentId (string) --
The ID of the deployment.
iotJobId (string) --
The ID of the AWS IoT job that applies the deployment to target devices.
iotJobArn (string) --
The ARN of the AWS IoT job that applies the deployment to target devices.
Gets the pre-signed URL to a component artifact in an S3 bucket. Core devices can call this operation to identify the URL that they can use to download an artifact to install.
See also: AWS API Documentation
Request Syntax
client.get_component_version_artifact(
arn='string',
artifactName='string'
)
string
[REQUIRED]
The ARN of the component version.
string
[REQUIRED]
The name of the artifact.
dict
Response Syntax
{
'preSignedUrl': 'string'
}
Response Structure
(dict) --
preSignedUrl (string) --
The URL to the artifact.
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.
See also: AWS API Documentation
Request Syntax
client.cancel_deployment(
deploymentId='string'
)
string
[REQUIRED]
The ID of the deployment.
dict
Response Syntax
{
'message': 'string'
}
Response Structure
(dict) --
message (string) --
A message that communicates if the cancel was successful.
Retrieves a list of components that meet the component, version, and platform requirements of a deployment. AWS IoT Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.
See also: AWS API Documentation
Request Syntax
client.resolve_component_candidates(
platform={
'name': 'string',
'attributes': {
'string': 'string'
}
},
componentCandidates=[
{
'componentName': 'string',
'componentVersion': 'string',
'versionRequirements': {
'string': 'string'
}
},
]
)
dict
[REQUIRED]
The platform to use to resolve compatible components.
name (string) --
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and architecture of the platform.
attributes (dict) --
A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
(string) --
(string) --
list
[REQUIRED]
The list of components to resolve.
(dict) --
Contains information about a component that is a candidate to deploy to a AWS IoT Greengrass core device.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
versionRequirements (dict) --
The version requirements for the component's dependencies. AWS IoT Greengrass core devices get the version requirements from component recipes.
AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
(string) --
(string) --
dict
Response Syntax
{
'resolvedComponentVersions': [
{
'arn': 'string',
'componentName': 'string',
'componentVersion': 'string',
'recipe': b'bytes'
},
]
}
Response Structure
(dict) --
resolvedComponentVersions (list) --
A list of components that meet the requirements that you specify in the request. This list includes each component's recipe that you can use to install the component.
(dict) --
Contains information about a component version that is compatible to run on a AWS IoT Greengrass core device.
arn (string) --
The ARN of the component version.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
recipe (bytes) --
The recipe of the component version.
Creates a component. Components are software that run on AWS IoT 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 file that defines 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
Python 3.7 – python3.7
Python 3.8 – python3.8
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.
See also: AWS API Documentation
Request Syntax
client.create_component_version(
inlineRecipe=b'bytes',
lambdaFunction={
'lambdaArn': 'string',
'componentName': 'string',
'componentVersion': 'string',
'componentPlatforms': [
{
'name': 'string',
'attributes': {
'string': 'string'
}
},
],
'componentDependencies': {
'string': {
'versionRequirement': 'string',
'dependencyType': 'HARD'|'SOFT'
}
},
'componentLambdaParameters': {
'eventSources': [
{
'topic': 'string',
'type': 'PUB_SUB'|'IOT_CORE'
},
],
'maxQueueSize': 123,
'maxInstancesCount': 123,
'maxIdleTimeInSeconds': 123,
'timeoutInSeconds': 123,
'statusTimeoutInSeconds': 123,
'pinned': True|False,
'inputPayloadEncodingType': 'json'|'binary',
'execArgs': [
'string',
],
'environmentVariables': {
'string': 'string'
},
'linuxProcessParams': {
'isolationMode': 'GreengrassContainer'|'NoContainer',
'containerParams': {
'memorySizeInKB': 123,
'mountROSysfs': True|False,
'volumes': [
{
'sourcePath': 'string',
'destinationPath': 'string',
'permission': 'ro'|'rw',
'addGroupOwner': True|False
},
],
'devices': [
{
'path': 'string',
'permission': 'ro'|'rw',
'addGroupOwner': True|False
},
]
}
}
}
},
tags={
'string': 'string'
}
)
bytes
The recipe to use to create the component. The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.
You must specify either inlineRecipe or lambdaFunction.
dict
The parameters to create a component from a Lambda function.
You must specify either inlineRecipe or lambdaFunction.
lambdaArn (string) -- [REQUIRED]
The ARN of the Lambda function. The ARN must include the version of the function to import. You can't use version aliases like $LATEST.
componentName (string) --
The name of the component.
Defaults to the name of the Lambda function.
componentVersion (string) --
The version of the component.
Defaults to the version of the Lambda function as a semantic version. For example, if your function version is 3, the component version becomes 3.0.0.
componentPlatforms (list) --
The platforms that the component version supports.
(dict) --
Contains information about a platform that a component supports.
name (string) --
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and architecture of the platform.
attributes (dict) --
A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
(string) --
(string) --
componentDependencies (dict) --
The component versions on which this Lambda function component depends.
(string) --
(dict) --
Contains information about a component dependency for a Lambda function component.
versionRequirement (string) --
The component version requirement for the component dependency.
AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
dependencyType (string) --
The type of this dependency. Choose from the following options:
SOFT – The component doesn't restart if the dependency changes state.
HARD – The component restarts if the dependency changes state.
Default: HARD
componentLambdaParameters (dict) --
The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device.
eventSources (list) --
The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages.
(dict) --
Contains information about an event source for an AWS Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.
topic (string) -- [REQUIRED]
The topic to which to subscribe to receive event messages.
type (string) -- [REQUIRED]
The type of event source. Choose from the following options:
PUB_SUB – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards ( + and #) in the event source topic.
IOT_CORE – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards ( + and #) in the event source topic.
maxQueueSize (integer) --
The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
maxInstancesCount (integer) --
The maximum number of instances that a non-pinned Lambda function can run at the same time.
maxIdleTimeInSeconds (integer) --
The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process.
timeoutInSeconds (integer) --
The maximum amount of time in seconds that the Lambda function can process a work item.
statusTimeoutInSeconds (integer) --
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
pinned (boolean) --
Whether or not the Lambda function is pinned, or long-lived.
A pinned Lambda function starts when AWS IoT Greengrass starts and keeps running in its own container.
A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function.
Default: true
inputPayloadEncodingType (string) --
The encoding type that the Lambda function supports.
Default: json
execArgs (list) --
The list of arguments to pass to the Lambda function when it runs.
(string) --
environmentVariables (dict) --
The map of environment variables that are available to the Lambda function when it runs.
(string) --
(string) --
linuxProcessParams (dict) --
The parameters for the Linux process that contains the Lambda function.
isolationMode (string) --
The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container.
Default: GreengrassContainer
containerParams (dict) --
The parameters for the container in which the Lambda function runs.
memorySizeInKB (integer) --
The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
mountROSysfs (boolean) --
Whether or not the container can read information from the device's /sys folder.
Default: false
volumes (list) --
The list of volumes that the container can access.
(dict) --
Contains information about a volume that Linux processes in a container can access. When you define a volume, the AWS IoT Greengrass Core software mounts the source files to the destination inside the container.
sourcePath (string) -- [REQUIRED]
The path to the physical volume in the file system.
destinationPath (string) -- [REQUIRED]
The path to the logical volume in the file system.
permission (string) --
The permission to access the volume: read/only ( ro) or read/write ( rw).
Default: ro
addGroupOwner (boolean) --
Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.
Default: false
devices (list) --
The list of system devices that the container can access.
(dict) --
Contains information about a device that Linux processes in a container can access.
path (string) -- [REQUIRED]
The mount path for the device in the file system.
permission (string) --
The permission to access the device: read/only ( ro) or read/write ( rw).
Default: ro
addGroupOwner (boolean) --
Whether or not to add the component's system user as an owner of the device.
Default: false
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'componentName': 'string',
'componentVersion': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'status': {
'componentState': 'REQUESTED'|'INITIATED'|'DEPLOYABLE'|'FAILED'|'DEPRECATED',
'message': 'string',
'errors': {
'string': 'string'
}
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the component version.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
creationTimestamp (datetime) --
The time at which the component was created, expressed in ISO 8601 format.
status (dict) --
The status of the component version in AWS IoT Greengrass V2. This status is different from the status of the component on a core device.
componentState (string) --
The state of the component.
message (string) --
A message that communicates details, such as errors, about the status of the component.
errors (dict) --
A dictionary of errors that communicate why the component is in an error state. For example, if AWS IoT Greengrass can't access an artifact for the component, then errors contains the artifact's URI as a key, and the error message as the value for that key.
(string) --
(string) --
Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to tag.
dict
[REQUIRED]
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.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.
See also: AWS API Documentation
Request Syntax
client.list_installed_components(
coreDeviceThingName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the core device. This is also the name of the AWS IoT thing.
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'installedComponents': [
{
'componentName': 'string',
'componentVersion': 'string',
'lifecycleState': 'NEW'|'INSTALLED'|'STARTING'|'RUNNING'|'STOPPING'|'ERRORED'|'BROKEN'|'FINISHED',
'lifecycleStateDetails': 'string',
'isRoot': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
installedComponents (list) --
A list that summarizes each component on the core device.
(dict) --
Contains information about a component on a AWS IoT Greengrass core device.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
lifecycleState (string) --
The lifecycle state of the component.
lifecycleStateDetails (string) --
The details about the lifecycle state of the component.
isRoot (boolean) --
Whether or not the component is a root component.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves the list of tags for an AWS IoT Greengrass resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
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.
(string) --
(string) --
Retrieves metadata for a version of a component.
See also: AWS API Documentation
Request Syntax
client.describe_component(
arn='string'
)
string
[REQUIRED]
The ARN of the component version.
dict
Response Syntax
{
'arn': 'string',
'componentName': 'string',
'componentVersion': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'publisher': 'string',
'description': 'string',
'status': {
'componentState': 'REQUESTED'|'INITIATED'|'DEPLOYABLE'|'FAILED'|'DEPRECATED',
'message': 'string',
'errors': {
'string': 'string'
}
},
'platforms': [
{
'name': 'string',
'attributes': {
'string': 'string'
}
},
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the component version.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
creationTimestamp (datetime) --
The time at which the component was created, expressed in ISO 8601 format.
publisher (string) --
The publisher of the component version.
description (string) --
The description of the component version.
status (dict) --
The status of the component version in AWS IoT Greengrass V2. This status is different from the status of the component on a core device.
componentState (string) --
The state of the component.
message (string) --
A message that communicates details, such as errors, about the status of the component.
errors (dict) --
A dictionary of errors that communicate why the component is in an error state. For example, if AWS IoT Greengrass can't access an artifact for the component, then errors contains the artifact's URI as a key, and the error message as the value for that key.
(string) --
(string) --
platforms (list) --
The platforms that the component version supports.
(dict) --
Contains information about a platform that a component supports.
name (string) --
The friendly name of the platform. This name helps you identify the platform.
If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and architecture of the platform.
attributes (dict) --
A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the os and platform by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the AWS IoT Greengrass nucleus component in the AWS IoT Greengrass V2 Developer Guide.
(string) --
(string) --
tags (dict) --
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.
(string) --
(string) --
Retrieves a paginated list of deployments.
See also: AWS API Documentation
Request Syntax
client.list_deployments(
targetArn='string',
historyFilter='ALL'|'LATEST_ONLY',
maxResults=123,
nextToken='string'
)
string
The ARN of the target AWS IoT thing or thing group.
string
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_ONLY
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'deployments': [
{
'targetArn': 'string',
'revisionId': 'string',
'deploymentId': 'string',
'deploymentName': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'deploymentStatus': 'ACTIVE'|'COMPLETED'|'CANCELED'|'FAILED'|'INACTIVE',
'isLatestForTarget': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deployments (list) --
A list that summarizes each deployment.
(dict) --
Contains information about a deployment.
targetArn (string) --
The ARN of the target AWS IoT thing or thing group.
revisionId (string) --
The revision number of the deployment.
deploymentId (string) --
The ID of the deployment.
deploymentName (string) --
The name of the deployment.
You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.
creationTimestamp (datetime) --
The time at which the deployment was created, expressed in ISO 8601 format.
deploymentStatus (string) --
The status of the deployment.
isLatestForTarget (boolean) --
Whether or not the deployment is the latest revision for its target.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves a paginated list of all versions for a component.
See also: AWS API Documentation
Request Syntax
client.list_component_versions(
arn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ARN of the component version.
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'componentVersions': [
{
'componentName': 'string',
'componentVersion': 'string',
'arn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
componentVersions (list) --
A list of versions that exist for the component.
(dict) --
Contains information about a component version in a list.
componentName (string) --
The name of the component.
componentVersion (string) --
The version of the component.
arn (string) --
The ARN of the component version.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
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.
See also: AWS API Documentation
Request Syntax
client.get_component(
recipeOutputFormat='JSON'|'YAML',
arn='string'
)
string
The format of the recipe.
string
[REQUIRED]
The ARN of the component version.
dict
Response Syntax
{
'recipeOutputFormat': 'JSON'|'YAML',
'recipe': b'bytes',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
recipeOutputFormat (string) --
The format of the recipe.
recipe (bytes) --
The recipe of the component version.
tags (dict) --
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.
(string) --
(string) --
Retrieves a paginated list of AWS IoT Greengrass core devices.
See also: AWS API Documentation
Request Syntax
client.list_core_devices(
thingGroupArn='string',
status='HEALTHY'|'UNHEALTHY',
maxResults=123,
nextToken='string'
)
string
The ARN of the AWS IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.
string
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
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.
integer
The maximum number of results to be returned per paginated request.
string
The token to be used for the next set of paginated results.
dict
Response Syntax
{
'coreDevices': [
{
'coreDeviceThingName': 'string',
'status': 'HEALTHY'|'UNHEALTHY',
'lastStatusUpdateTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
coreDevices (list) --
A list that summarizes each core device.
(dict) --
Contains information about a AWS IoT Greengrass core device, which is an AWS IoT thing that runs the AWS IoT Greengrass Core software.
coreDeviceThingName (string) --
The name of the core device. This is also the name of the AWS IoT thing.
status (string) --
The status of the core device. Core devices can have the following statuses:
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.
lastStatusUpdateTimestamp (datetime) --
The time at which the core device's status last updated, expressed in ISO 8601 format.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Removes a tag from an AWS IoT Greengrass resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to untag.
list
[REQUIRED]
A list of keys for tags to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a version of a component from AWS IoT Greengrass.
See also: AWS API Documentation
Request Syntax
client.delete_component(
arn='string'
)
string
[REQUIRED]
The ARN of the component version.
None