aws 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. AWS CLI reference
272 commands Its page in the AWS CLI reference
Commands
accept-certificate-transferAccepts a pending certificate transfer.add-thing-to-billing-groupAdds a thing to a billing group.add-thing-to-thing-groupAdds a thing to a thing group.associate-sbom-with-package-versionAssociates the selected software bill of materials (SBOM) with a specific software package version.associate-targets-with-jobAssociates a group with a continuous job.attach-policyAttaches the specified policy to the specified principal (certificate or other credential).attach-principal-policyAttaches the specified policy to the specified principal (certificate or other credential).attach-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.attach-thing-principalAttaches the specified principal to the specified thing.cancel-audit-mitigation-actions-taskCancels a mitigation action task that is in progress.cancel-audit-taskCancels an audit that is in progress.cancel-certificate-transferCancels a pending transfer for the specified certificate.cancel-detect-mitigation-actions-taskThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.cancel-jobCancels a job.cancel-job-executionCancels the execution of a job for a given thing.clear-default-authorizerClears the default authorizer.confirm-topic-rule-destinationConfirms a topic rule destination.create-audit-suppressionCreates a Device Defender audit suppression.create-authorizerCreates an authorizer.create-billing-groupCreates a billing group.create-certificate-from-csrCreates an X.509 certificate using the specified certificate signing request.create-certificate-providerCreates an Amazon Web Services IoT Core certificate provider.create-commandCreates a command.create-custom-metricThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.create-dimensionThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.create-domain-configurationCreates a domain configuration.create-dynamic-thing-groupCreates a dynamic thing group.create-fleet-metricCreates a fleet metric.create-jobCreates a job.create-job-templateCreates a job template.create-keys-and-certificateCreates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.create-mitigation-actionDefines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.create-ota-updateCreates an IoT OTA update on a target group of things or groups.create-packageCreates an IoT software package that can be deployed to your fleet.create-package-versionCreates a new version for an existing IoT software package.create-policyCreates an IoT policy.create-policy-versionCreates a new version of the specified IoT policy.create-provisioning-claimCreates a provisioning claim.create-provisioning-templateCreates a provisioning template.create-provisioning-template-versionCreates a new version of a provisioning template.create-role-aliasCreates a role alias.create-scheduled-auditCreates a scheduled audit that is run at a specified time interval.create-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.create-streamCreates a stream for delivering one or more large files in chunks over MQTT.create-thingCreates a thing record in the registry.create-thing-groupCreate a thing group.create-thing-typeCreates a new thing type.create-topic-ruleCreates a rule.create-topic-rule-destinationCreates a topic rule destination.delete-account-audit-configurationRestores the default settings for Device Defender audits for this account.delete-audit-suppressionDeletes a Device Defender audit suppression.delete-authorizerDeletes an authorizer.delete-billing-groupDeletes the billing group.delete-ca-certificateDeletes a registered CA certificate.delete-certificateDeletes the specified certificate.delete-certificate-providerDeletes a certificate provider.delete-commandDelete a command resource.delete-command-executionDelete a command execution.delete-custom-metricThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.delete-dimensionThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.delete-domain-configurationDeletes the specified domain configuration.delete-dynamic-thing-groupDeletes a dynamic thing group.delete-fleet-metricDeletes the specified fleet metric.delete-jobDeletes a job and its related job executions.delete-job-executionDeletes a job execution.delete-job-templateDeletes the specified job template.delete-mitigation-actionDeletes a defined mitigation action from your Amazon Web Services accounts.delete-ota-updateDelete an OTA update.delete-packageDeletes a specific version from a software package.delete-package-versionDeletes a specific version from a software package.delete-policyDeletes the specified policy.delete-policy-versionDeletes the specified version of the specified policy.delete-provisioning-templateDeletes a provisioning template.delete-provisioning-template-versionDeletes a provisioning template version.delete-registration-codeDeletes a CA certificate registration code.delete-role-aliasDeletes a role alias Requires permission to access the DeleteRoleAlias action.delete-scheduled-auditDeletes a scheduled audit.delete-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.delete-streamDeletes a stream.delete-thingDeletes the specified thing.delete-thing-groupDeletes a thing group.delete-thing-typeDeletes the specified thing type.delete-topic-ruleDeletes the rule.delete-topic-rule-destinationDeletes a topic rule destination.delete-v2-logging-levelDeletes a logging level.deprecate-thing-typeDeprecates a thing type.describe-account-audit-configurationGets information about the Device Defender audit settings for this account.describe-audit-findingGets information about a single audit finding.describe-audit-mitigation-actions-taskGets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.describe-audit-suppressionGets information about a Device Defender audit suppression.describe-audit-taskGets information about a Device Defender audit.describe-authorizerDescribes an authorizer.describe-billing-groupReturns information about a billing group.describe-ca-certificateDescribes a registered CA certificate.describe-certificateGets information about the specified certificate.describe-certificate-providerDescribes a certificate provider.describe-custom-metricThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.describe-default-authorizerDescribes the default authorizer.describe-detect-mitigation-actions-taskThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.describe-dimensionThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.describe-domain-configurationGets summary information about a domain configuration.describe-encryption-configurationRetrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core.describe-endpointReturns or creates a unique endpoint specific to the Amazon Web Services account making the call.describe-event-configurationsDescribes event configurations.describe-fleet-metricGets information about the specified fleet metric.describe-indexDescribes a search index.describe-jobDescribes a job.describe-job-executionDescribes a job execution.describe-job-templateReturns information about a job template.describe-managed-job-templateView details of a managed job template.describe-mitigation-actionGets information about a mitigation action.describe-provisioning-templateReturns information about a provisioning template.describe-provisioning-template-versionReturns information about a provisioning template version.describe-role-aliasDescribes a role alias.describe-scheduled-auditGets information about a scheduled audit.describe-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.describe-streamGets information about a stream.describe-thingGets information about the specified thing.describe-thing-groupDescribe a thing group.describe-thing-registration-taskDescribes a bulk thing provisioning task.describe-thing-typeGets information about the specified thing type.detach-policyDetaches a policy from the specified target.detach-principal-policyRemoves the specified policy from the specified certificate.detach-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.detach-thing-principalDetaches the specified principal from the specified thing.disable-topic-ruleDisables the rule.disassociate-sbom-from-package-versionDisassociates the selected software bill of materials (SBOM) from a specific software package version.enable-topic-ruleEnables the rule.get-behavior-model-training-summariesThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.get-buckets-aggregationAggregates on indexed data with search queries pertaining to particular fields.get-cardinalityReturns the approximate count of unique values that match the query.get-commandGets information about the specified command.get-command-executionGets information about the specific command execution on a single device.get-effective-policiesGets 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.get-indexing-configurationGets the indexing configuration.get-job-documentGets a job document.get-logging-optionsGets the logging options.get-ota-updateGets an OTA update.get-packageGets information about the specified software package.get-package-configurationGets information about the specified software package's configuration.get-package-versionGets information about the specified package version.get-percentilesGroups the aggregated values that match the query into percentile groupings.get-policyGets information about the specified policy with the policy document of the default version.get-policy-versionGets information about the specified policy version.get-registration-codeGets a registration code used to register a CA certificate with IoT.get-statisticsReturns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.get-thing-connectivity-dataRetrieves the live connectivity status per device.get-topic-ruleGets information about the rule.get-topic-rule-destinationGets information about a topic rule destination.get-v2-logging-optionsGets the fine grained logging options.list-active-violationsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-attached-policiesLists the policies attached to the specified thing group.list-audit-findingsLists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.list-audit-mitigation-actions-executionsGets the status of audit mitigation action tasks that were executed.list-audit-mitigation-actions-tasksGets a list of audit mitigation action tasks that match the specified filters.list-audit-suppressionsLists your Device Defender audit listings.list-audit-tasksLists the Device Defender audits that have been performed during a given time period.list-authorizersLists the authorizers registered in your account.list-billing-groupsLists the billing groups you have created.list-ca-certificatesLists the CA certificates registered for your Amazon Web Services account.list-certificate-providersLists all your certificate providers in your Amazon Web Services account.list-certificatesLists the certificates registered in your Amazon Web Services account.list-certificates-by-caList the device certificates signed by the specified CA certificate.list-command-executionsList all command executions.list-commandsList all commands in your account.list-custom-metricsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-detect-mitigation-actions-executionsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-detect-mitigation-actions-tasksThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-dimensionsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-domain-configurationsGets a list of domain configurations for the user.list-fleet-metricsLists all your fleet metrics.list-indicesLists the search indices.list-job-executions-for-jobLists the job executions for a job.list-job-executions-for-thingLists the job executions for the specified thing.list-job-templatesReturns a list of job templates.list-jobsLists jobs.list-managed-job-templatesReturns a list of managed job templates.list-metric-valuesLists 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 time period.list-mitigation-actionsGets a list of all mitigation actions that match the specified filter criteria.list-ota-updatesLists OTA updates.list-outgoing-certificatesLists certificates that are being transferred but not yet accepted.list-package-versionsLists the software package versions associated to the account.list-packagesLists the software packages associated to the account.list-policiesLists your policies.list-policy-principalsLists the principals associated with the specified policy.list-policy-versionsLists the versions of the specified policy and identifies the default version.list-principal-policiesLists the policies attached to the specified principal.list-principal-thingsLists the things associated with the specified principal.list-principal-things-v2Lists the things associated with the specified principal.list-provisioning-template-versionsA list of provisioning template versions.list-provisioning-templatesLists the provisioning templates in your Amazon Web Services account.list-related-resources-for-audit-findingThe related resources of an Audit finding.list-role-aliasesLists the role aliases registered in your account.list-sbom-validation-resultsThe validation results for all software bill of materials (SBOM) attached to a specific software package version.list-scheduled-auditsLists all of your scheduled audits.list-security-profilesThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-security-profiles-for-targetThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-streamsLists all of the streams in your Amazon Web Services account.list-tags-for-resourceLists the tags (metadata) you have assigned to the resource.list-targets-for-policyList targets for the specified policy.list-targets-for-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.list-thing-groupsList the thing groups in your account.list-thing-groups-for-thingList the thing groups to which the specified thing belongs.list-thing-principalsLists the principals associated with the specified thing.list-thing-principals-v2Lists the principals associated with the specified thing.list-thing-registration-task-reportsInformation about the thing registration tasks.list-thing-registration-tasksList bulk thing provisioning tasks.list-thing-typesLists the existing thing types.list-thingsLists your things.list-things-in-billing-groupLists the things you have added to the given billing group.list-things-in-thing-groupLists the things in the specified group.list-topic-rule-destinationsLists all the topic rule destinations in your Amazon Web Services account.list-topic-rulesLists the rules for the specific topic.list-v2-logging-levelsLists logging levels.list-violation-eventsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.put-verification-state-on-violationThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.register-ca-certificateRegisters a CA certificate with Amazon Web Services IoT Core.register-certificateRegisters a device certificate with IoT in the same certificate mode as the signing CA.register-certificate-without-caRegister a certificate that does not have a certificate authority (CA).register-thingProvisions a thing in the device registry.reject-certificate-transferRejects a pending certificate transfer.remove-thing-from-billing-groupRemoves the given thing from the billing group.remove-thing-from-thing-groupRemove the specified thing from the specified group.replace-topic-ruleReplaces the rule.search-indexSearches the specified index.set-default-authorizerSets the default authorizer.set-default-policy-versionSets the specified version of the specified policy as the policy's default (operative) version.set-logging-optionsSets the logging options.set-v2-logging-levelSets the logging level.set-v2-logging-optionsSets the logging options for the V2 logging service.start-audit-mitigation-actions-taskStarts a task that applies a set of mitigation actions to the specified target.start-detect-mitigation-actions-taskThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.start-on-demand-audit-taskStarts an on-demand Device Defender audit.start-thing-registration-taskCreates a bulk thing provisioning task.stop-thing-registration-taskCancels a bulk thing provisioning task.tag-resourceAdds to or modifies the tags of the given resource.test-authorizationTests if a specified principal is authorized to perform an IoT action on a specified resource.test-invoke-authorizerTests a custom authorization behavior by invoking a specified custom authorizer.transfer-certificateTransfers the specified certificate to the specified Amazon Web Services account.untag-resourceRemoves the given tags (metadata) from the resource.update-account-audit-configurationConfigures or reconfigures the Device Defender audit settings for this account.update-audit-suppressionUpdates a Device Defender audit suppression.update-authorizerUpdates an authorizer.update-billing-groupUpdates information about the billing group.update-ca-certificateUpdates a registered CA certificate.update-certificateUpdates the status of the specified certificate.update-certificate-providerUpdates a certificate provider.update-commandUpdate information about a command or mark a command for deprecation.update-custom-metricThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.update-dimensionThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.update-domain-configurationUpdates values stored in the domain configuration.update-dynamic-thing-groupUpdates a dynamic thing group.update-encryption-configurationUpdates the encryption configuration.update-event-configurationsUpdates the event configurations.update-fleet-metricUpdates the data for a fleet metric.update-indexing-configurationUpdates the search configuration.update-jobUpdates supported fields of the specified job.update-mitigation-actionUpdates the definition for the specified mitigation action.update-packageUpdates the supported fields for a specific software package.update-package-configurationUpdates the software package configuration.update-package-versionUpdates the supported fields for a specific package version.update-provisioning-templateUpdates a provisioning template.update-role-aliasUpdates a role alias.update-scheduled-auditUpdates a scheduled audit, including which checks are performed and how often the audit takes place.update-security-profileThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.update-streamUpdates an existing stream.update-thingUpdates the data for a thing.update-thing-groupUpdate a thing group.update-thing-groups-for-thingUpdates the groups to which the thing belongs.update-thing-typeUpdates a thing type.update-topic-rule-destinationUpdates a topic rule destination.validate-security-profile-behaviorsThe IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.