Amazon Web Services, Inc.

AWS IoT

IoT IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances)…

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

IoT
IoT provides secure, bi-directional communication between Internet-connected
devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
rules for data processing and integration with other services, organize resources
associated with each device (Registry), configure logging, and create and manage
policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in
Amazon Web Services IoT Core Endpoints and Quotas .
You must use the endpoint for the region that has the resources you want to access.
The service name used by Amazon Web Services
Signature Version 4 to sign the request is:
execute-api .
For more information about how IoT works, see the Developer
Guide .
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services .

Endpoints 272

  • PATCHAccept certificate transfer/accept-certificate-transfer/:certificateId?setAsActive=trueAccepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to…
  • PUTAdd thing to billing group/billing-groups/addThingToBillingGroupAdds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action.
  • PUTAdd thing to thing group/thing-groups/addThingToThingGroupAdds a thing to a thing group. Requires permission to access the AddThingToThingGroup action.
  • PUTAssociate sbom with package version/packages/:packageName/versions/:versionName/sbom?clientToken=stringAssociates the selected software bill of materials (SBOM) with a specific software package version. Requires permission to access the…
  • DELETEDisassociate sbom from package version/packages/:packageName/versions/:versionName/sbom?clientToken=stringDisassociates the selected software bill of materials (SBOM) from a specific software package version. Requires permission to access the…
  • POSTAssociate targets with job/jobs/:jobId/targets?namespaceId=stringAssociates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to…
  • PUTAttach policy/target-policies/:policyNameAttaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action.
  • POSTDetach policy/target-policies/:policyNameDetaches 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…
  • PUTAttach principal policy/principal-policies/:policyNameDeprecated. Attaches the specified policy to the specified principal (certificate or other credential). Note: This action is deprecated and works as expected…
  • DELETEDetach principal policy/principal-policies/:policyNameDeprecated. Removes the specified policy from the specified certificate. Note: This action is deprecated and works as expected for backward compatibility, but…
  • GETList targets for security profile/security-profiles/:securityProfileName/targets?nextToken=string&maxResults=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PUTAttach security profile/security-profiles/:securityProfileName/targets?securityProfileTargetArn=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • DELETEDetach security profile/security-profiles/:securityProfileName/targets?securityProfileTargetArn=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList thing principals/things/:thingName/principals?nextToken=string&maxResults=0Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or…
  • PUTAttach thing principal/things/:thingName/principals?thingPrincipalType=stringAttaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities. Requires…
  • DELETEDetach thing principal/things/:thingName/principalsDetaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or…
  • PUTCancel audit mitigation actions task/audit/mitigationactions/tasks/:taskId/cancelCancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. Requires permission to access the…
  • PUTCancel audit task/audit/tasks/:taskId/cancelCancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.…
  • PATCHCancel certificate transfer/cancel-certificate-transfer/:certificateIdCancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer…
  • PUTCancel detect mitigation actions task/detect/mitigationactions/tasks/:taskId/cancelThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PUTCancel job/jobs/:jobId/cancel?force=trueCancels a job. Requires permission to access the CancelJob action.
  • PUTCancel job execution/things/:thingName/jobs/:jobId/cancel?force=trueCancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action.
  • GETDescribe default authorizer/default-authorizerDescribes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action.
  • POSTSet default authorizer/default-authorizerSets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the…
  • DELETEClear default authorizer/default-authorizerClears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action.
  • GETConfirm topic rule destination/confirmdestination/:confirmationTokenConfirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you…
  • POSTCreate audit suppression/audit/suppressions/createCreates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.
  • GETDescribe authorizer/authorizer/:authorizerNameDescribes an authorizer. Requires permission to access the DescribeAuthorizer action.
  • PUTUpdate authorizer/authorizer/:authorizerNameUpdates an authorizer. Requires permission to access the UpdateAuthorizer action.
  • POSTCreate authorizer/authorizer/:authorizerNameCreates an authorizer. Requires permission to access the CreateAuthorizer action.
  • DELETEDelete authorizer/authorizer/:authorizerNameDeletes an authorizer. Requires permission to access the DeleteAuthorizer action.
  • GETDescribe billing group/billing-groups/:billingGroupNameReturns information about a billing group. Requires permission to access the DescribeBillingGroup action.
  • POSTCreate billing group/billing-groups/:billingGroupNameCreates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made…
  • DELETEDelete billing group/billing-groups/:billingGroupName?expectedVersion=0Deletes the billing group. Requires permission to access the DeleteBillingGroup action.
  • PATCHUpdate billing group/billing-groups/:billingGroupNameUpdates information about the billing group. Requires permission to access the UpdateBillingGroup action.
  • GETList certificates/certificates?pageSize=0&marker=string&isAscendingOrder=trueLists the certificates registered in your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned…
  • POSTCreate certificate from csr/certificates?setAsActive=trueCreates an X.509 certificate using the specified certificate signing request. Requires permission to access the CreateCertificateFromCsr action. The CSR must…
  • GETDescribe certificate provider/certificate-providers/:certificateProviderNameDescribes a certificate provider. Requires permission to access the DescribeCertificateProvider action.
  • PUTUpdate certificate provider/certificate-providers/:certificateProviderNameUpdates a certificate provider. Requires permission to access the UpdateCertificateProvider action.
  • POSTCreate certificate provider/certificate-providers/:certificateProviderNameCreates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a…
  • DELETEDelete certificate provider/certificate-providers/:certificateProviderNameDeletes a certificate provider. Requires permission to access the DeleteCertificateProvider action. If you delete the certificate provider resource, the…
  • GETGet command/commands/:commandIdGets information about the specified command.
  • PUTCreate command/commands/:commandIdCreates a command. A command contains reusable configurations that can be applied before they are sent to the devices.
  • DELETEDelete command/commands/:commandIdDelete a command resource.
  • PATCHUpdate command/commands/:commandIdUpdate information about a command or mark a command for deprecation.
  • GETDescribe custom metric/custom-metric/:metricNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTCreate custom metric/custom-metric/:metricNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • DELETEDelete custom metric/custom-metric/:metricNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PATCHUpdate custom metric/custom-metric/:metricNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETDescribe dimension/dimensions/:nameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTCreate dimension/dimensions/:nameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • DELETEDelete dimension/dimensions/:nameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PATCHUpdate dimension/dimensions/:nameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETDescribe domain configuration/domainConfigurations/:domainConfigurationNameGets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.
  • PUTUpdate domain configuration/domainConfigurations/:domainConfigurationNameUpdates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the…
  • POSTCreate domain configuration/domainConfigurations/:domainConfigurationNameCreates a domain configuration. Requires permission to access the CreateDomainConfiguration action.
  • DELETEDelete domain configuration/domainConfigurations/:domainConfigurationNameDeletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.
  • POSTCreate dynamic thing group/dynamic-thing-groups/:thingGroupNameCreates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action.
  • DELETEDelete dynamic thing group/dynamic-thing-groups/:thingGroupName?expectedVersion=0Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action.
  • PATCHUpdate dynamic thing group/dynamic-thing-groups/:thingGroupNameUpdates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.
  • GETDescribe fleet metric/fleet-metric/:metricNameGets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action.
  • PUTCreate fleet metric/fleet-metric/:metricNameCreates a fleet metric. Requires permission to access the CreateFleetMetric action.
  • DELETEDelete fleet metric/fleet-metric/:metricName?expectedVersion=0Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.…
  • PATCHUpdate fleet metric/fleet-metric/:metricNameUpdates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.
  • GETDescribe job/jobs/:jobId?beforeSubstitution=trueDescribes a job. Requires permission to access the DescribeJob action.
  • PUTCreate job/jobs/:jobIdCreates a job. Requires permission to access the CreateJob action.
  • DELETEDelete job/jobs/:jobId?force=true&namespaceId=stringDeletes 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…
  • PATCHUpdate job/jobs/:jobId?namespaceId=stringUpdates supported fields of the specified job. Requires permission to access the UpdateJob action.
  • GETDescribe job template/job-templates/:jobTemplateIdReturns information about a job template.
  • PUTCreate job template/job-templates/:jobTemplateIdCreates a job template. Requires permission to access the CreateJobTemplate action.
  • DELETEDelete job template/job-templates/:jobTemplateIdDeletes the specified job template.
  • POSTCreate keys and certificate/keys-and-certificate?setAsActive=trueCreates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a…
  • GETDescribe mitigation action/mitigationactions/actions/:actionNameGets information about a mitigation action. Requires permission to access the DescribeMitigationAction action.
  • POSTCreate mitigation action/mitigationactions/actions/:actionNameDefines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to…
  • DELETEDelete mitigation action/mitigationactions/actions/:actionNameDeletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action.
  • PATCHUpdate mitigation action/mitigationactions/actions/:actionNameUpdates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.
  • GETGet oTA update/otaUpdates/:otaUpdateIdGets an OTA update. Requires permission to access the GetOTAUpdate action.
  • POSTCreate oTA update/otaUpdates/:otaUpdateIdCreates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.
  • DELETEDelete oTA update/otaUpdates/:otaUpdateId?deleteStream=true&forceDeleteAWSJob=trueDelete an OTA update. Requires permission to access the DeleteOTAUpdate action.
  • GETGet package/packages/:packageNameGets information about the specified software package. Requires permission to access the GetPackage action.
  • PUTCreate package/packages/:packageName?clientToken=stringCreates an IoT software package that can be deployed to your fleet. Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
  • DELETEDelete package/packages/:packageName?clientToken=stringDeletes a specific version from a software package. Note: All package versions must be deleted before deleting the software package. Requires permission to…
  • PATCHUpdate package/packages/:packageName?clientToken=stringUpdates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
  • GETGet package version/packages/:packageName/versions/:versionNameGets information about the specified package version. Requires permission to access the GetPackageVersion action.
  • PUTCreate package version/packages/:packageName/versions/:versionName?clientToken=stringCreates a new version for an existing IoT software package. Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
  • DELETEDelete package version/packages/:packageName/versions/:versionName?clientToken=stringDeletes a specific version from a software package. Note: If a package version is designated as default, you must remove the designation from the software…
  • PATCHUpdate package version/packages/:packageName/versions/:versionName?clientToken=stringUpdates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
  • GETGet policy/policies/:policyNameGets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.
  • POSTCreate policy/policies/:policyNameCreates an IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and…
  • DELETEDelete policy/policies/:policyNameDeletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the…
  • GETList policy versions/policies/:policyName/versionLists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.
  • POSTCreate policy version/policies/:policyName/version?setAsDefault=trueCreates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the…
  • POSTCreate provisioning claim/provisioning-templates/:templateName/provisioning-claimCreates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.
  • GETList provisioning templates/provisioning-templates?maxResults=0&nextToken=stringLists the provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action.
  • POSTCreate provisioning template/provisioning-templatesCreates a provisioning template. Requires permission to access the CreateProvisioningTemplate action.
  • GETList provisioning template versions/provisioning-templates/:templateName/versions?maxResults=0&nextToken=stringA list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.
  • POSTCreate provisioning template version/provisioning-templates/:templateName/versions?setAsDefault=trueCreates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.
  • GETDescribe role alias/role-aliases/:roleAliasDescribes a role alias. Requires permission to access the DescribeRoleAlias action.
  • PUTUpdate role alias/role-aliases/:roleAliasUpdates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the…
  • POSTCreate role alias/role-aliases/:roleAliasCreates a role alias. Requires permission to access the CreateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the…
  • DELETEDelete role alias/role-aliases/:roleAliasDeletes a role alias Requires permission to access the DeleteRoleAlias action.
  • GETDescribe scheduled audit/audit/scheduledaudits/:scheduledAuditNameGets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action.
  • POSTCreate scheduled audit/audit/scheduledaudits/:scheduledAuditNameCreates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action.
  • DELETEDelete scheduled audit/audit/scheduledaudits/:scheduledAuditNameDeletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.
  • PATCHUpdate scheduled audit/audit/scheduledaudits/:scheduledAuditNameUpdates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit…
  • GETDescribe security profile/security-profiles/:securityProfileNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTCreate security profile/security-profiles/:securityProfileNameThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • DELETEDelete security profile/security-profiles/:securityProfileName?expectedVersion=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PATCHUpdate security profile/security-profiles/:securityProfileName?expectedVersion=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETDescribe stream/streams/:streamIdGets information about a stream. Requires permission to access the DescribeStream action.
  • PUTUpdate stream/streams/:streamIdUpdates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.
  • POSTCreate stream/streams/:streamIdCreates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from…
  • DELETEDelete stream/streams/:streamIdDeletes a stream. Requires permission to access the DeleteStream action.
  • GETDescribe thing/things/:thingNameGets information about the specified thing. Requires permission to access the DescribeThing action.
  • POSTCreate thing/things/:thingNameCreates 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…
  • DELETEDelete thing/things/:thingName?expectedVersion=0Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. Requires permission…
  • PATCHUpdate thing/things/:thingNameUpdates the data for a thing. Requires permission to access the UpdateThing action.
  • GETDescribe thing group/thing-groups/:thingGroupNameDescribe a thing group. Requires permission to access the DescribeThingGroup action.
  • POSTCreate thing group/thing-groups/:thingGroupNameCreate a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. If the ThingGroup that you…
  • DELETEDelete thing group/thing-groups/:thingGroupName?expectedVersion=0Deletes a thing group. Requires permission to access the DeleteThingGroup action.
  • PATCHUpdate thing group/thing-groups/:thingGroupNameUpdate a thing group. Requires permission to access the UpdateThingGroup action.
  • GETDescribe thing type/thing-types/:thingTypeNameGets information about the specified thing type. Requires permission to access the DescribeThingType action.
  • POSTCreate thing type/thing-types/:thingTypeNameCreates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made…
  • DELETEDelete thing type/thing-types/:thingTypeNameDeletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by…
  • PATCHUpdate thing type/thing-types/:thingTypeNameUpdates a thing type.
  • GETGet topic rule/rules/:ruleNameGets information about the rule. Requires permission to access the GetTopicRule action.
  • POSTCreate topic rule/rules/:ruleNameCreates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the…
  • DELETEDelete topic rule/rules/:ruleNameDeletes the rule. Requires permission to access the DeleteTopicRule action.
  • PATCHReplace topic rule/rules/:ruleNameReplaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create…
  • GETList topic rule destinations/destinations?maxResults=0&nextToken=stringLists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.
  • POSTCreate topic rule destination/destinationsCreates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.
  • PATCHUpdate topic rule destination/destinationsUpdates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the…
  • GETDescribe account audit configuration/audit/configurationGets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are…
  • DELETEDelete account audit configuration/audit/configuration?deleteScheduledAudits=trueRestores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to…
  • PATCHUpdate account audit configuration/audit/configurationConfigures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are…
  • POSTDelete audit suppression/audit/suppressions/deleteDeletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.
  • GETDescribe cA certificate/cacertificate/:certificateIdDescribes a registered CA certificate. Requires permission to access the DescribeCACertificate action.
  • PUTUpdate cA certificate/cacertificate/:certificateId?newStatus=string&newAutoRegistrationStatus=stringUpdates a registered CA certificate. Requires permission to access the UpdateCACertificate action.
  • DELETEDelete cA certificate/cacertificate/:certificateIdDeletes a registered CA certificate. Requires permission to access the DeleteCACertificate action.
  • GETDescribe certificate/certificates/:certificateIdGets information about the specified certificate. Requires permission to access the DescribeCertificate action.
  • PUTUpdate certificate/certificates/:certificateId?newStatus=stringUpdates the status of the specified certificate. This operation is idempotent. Requires permission to access the UpdateCertificate action. Certificates must…
  • DELETEDelete certificate/certificates/:certificateId?forceDelete=trueDeletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete…
  • GETGet command execution/command-executions/:executionId?targetArn=string&includeResult=trueGets information about the specific command execution on a single device.
  • DELETEDelete command execution/command-executions/:executionId?targetArn=stringDelete a command execution. Only command executions that enter a terminal state can be deleted from your account.
  • DELETEDelete job execution/things/:thingName/jobs/:jobId/executionNumber/:executionNumber?force=true&namespaceId=stringDeletes a job execution. Requires permission to access the DeleteJobExecution action.
  • GETGet policy version/policies/:policyName/version/:policyVersionIdGets information about the specified policy version. Requires permission to access the GetPolicyVersion action.
  • DELETEDelete policy version/policies/:policyName/version/:policyVersionIdDeletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a…
  • PATCHSet default policy version/policies/:policyName/version/:policyVersionIdSets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is…
  • GETDescribe provisioning template/provisioning-templates/:templateNameReturns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate action.
  • DELETEDelete provisioning template/provisioning-templates/:templateNameDeletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action.
  • PATCHUpdate provisioning template/provisioning-templates/:templateNameUpdates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.
  • GETDescribe provisioning template version/provisioning-templates/:templateName/versions/:versionIdReturns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.
  • DELETEDelete provisioning template version/provisioning-templates/:templateName/versions/:versionIdDeletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.
  • GETGet registration code/registrationcodeGets 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…
  • DELETEDelete registration code/registrationcodeDeletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.
  • GETGet topic rule destination/destinations/:arnGets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.
  • DELETEDelete topic rule destination/destinations/:arnDeletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.
  • GETList v2 logging levels/v2LoggingLevel?targetType=string&nextToken=string&maxResults=0Lists logging levels. Requires permission to access the ListV2LoggingLevels action.
  • POSTSet v2 logging level/v2LoggingLevelSets the logging level. Requires permission to access the SetV2LoggingLevel action.
  • DELETEDelete v2 logging level/v2LoggingLevel?targetType=string&targetName=stringDeletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.
  • POSTDeprecate thing type/thing-types/:thingTypeName/deprecateDeprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.
  • GETDescribe audit finding/audit/findings/:findingIdGets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit…
  • GETDescribe audit mitigation actions task/audit/mitigationactions/tasks/:taskIdGets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being…
  • POSTStart audit mitigation actions task/audit/mitigationactions/tasks/:taskIdStarts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.
  • POSTDescribe audit suppression/audit/suppressions/describeGets information about a Device Defender audit suppression.
  • GETDescribe audit task/audit/tasks/:taskIdGets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action.
  • GETDescribe detect mitigation actions task/detect/mitigationactions/tasks/:taskIdThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • PUTStart detect mitigation actions task/detect/mitigationactions/tasks/:taskIdThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETDescribe encryption configuration/encryption-configurationRetrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see…
  • PATCHUpdate encryption configuration/encryption-configurationUpdates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web…
  • GETDescribe endpoint/endpoint?endpointType=stringReturns or creates a unique endpoint specific to the Amazon Web Services account making the call. The first time DescribeEndpoint is called, an endpoint is…
  • GETDescribe event configurations/event-configurationsDescribes event configurations. Requires permission to access the DescribeEventConfigurations action.
  • PATCHUpdate event configurations/event-configurationsUpdates the event configurations. Requires permission to access the UpdateEventConfigurations action.
  • GETDescribe index/indices/:indexNameDescribes a search index. Requires permission to access the DescribeIndex action.
  • GETDescribe job execution/things/:thingName/jobs/:jobId?executionNumber=0Describes a job execution. Requires permission to access the DescribeJobExecution action.
  • GETDescribe managed job template/managed-job-templates/:templateName?templateVersion=stringView details of a managed job template.
  • GETDescribe thing registration task/thing-registration-tasks/:taskIdDescribes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.
  • POSTDisable topic rule/rules/:ruleName/disableDisables the rule. Requires permission to access the DisableTopicRule action.
  • POSTEnable topic rule/rules/:ruleName/enableEnables the rule. Requires permission to access the EnableTopicRule action.
  • GETGet behavior model training summaries/behavior-model-training/summaries?securityProfileName=string&maxResults=0&nextToken=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTGet buckets aggregation/indices/bucketsAggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.
  • POSTGet cardinality/indices/cardinalityReturns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.
  • POSTGet effective policies/effective-policies?thingName=stringGets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway. Requires…
  • GETGet indexing configuration/indexing/configGets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.
  • POSTUpdate indexing configuration/indexing/configUpdates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.
  • GETGet job document/jobs/:jobId/job-document?beforeSubstitution=trueGets a job document. Requires permission to access the GetJobDocument action.
  • GETGet logging options/loggingOptionsGets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions…
  • POSTSet logging options/loggingOptionsSets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions…
  • GETGet package configuration/package-configurationGets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action.
  • PATCHUpdate package configuration/package-configuration?clientToken=stringUpdates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
  • POSTGet percentiles/indices/percentilesGroups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can…
  • POSTGet statistics/indices/statisticsReturns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation…
  • POSTGet thing connectivity data/things/:thingName/connectivity-dataRetrieves the live connectivity status per device. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet…
  • GETGet v2 logging options/v2LoggingOptions?verbose=trueGets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action.
  • POSTSet v2 logging options/v2LoggingOptionsSets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.
  • GETList active violations/active-violations?thingName=string&securityProfileName=string&behaviorCriteriaType=string&listSuppressedAlerts=true&verificationState=string&nextToken=string&maxResults=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTList attached policies/attached-policies/:target?recursive=true&marker=string&pageSize=0Lists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action.
  • POSTList audit findings/audit/findingsLists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)…
  • GETList audit mitigation actions executions/audit/mitigationactions/executions?taskId=string&actionStatus=string&findingId=string&maxResults=0&nextToken=stringGets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.
  • GETList audit mitigation actions tasks/audit/mitigationactions/tasks?auditTaskId=string&findingId=string&taskStatus=string&maxResults=0&nextToken=string&startTime=string&endTime=stringGets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.
  • POSTList audit suppressions/audit/suppressions/listLists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.
  • GETList audit tasks/audit/tasks?startTime=string&endTime=string&taskType=string&taskStatus=string&nextToken=string&maxResults=0Lists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action.
  • POSTStart on demand audit task/audit/tasksStarts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.
  • GETList authorizers/authorizers?pageSize=0&marker=string&isAscendingOrder=true&status=stringLists the authorizers registered in your account. Requires permission to access the ListAuthorizers action.
  • GETList billing groups/billing-groups?nextToken=string&maxResults=0&namePrefixFilter=stringLists the billing groups you have created. Requires permission to access the ListBillingGroups action.
  • GETList cA certificates/cacertificates?pageSize=0&marker=string&isAscendingOrder=true&templateName=stringLists the CA certificates registered for your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned…
  • GETList certificate providers/certificate-providers?nextToken=string&isAscendingOrder=trueLists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action.
  • GETList certificates by cA/certificates-by-ca/:caCertificateId?pageSize=0&marker=string&isAscendingOrder=trueList the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.
  • POSTList command executions/command-executions?maxResults=0&nextToken=stringList all command executions. You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API…
  • GETList commands/commands?maxResults=0&nextToken=string&namespace=string&commandParameterName=string&sortOrder=stringList all commands in your account.
  • GETList custom metrics/custom-metrics?nextToken=string&maxResults=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList detect mitigation actions executions/detect/mitigationactions/executions?taskId=string&violationId=string&thingName=string&startTime=string&endTime=string&maxResults=0&nextToken=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList detect mitigation actions tasks/detect/mitigationactions/tasks?maxResults=0&nextToken=string&startTime=string&endTime=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList dimensions/dimensions?nextToken=string&maxResults=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList domain configurations/domainConfigurations?marker=string&pageSize=0&serviceType=stringGets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the…
  • GETList fleet metrics/fleet-metrics?nextToken=string&maxResults=0Lists all your fleet metrics. Requires permission to access the ListFleetMetrics action.
  • GETList indices/indices?nextToken=string&maxResults=0Lists the search indices. Requires permission to access the ListIndices action.
  • GETList job executions for job/jobs/:jobId/things?status=string&maxResults=0&nextToken=stringLists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action.
  • GETList job executions for thing/things/:thingName/jobs?status=string&namespaceId=string&maxResults=0&nextToken=string&jobId=stringLists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action.
  • GETList job templates/job-templates?maxResults=0&nextToken=stringReturns a list of job templates. Requires permission to access the ListJobTemplates action.
  • GETList jobs/jobs?status=string&targetSelection=string&maxResults=0&nextToken=string&thingGroupName=string&thingGroupId=string&namespaceId=stringLists jobs. Requires permission to access the ListJobs action.
  • GETList managed job templates/managed-job-templates?templateName=string&maxResults=0&nextToken=stringReturns a list of managed job templates.
  • GETList metric values/metric-values?thingName=string&metricName=string&dimensionName=string&dimensionValueOperator=string&startTime=string&endTime=string&maxResults=0&nextToken=stringLists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified…
  • GETList mitigation actions/mitigationactions/actions?actionType=string&maxResults=0&nextToken=stringGets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action.
  • GETList oTA updates/otaUpdates?maxResults=0&nextToken=string&otaUpdateStatus=stringLists OTA updates. Requires permission to access the ListOTAUpdates action.
  • GETList outgoing certificates/certificates-out-going?pageSize=0&marker=string&isAscendingOrder=trueLists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action.
  • GETList package versions/packages/:packageName/versions?status=string&maxResults=0&nextToken=stringLists the software package versions associated to the account. Requires permission to access the ListPackageVersions action.
  • GETList packages/packages?maxResults=0&nextToken=stringLists the software packages associated to the account. Requires permission to access the ListPackages action.
  • GETList policies/policies?marker=string&pageSize=0&isAscendingOrder=trueLists your policies. Requires permission to access the ListPolicies action.
  • GETList policy principals/policy-principals?marker=string&pageSize=0&isAscendingOrder=trueDeprecated. Lists the principals associated with the specified policy. Note: This action is deprecated and works as expected for backward compatibility, but…
  • GETList principal policies/principal-policies?marker=string&pageSize=0&isAscendingOrder=trueDeprecated. Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format . Note:…
  • GETList principal things/principals/things?nextToken=string&maxResults=0Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or…
  • GETList principal things v2/principals/things-v2?nextToken=string&maxResults=0&thingPrincipalType=stringLists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID. Requires permission to access the…
  • GETList related resources for audit finding/audit/relatedResources?findingId=string&nextToken=string&maxResults=0The related resources of an Audit finding. The following resources can be returned from calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY…
  • GETList role aliases/role-aliases?pageSize=0&marker=string&isAscendingOrder=trueLists the role aliases registered in your account. Requires permission to access the ListRoleAliases action.
  • GETList sbom validation results/packages/:packageName/versions/:versionName/sbom-validation-results?validationResult=string&maxResults=0&nextToken=stringThe validation results for all software bill of materials (SBOM) attached to a specific software package version. Requires permission to access the…
  • GETList scheduled audits/audit/scheduledaudits?nextToken=string&maxResults=0Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits action.
  • GETList security profiles/security-profiles?nextToken=string&maxResults=0&dimensionName=string&metricName=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList security profiles for target/security-profiles-for-target?nextToken=string&maxResults=0&recursive=true&securityProfileTargetArn=stringThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • GETList streams/streams?maxResults=0&nextToken=string&isAscendingOrder=trueLists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action.
  • GETList tags for resource/tags?resourceArn=string&nextToken=stringLists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action.
  • POSTTag resource/tagsAdds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource…
  • POSTList targets for policy/policy-targets/:policyName?marker=string&pageSize=0List targets for the specified policy. Requires permission to access the ListTargetsForPolicy action.
  • GETList thing groups/thing-groups?nextToken=string&maxResults=0&parentGroup=string&namePrefixFilter=string&recursive=trueList the thing groups in your account. Requires permission to access the ListThingGroups action.
  • GETList thing groups for thing/things/:thingName/thing-groups?nextToken=string&maxResults=0List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action.
  • GETList thing principals v2/things/:thingName/principals-v2?nextToken=string&maxResults=0&thingPrincipalType=stringLists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID. Requires permission to access the…
  • GETList thing registration task reports/thing-registration-tasks/:taskId/reports?reportType=string&nextToken=string&maxResults=0Information about the thing registration tasks.
  • GETList thing registration tasks/thing-registration-tasks?nextToken=string&maxResults=0&status=stringList bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.
  • POSTStart thing registration task/thing-registration-tasksCreates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.
  • GETList thing types/thing-types?nextToken=string&maxResults=0&thingTypeName=stringLists the existing thing types. Requires permission to access the ListThingTypes action.
  • GETList things/things?nextToken=string&maxResults=0&attributeName=string&attributeValue=string&thingTypeName=string&usePrefixAttributeValue=trueLists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and…
  • POSTRegister thing/thingsProvisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits…
  • GETList things in billing group/billing-groups/:billingGroupName/things?nextToken=string&maxResults=0Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action.
  • GETList things in thing group/thing-groups/:thingGroupName/things?recursive=true&nextToken=string&maxResults=0Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action.
  • GETList topic rules/rules?topic=string&maxResults=0&nextToken=string&ruleDisabled=trueLists the rules for the specific topic. Requires permission to access the ListTopicRules action.
  • GETList violation events/violation-events?startTime=string&endTime=string&thingName=string&securityProfileName=string&behaviorCriteriaType=string&listSuppressedAlerts=true&verificationState=string&nextToken=string&maxResults=0The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTPut verification state on violation/violations/verification-state/:violationIdThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…
  • POSTRegister cA certificate/cacertificate?setAsActive=true&allowAutoRegistration=trueRegisters a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services…
  • POSTRegister certificate/certificate/register?setAsActive=trueRegisters a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject…
  • POSTRegister certificate without cA/certificate/register-no-caRegister a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT .
  • PATCHReject certificate transfer/reject-certificate-transfer/:certificateIdRejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE . To check…
  • PUTRemove thing from billing group/billing-groups/removeThingFromBillingGroupRemoves the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action. This call is asynchronous. It might take…
  • PUTRemove thing from thing group/thing-groups/removeThingFromThingGroupRemove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a…
  • POSTSearch index/indices/searchSearches the specified index. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's…
  • PUTStop thing registration task/thing-registration-tasks/:taskId/cancelCancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.
  • POSTTest authorization/test-authorization?clientId=stringTests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of…
  • POSTTest invoke authorizer/authorizer/:authorizerName/testTests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that…
  • PATCHTransfer certificate/transfer-certificate/:certificateId?targetAwsAccount=stringTransfers the specified certificate to the specified Amazon Web Services account. Requires permission to access the TransferCertificate action. You can cancel…
  • POSTUntag resource/untagRemoves the given tags (metadata) from the resource. Requires permission to access the UntagResource action.
  • PATCHUpdate audit suppression/audit/suppressions/updateUpdates a Device Defender audit suppression.
  • PUTUpdate thing groups for thing/thing-groups/updateThingGroupsForThingUpdates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.
  • POSTValidate security profile behaviors/security-profile-behaviors/validateThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature,…

API details

Base URL
https://iot.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
272 operations on 161 pathsGET 111POST 63DELETE 40PUT 30PATCH 28
4 marked deprecated
Description format
AWS Smithy model, API version 2015-05-28

How to test the AWS IoT in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept certificate transfer” (PATCH /accept-certificate-transfer/:certificateId?setAsActive=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT?

IoT IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances)… It is listed under IoT & devices and has 272 endpoints.

Who publishes the AWS IoT?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT?

Requests go to https://iot.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT have?

272 operations on 161 paths (111 GET, 63 POST, 40 DELETE, 30 PUT, 28 PATCH).

Is forking the AWS IoT free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.