provisioning_profiles

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

Overview

Name	provisioning_profiles
Type	Resource
Id	aws.iot_managed_integrations.provisioning_profiles

Fields

The following fields are returned by SELECT queries:

get_provisioning_profile

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the provisioning profile. (pattern: <code>arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:provisioning-profile/[0-9a-zA-Z]+</code>)
claim_certificate	string	The body of the PEM-encoded claim certificate.
id	string	The provisioning profile id. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The name of the provisioning profile. (pattern: <code>[0-9A-Za-z_-]+</code>)
provisioning_type	string	The type of provisioning workflow the device uses for onboarding to IoT managed integrations. (FLEET_PROVISIONING, JITR)
status	string	The status of a provisioning profile. (CREATE_IN_PROGRESS, CREATE_FAILED, CREATED, DELETE_IN_PROGRESS, DELETE_FAILED)
tags	object	A set of key/value pairs that are used to manage the provisioning profile.

list_provisioning_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the provisioning profile. (pattern: <code>arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:provisioning-profile/[0-9a-zA-Z]+</code>)
id	string	The identifier of the provisioning profile. (pattern: <code>[A-Za-z0-9-_]+</code>)
name	string	The name of the provisioning profile. (pattern: <code>[0-9A-Za-z_-]+</code>)
provisioning_type	string	The type of provisioning workflow the device uses for onboarding to IoT managed integrations. (FLEET_PROVISIONING, JITR)
status	string	The status of a provisioning profile. (CREATE_IN_PROGRESS, CREATE_FAILED, CREATED, DELETE_IN_PROGRESS, DELETE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_provisioning_profile	select	identifier, region		Get details of a provisioning profile.
list_provisioning_profiles	select	region	NextToken, MaxResults	List the provisioning profiles within the Amazon Web Services account.
create_provisioning_profile	insert	region, ProvisioningType		Create a provisioning profile for executing device provisioning flows. The provisioning profile is a document that defines the set of resources and policies applied to a device during the provisioning process.
delete_provisioning_profile	delete	identifier, region		Delete a provisioning profile.

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
identifier	string	The id of the provisioning profile.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.

SELECT examples

get_provisioning_profile

Get details of a provisioning profile.

SELECT
arn,
claim_certificate,
id,
name,
provisioning_type,
status,
tags
FROM aws.iot_managed_integrations.provisioning_profiles
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_provisioning_profiles

List the provisioning profiles within the Amazon Web Services account.

SELECT
arn,
id,
name,
provisioning_type,
status
FROM aws.iot_managed_integrations.provisioning_profiles
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_provisioning_profile

Create a provisioning profile for executing device provisioning flows. The provisioning profile is a document that defines the set of resources and policies applied to a device during the provisioning process.

INSERT INTO aws.iot_managed_integrations.provisioning_profiles (
ProvisioningType,
CaCertificate,
ClaimCertificate,
Name,
ClientToken,
Tags,
region
)
SELECT 
'{{ ProvisioningType }}' /* required */,
'{{ CaCertificate }}',
'{{ ClaimCertificate }}',
'{{ Name }}',
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
claim_certificate,
claim_certificate_private_key,
id,
name,
provisioning_type,
status
;

Manifest

# Description fields are for documentation purposes
- name: provisioning_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the provisioning_profiles resource.
  - name: ProvisioningType
    value: "{{ ProvisioningType }}"
    valid_values: ['FLEET_PROVISIONING', 'JITR']
  - name: CaCertificate
    value: "{{ CaCertificate }}"
  - name: ClaimCertificate
    value: "{{ ClaimCertificate }}"
  - name: Name
    value: "{{ Name }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_provisioning_profile

Delete a provisioning profile.

DELETE FROM aws.iot_managed_integrations.provisioning_profiles
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;