package_configurations
Creates, updates, deletes, gets or lists a package_configurations resource.
Overview
| Name | package_configurations |
| Type | Resource |
| Id | aws.iot.package_configurations |
Fields
The following fields are returned by SELECT queries:
- get_package_configuration
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Indicates whether the Job is enabled or not. |
role_arn | string | The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_package_configuration | select | region | Gets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action. | |
update_package_configuration | update | region | clientToken | Updates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
clientToken | string | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. |
SELECT examples
- get_package_configuration
Gets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action.
SELECT
enabled,
role_arn
FROM aws.iot.package_configurations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_package_configuration
Updates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
UPDATE aws.iot.package_configurations
SET
versionUpdateByJobsConfig = '{{ versionUpdateByJobsConfig }}'
WHERE
region = '{{ region }}' --required
AND clientToken = '{{ clientToken}}';