Skip to main content

package_configurations

Creates, updates, deletes, gets or lists a package_configurations resource.

Overview

Namepackage_configurations
TypeResource
Idaws.iot.package_configurations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
enabledbooleanIndicates whether the Job is enabled or not.
role_arnstringThe 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:

NameAccessible byRequired ParamsOptional ParamsDescription
get_package_configurationselectregionGets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action.
update_package_configurationupdateregionclientTokenUpdates 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
clientTokenstringA 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

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

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}}';