registration_codes
Creates, updates, deletes, gets or lists a registration_codes resource.
Overview
| Name | registration_codes |
| Type | Resource |
| Id | aws.iot.registration_codes |
Fields
The following fields are returned by SELECT queries:
- get_registration_code
| Name | Datatype | Description |
|---|---|---|
registration_code | string | The CA certificate registration code. (pattern: <code>(0x)?[a-fA-F0-9]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_registration_code | select | region | Gets a registration code used to register a CA certificate with IoT. IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code. Requires permission to access the GetRegistrationCode action. | |
delete_registration_code | delete | region | Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action. |
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) |
SELECT examples
- get_registration_code
Gets a registration code used to register a CA certificate with IoT. IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code. Requires permission to access the GetRegistrationCode action.
SELECT
registration_code
FROM aws.iot.registration_codes
WHERE region = '{{ region }}' -- required
;
DELETE examples
- delete_registration_code
Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.
DELETE FROM aws.iot.registration_codes
WHERE region = '{{ region }}' --required
;