String deploymentId
The ID of the deployment.
String message
A message that communicates if the cancel was successful.
String componentState
The state of the component.
String message
A message that communicates details, such as errors, about the status of the component.
Map<K,V> errors
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 arn
The ARN of the component version.
String componentName
The name of the component.
ComponentLatestVersion latestVersion
The latest version of the component and its details.
String componentName
The name of the component.
String componentVersion
The version of the component.
Map<K,V> versionRequirements
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 merge
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.
List<E> reset
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 versionRequirement
The component version requirement for the component dependency.
AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.
String dependencyType
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
String componentVersion
The version of the component.
ComponentConfigurationUpdate configurationUpdate
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.
ComponentRunWith runWith
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.
String arn
The ARN of the component version.
String componentVersion
The version of the component.
Date creationTimestamp
The time at which the component was created, expressed in ISO 8601 format.
String description
The description of the component version.
String publisher
The publisher of the component version.
List<E> platforms
The platforms that the component version supports.
String name
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.
Map<K,V> attributes
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 posixUser
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.
String coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
String status
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.
Date lastStatusUpdateTimestamp
The time at which the core device's status last updated, expressed in ISO 8601 format.
ByteBuffer inlineRecipe
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.
LambdaFunctionRecipeSource lambdaFunction
The parameters to create a component from a Lambda function.
You must specify either inlineRecipe or lambdaFunction.
Map<K,V> tags
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 arn
The ARN of the component version.
String componentName
The name of the component.
String componentVersion
The version of the component.
Date creationTimestamp
The time at which the component was created, expressed in ISO 8601 format.
CloudComponentStatus status
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.
String targetArn
The ARN of the target AWS IoT thing or thing group.
String deploymentName
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.
Map<K,V> components
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.
DeploymentIoTJobConfiguration iotJobConfiguration
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
DeploymentPolicies deploymentPolicies
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
Map<K,V> tags
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 coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
String targetArn
The ARN of the target AWS IoT thing or thing group.
String revisionId
The revision number of the deployment.
String deploymentId
The ID of the deployment.
String deploymentName
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.
Date creationTimestamp
The time at which the deployment was created, expressed in ISO 8601 format.
String deploymentStatus
The status of the deployment.
Boolean isLatestForTarget
Whether or not the deployment is the latest revision for its target.
Integer timeoutInSeconds
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
String action
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 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
Integer timeoutInSeconds
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
IoTJobExecutionsRolloutConfig jobExecutionsRolloutConfig
The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
IoTJobAbortConfig abortConfig
The stop configuration for the job. This configuration defines when and how to stop a job rollout.
IoTJobTimeoutConfig timeoutConfig
The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
String failureHandlingPolicy
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
Default: ROLLBACK
DeploymentComponentUpdatePolicy componentUpdatePolicy
The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.
DeploymentConfigurationValidationPolicy configurationValidationPolicy
The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
String arn
The ARN of the component version.
String componentName
The name of the component.
String componentVersion
The version of the component.
Date creationTimestamp
The time at which the component was created, expressed in ISO 8601 format.
String publisher
The publisher of the component version.
String description
The description of the component version.
CloudComponentStatus status
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.
List<E> platforms
The platforms that the component version supports.
Map<K,V> tags
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 deploymentId
The ID of the deployment.
String deploymentName
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.
String iotJobId
The ID of the AWS IoT job that applies the deployment to target devices.
String iotJobArn
The ARN of the AWS IoT job that applies the deployment to target devices.
String description
The description of the deployment job.
String targetArn
The ARN of the target AWS IoT thing or thing group.
String coreDeviceExecutionStatus
The status of the deployment job on the AWS IoT Greengrass core device.
String reason
The reason code for the update, if the job was updated.
Date creationTimestamp
The time at which the deployment was created, expressed in ISO 8601 format.
Date modifiedTimestamp
The time at which the deployment job was last modified, expressed in ISO 8601 format.
String recipeOutputFormat
The format of the recipe.
ByteBuffer recipe
The recipe of the component version.
Map<K,V> tags
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 arn
The ARN of the component version. Specify the ARN of a public component version.
String artifactName
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.
String preSignedUrl
The URL of the artifact.
String coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
String coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
String coreVersion
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.
String platform
The operating system platform that the core device runs.
String architecture
The computer architecture of the core device.
String status
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.
Date lastStatusUpdateTimestamp
The time at which the core device's status last updated, expressed in ISO 8601 format.
Map<K,V> tags
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 deploymentId
The ID of the deployment.
String targetArn
The ARN of the target AWS IoT thing or thing group.
String revisionId
The revision number of the deployment.
String deploymentId
The ID of the deployment.
String deploymentName
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.
String deploymentStatus
The status of the deployment.
String iotJobId
The ID of the AWS IoT job that applies the deployment to target devices.
String iotJobArn
The ARN of the AWS IoT job that applies the deployment to target devices.
Map<K,V> components
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.
DeploymentPolicies deploymentPolicies
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
DeploymentIoTJobConfiguration iotJobConfiguration
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
Date creationTimestamp
The time at which the deployment was created, expressed in ISO 8601 format.
Boolean isLatestForTarget
Whether or not the deployment is the latest revision for its target.
Map<K,V> tags
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 componentName
The name of the component.
String componentVersion
The version of the component.
String lifecycleState
The lifecycle state of the component.
String lifecycleStateDetails
The details about the lifecycle state of the component.
Boolean isRoot
Whether or not the component is a root component.
Integer retryAfterSeconds
The amount of time to wait before you retry the request.
String failureType
The type of job deployment failure that can cancel a job.
String action
The action to perform when the criteria are met.
Double thresholdPercentage
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).
Integer minNumberOfExecutedThings
The minimum number of things that receive the configuration before the job can cancel.
IoTJobExponentialRolloutRate exponentialRate
The exponential rate to increase the job rollout rate.
Integer maximumPerMinute
The maximum number of devices that receive a pending job notification, per minute.
Integer baseRatePerMinute
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.
Double incrementFactor
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).
IoTJobRateIncreaseCriteria rateIncreaseCriteria
The criteria to increase the rollout rate for the job.
Long inProgressTimeoutInMinutes
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).
Integer memorySizeInKB
The memory size of the container, expressed in kilobytes.
Default: 16384 (16 MB)
Boolean mountROSysfs
Whether or not the container can read information from the device's /sys folder.
Default: false
List<E> volumes
The list of volumes that the container can access.
List<E> devices
The list of system devices that the container can access.
String path
The mount path for the device in the file system.
String permission
The permission to access the device: read/only (ro) or read/write (rw).
Default: ro
Boolean addGroupOwner
Whether or not to add the component's system user as an owner of the device.
Default: false
String topic
The topic to which to subscribe to receive event messages.
String type
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.
List<E> eventSources
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.
Integer maxQueueSize
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.
Integer maxInstancesCount
The maximum number of instances that a non-pinned Lambda function can run at the same time.
Integer maxIdleTimeInSeconds
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.
Integer timeoutInSeconds
The maximum amount of time in seconds that the Lambda function can process a work item.
Integer statusTimeoutInSeconds
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
Boolean pinned
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
String inputPayloadEncodingType
The encoding type that the Lambda function supports.
Default: json
List<E> execArgs
The list of arguments to pass to the Lambda function when it runs.
Map<K,V> environmentVariables
The map of environment variables that are available to the Lambda function when it runs.
LambdaLinuxProcessParams linuxProcessParams
The parameters for the Linux process that contains the Lambda function.
String lambdaArn
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.
String componentName
The name of the component.
Defaults to the name of the Lambda function.
String componentVersion
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.
List<E> componentPlatforms
The platforms that the component version supports.
Map<K,V> componentDependencies
The component versions on which this Lambda function component depends.
LambdaExecutionParameters componentLambdaParameters
The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device.
String isolationMode
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
LambdaContainerParams containerParams
The parameters for the container in which the Lambda function runs.
String sourcePath
The path to the physical volume in the file system.
String destinationPath
The path to the logical volume in the file system.
String permission
The permission to access the volume: read/only (ro) or read/write (rw).
Default: ro
Boolean addGroupOwner
Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.
Default: false
String thingGroupArn
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 status
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 maxResults
The maximum number of results to be returned per paginated request.
String nextToken
The token to be used for the next set of paginated results.
String targetArn
The ARN of the target AWS IoT thing or thing group.
String historyFilter
The filter for the list of deployments. Choose one of the following options:
ALL – The list includes all deployments.
LATEST_ONLY – The list includes only the latest revision of each deployment.
Default: LATEST_ONLY
Integer maxResults
The maximum number of results to be returned per paginated request.
String nextToken
The token to be used for the next set of paginated results.
String coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
Integer maxResults
The maximum number of results to be returned per paginated request.
String nextToken
The token to be used for the next set of paginated results.
String coreDeviceThingName
The name of the core device. This is also the name of the AWS IoT thing.
Integer maxResults
The maximum number of results to be returned per paginated request.
String nextToken
The token to be used for the next set of paginated results.
Map<K,V> tags
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.
ComponentPlatform platform
The platform to use to resolve compatible components.
List<E> componentCandidates
The list of components to resolve.
String arn
The ARN of the component version.
String componentName
The name of the component.
String componentVersion
The version of the component.
ByteBuffer recipe
The recipe of the component version.
String resourceId
The ID of the resource that exceeds the service quota.
String resourceType
The type of the resource that exceeds the service quota.
String quotaCode
The code for the quota in Service Quotas.
String serviceCode
The code for the service in Service Quotas.
String quotaCode
The code for the quota in Service Quotas.
String serviceCode
The code for the service in Service Quotas.
Integer retryAfterSeconds
The amount of time to wait before you retry the request.
Copyright © 2021. All rights reserved.