aws-iot — quality + safety report

---
name: aws-iot
description: "AWS IoT API skill. Use when working with AWS IoT for accept-certificate-transfer, billing-groups, thing-groups. Covers 255 endpoints."
version: 1.0.0
generator: lapsh
---

# AWS IoT
API version: 2015-05-28

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /audit/configuration -- verify access
3. POST /jobs/{jobId}/targets -- create first targets

## Endpoints

255 endpoints across 69 groups. See references/api-spec.lap for full details.

### accept-certificate-transfer
| Method | Path | Description |
|--------|------|-------------|
| PATCH | /accept-certificate-transfer/{certificateId} | Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. Requires permission to access the AcceptCertificateTransfer action. |

### billing-groups
| Method | Path | Description |
|--------|------|-------------|
| PUT | /billing-groups/addThingToBillingGroup | Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action. |
| POST | /billing-groups/{billingGroupName} | Creates a billing group. Requires permission to access the CreateBillingGroup action. |
| DELETE | /billing-groups/{billingGroupName} | Deletes the billing group. Requires permission to access the DeleteBillingGroup action. |
| GET | /billing-groups/{billingGroupName} | Returns information about a billing group. Requires permission to access the DescribeBillingGroup action. |
| GET | /billing-groups | Lists the billing groups you have created. Requires permission to access the ListBillingGroups action. |
| GET | /billing-groups/{billingGroupName}/things | Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action. |
| PUT | /billing-groups/removeThingFromBillingGroup | Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action.  This call is asynchronous. It might take several seconds for the detachment to propagate. |
| PATCH | /billing-groups/{billingGroupName} | Updates information about the billing group. Requires permission to access the UpdateBillingGroup action. |

### thing-groups
| Method | Path | Description |
|--------|------|-------------|
| PUT | /thing-groups/addThingToThingGroup | Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup action. |
| POST | /thing-groups/{thingGroupName} | Create a thing group.  This is a control plane operation. See Authorization for information about authorizing control plane actions. If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response.   Requires permission to access the CreateThingGroup action. |
| DELETE | /thing-groups/{thingGroupName} | Deletes a thing group. Requires permission to access the DeleteThingGroup action. |
| GET | /thing-groups/{thingGroupName} | Describe a thing group. Requires permission to access the DescribeThingGroup action. |
| GET | /thing-groups | List the thing groups in your account. Requires permission to access the ListThingGroups action. |
| GET | /thing-groups/{thingGroupName}/things | Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action. |
| PUT | /thing-groups/removeThingFromThingGroup | Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.  Requires permission to access the RemoveThingFromThingGroup action. |
| PATCH | /thing-groups/{thingGroupName} | Update a thing group. Requires permission to access the UpdateThingGroup action. |
| PUT | /thing-groups/updateThingGroupsForThing | Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action. |

### jobs
| Method | Path | Description |
|--------|------|-------------|
| POST | /jobs/{jobId}/targets | Associates a group with a continuous job. The following criteria must be met:    The job must have been created with the targetSelection field set to "CONTINUOUS".   The job status must currently be "IN_PROGRESS".   The total number of targets associated with a job must not exceed 100.   Requires permission to access the AssociateTargetsWithJob action. |
| PUT | /jobs/{jobId}/cancel | Cancels a job. Requires permission to access the CancelJob action. |
| PUT | /jobs/{jobId} | Creates a job. Requires permission to access the CreateJob action. |
| DELETE | /jobs/{jobId} | Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. Requires permission to access the DeleteJob action. |
| GET | /jobs/{jobId} | Describes a job. Requires permission to access the DescribeJob action. |
| GET | /jobs/{jobId}/job-document | Gets a job document. Requires permission to access the GetJobDocument action. |
| GET | /jobs/{jobId}/things | Lists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action. |
| GET | /jobs | Lists jobs. Requires permission to access the ListJobs action. |
| PATCH | /jobs/{jobId} | Updates supported fields of the specified job. Requires permission to access the UpdateJob action. |

### target-policies
| Method | Path | Description |
|--------|------|-------------|
| PUT | /target-policies/{policyName} | Attaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action. |
| POST | /target-policies/{policyName} | Detaches a policy from the specified target.  Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.  Requires permission to access the DetachPolicy action. |

### principal-policies
| Method | Path | Description |
|--------|------|-------------|
| PUT | /principal-policies/{policyName} | Attaches the specified policy to the specified principal (certificate or other credential).  Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead. Requires permission to access the AttachPrincipalPolicy action. |
| DELETE | /principal-policies/{policyName} | Removes the specified policy from the specified certificate.  Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead. Requires permission to access the DetachPrincipalPolicy action. |
| GET | /principal-policies | Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.  Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead. Requires permission to access the ListPrincipalPolicies action. |

### security-profiles
| Method | Path | Description |
|--------|------|-------------|
| PUT | /security-profiles/{securityProfileName}/targets | Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it. Requires permission to access the AttachSecurityProfile action. |
| POST | /security-profiles/{securityProfileName} | Creates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action. |
| DELETE | /security-profiles/{securityProfileName} | Deletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action. |
| GET | /security-profiles/{securityProfileName} | Gets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action. |
| DELETE | /security-profiles/{securityProfileName}/targets | Disassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action. |
| GET | /security-profiles | Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. Requires permission to access the ListSecurityProfiles action.   dimensionName and metricName cannot be used in the same request. |
| GET | /security-profiles/{securityProfileName}/targets | Lists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action. |
| PATCH | /security-profiles/{securityProfileName} | Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action. |

### things
| Method | Path | Description |
|--------|------|-------------|
| PUT | /things/{thingName}/principals | Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities. Requires permission to access the AttachThingPrincipal action. |
| PUT | /things/{thingName}/jobs/{jobId}/cancel | Cancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action. |
| POST | /things/{thingName} | Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.  This is a control plane operation. See Authorization for information about authorizing control plane actions.  Requires permission to access the CreateThing action. |
| DELETE | /things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber} | Deletes a job execution. Requires permission to access the DeleteJobExecution action. |
| DELETE | /things/{thingName} | Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. Requires permission to access the DeleteThing action. |
| GET | /things/{thingName}/jobs/{jobId} | Describes a job execution. Requires permission to access the DescribeJobExecution action. |
| GET | /things/{thingName} | Gets information about the specified thing. Requires permission to access the DescribeThing action. |
| DELETE | /things/{thingName}/principals | Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.  This call is asynchronous. It might take several seconds for the detachment to propagate.  Requires permission to access the DetachThingPrincipal action. |
| GET | /things/{thingName}/jobs | Lists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action. |
| GET | /things/{thingName}/thing-groups | List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action. |
| GET | /things/{thingName}/principals | Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the ListThingPrincipals action. |
| GET | /things | Lists your things. Use the attributeName and attribu

… (truncated)