2021/08/02 - AWS IoT Greengrass V2 - 3 updated api methods
Changes This release adds support for component system resource limits and idempotent Create operations. You can now specify the maximum amount of CPU and memory resources that each component can use.
{'clientToken': 'string'}
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 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 IoT Greengrass component recipe reference in the 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 Lambda function that runs on 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 IoT Greengrass V1 to 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'
},
clientToken='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, IoT Greengrass creates a friendly name from the os and architecture of the platform.
attributes (dict) --
A dictionary of attributes for the platform. The 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 Greengrass nucleus component. For more information, see the Greengrass nucleus component in the 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.
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 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 Amazon Web Services IoT Core MQTT messages.
(dict) --
Contains information about an event source for an 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 Amazon Web Services 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 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 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 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 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 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 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 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 IoT Greengrass V2 Developer Guide.
(string) --
(string) --
string
A unique, case-sensitive identifier 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 IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
This field is autopopulated if not provided.
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 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 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) --
{'clientToken': 'string',
'components': {'runWith': {'systemResourceLimits': {'cpus': 'double',
'memory': 'long'}}}}
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, 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. 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 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',
'systemResourceLimits': {
'memory': 123,
'cpus': 123.0
}
}
}
},
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'
},
clientToken='string'
)
string
[REQUIRED]
The ARN of the target IoT thing or thing group.
string
The name of the deployment.
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 IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the 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 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 IoT Greengrass V2 Developer Guide.
(string) --
runWith (dict) --
The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the 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 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 IoT Greengrass Core software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
systemResourceLimits (dict) --
The system resource limits to apply to this component's process on the core device.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
memory (integer) --
The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.
cpus (float) --
The maximum amount of CPU time that a component's processes can use on the core device. A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core software doesn't limit the component's CPU usage.
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 Create deployments in the 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 IoT Greengrass V2 Developer Guide.
(string) --
(string) --
string
A unique, case-sensitive identifier 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 IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
This field is autopopulated if not provided.
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 IoT job that applies the deployment to target devices.
iotJobArn (string) --
The ARN of the IoT job that applies the deployment to target devices.
{'components': {'runWith': {'systemResourceLimits': {'cpus': 'double',
'memory': 'long'}}}}
Gets a deployment. Deployments define the components that run on 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',
'systemResourceLimits': {
'memory': 123,
'cpus': 123.0
}
}
}
},
'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 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.
deploymentStatus (string) --
The status of the deployment.
iotJobId (string) --
The ID of the IoT job that applies the deployment to target devices.
iotJobArn (string) --
The ARN of the 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 IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the 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 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 IoT Greengrass V2 Developer Guide.
(string) --
runWith (dict) --
The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the 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 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 IoT Greengrass Core software uses the primary user for the group.
If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
systemResourceLimits (dict) --
The system resource limits to apply to this component's process on the core device.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
memory (integer) --
The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.
cpus (float) --
The maximum amount of CPU time that a component's processes can use on the core device. A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to 0.25 to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core software doesn't limit the component's CPU usage.
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 Create deployments in the 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 IoT Greengrass V2 Developer Guide.
(string) --
(string) --