AWS Fundamentals Logo
AWS Fundamentals
aws iot

AWS AWS IoT CLI Commands

272 CLI commands available for AWS IoT.

CommandSample
accept-certificate-transfer

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.

add-thing-to-billing-group

Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action.

add-thing-to-thing-group

Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup action.

associate-sbom-with-package-version

Associates the selected software bill of materials (SBOM) with a specific software package version. Requires permission to access the AssociateSbomWithPackageVersion action.

associate-targets-with-job

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 pe

attach-policy

Attaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action.

attach-principal-policy

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.

attach-security-profile

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.

attach-thing-principal

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.

cancel-audit-mitigation-actions-task

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. Requires permission to access the CancelAuditMitigationActionsTask action.

cancel-audit-task

Cancels 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. Requires permission to access the CancelAuditTask action.

cancel-certificate-transfer

Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. Af

cancel-detect-mitigation-actions-task

Cancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action.

cancel-job

Cancels a job. Requires permission to access the CancelJob action.

cancel-job-execution

Cancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action.

clear-default-authorizer

Clears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action.

confirm-topic-rule-destination

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the end

create-audit-suppression

Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.

create-authorizer

Creates an authorizer. Requires permission to access the CreateAuthorizer action.

create-billing-group

Creates 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 with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown. Requires permission to access the Cre

create-certificate-from-csr

Creates an X.509 certificate using the specified certificate signing request. Requires permission to access the CreateCertificateFromCsr action. The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521

create-certificate-provider

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT

create-command

Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.

create-custom-metric

Use this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action.

create-dimension

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension. Requires permis

create-domain-configuration

Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action.

create-dynamic-thing-group

Creates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action.

create-fleet-metric

Creates a fleet metric. Requires permission to access the CreateFleetMetric action.

create-job

Creates a job. Requires permission to access the CreateJob action.

create-job-template

Creates a job template. Requires permission to access the CreateJobTemplate action.

create-keys-and-certificate

Creates 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 device, for more information, see Provisioning MQTT API. Note This is the only time IoT issues the private key for this certificate, so it is impo

create-mitigation-action

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change. Requires permissi

create-ota-update

Creates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.

create-package

Creates an IoT software package that can be deployed to your fleet. Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

create-package-version

Creates a new version for an existing IoT software package. Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

create-policy

Creates 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 sets 1 as the policy's default version. Requires permission to access the CreatePolicy action.

create-policy-version

Creates 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 policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the

create-provisioning-claim

Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.

create-provisioning-template

Creates a provisioning template. Requires permission to access the CreateProvisioningTemplate action.

create-provisioning-template-version

Creates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.

create-role-alias

Creates a role alias. Requires permission to access the CreateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (A

create-scheduled-audit

Creates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action.

create-security-profile

Creates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action.

create-stream

Creates 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 a source like S3. You can have one or more files associated with a stream. Requires permission to access the CreateStream action.

create-thing

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. Se

create-thing-group

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 Cre

create-thing-type

Creates 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 with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown. Requires permission to access the CreateT

create-topic-rule

Creates 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 rule. Requires permission to access the CreateTopicRule action.

create-topic-rule-destination

Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.

delete-account-audit-configuration

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. Requires permission to access the DeleteAccountAuditConfiguration action.

delete-audit-suppression

Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.

delete-authorizer

Deletes an authorizer. Requires permission to access the DeleteAuthorizer action.

delete-billing-group

Deletes the billing group. Requires permission to access the DeleteBillingGroup action.

delete-ca-certificate

Deletes a registered CA certificate. Requires permission to access the DeleteCACertificate action.

delete-certificate

Deletes 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 a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the

delete-certificate-provider

Deletes a certificate provider. Requires permission to access the DeleteCertificateProvider action. If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

delete-command

Delete a command resource.

delete-command-execution

Delete a command execution. Only command executions that enter a terminal state can be deleted from your account.

delete-custom-metric

Deletes a Device Defender detect custom metric. Requires permission to access the DeleteCustomMetric action. Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be foun

delete-dimension

Removes the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action.

delete-domain-configuration

Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.

delete-dynamic-thing-group

Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action.

delete-fleet-metric

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist. Requires permission to access the DeleteFleetMetric action.

delete-job

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 who

delete-job-execution

Deletes a job execution. Requires permission to access the DeleteJobExecution action.

delete-job-template

Deletes the specified job template.

delete-mitigation-action

Deletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action.

delete-ota-update

Delete an OTA update. Requires permission to access the DeleteOTAUpdate action.

delete-package

Deletes a specific version from a software package. Note: All package versions must be deleted before deleting the software package. Requires permission to access the DeletePackageVersion action.

delete-package-version

Deletes a specific version from a software package. Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.

delete-policy

Deletes 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 DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate

delete-policy-version

Deletes 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 policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. Requires permission

delete-provisioning-template

Deletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action.

delete-provisioning-template-version

Deletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.

delete-registration-code

Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.

delete-role-alias

Deletes a role alias Requires permission to access the DeleteRoleAlias action.

delete-scheduled-audit

Deletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.

delete-security-profile

Deletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action.

delete-stream

Deletes a stream. Requires permission to access the DeleteStream action.

delete-thing

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.

delete-thing-group

Deletes a thing group. Requires permission to access the DeleteThingGroup action.

delete-thing-type

Deletes 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 calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and fina

delete-topic-rule

Deletes the rule. Requires permission to access the DeleteTopicRule action.

delete-topic-rule-destination

Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.

delete-v2-logging-level

Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.

deprecate-thing-type

Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.

describe-account-audit-configuration

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the DescribeAccountAuditConfiguration action.

describe-audit-finding

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding. Requires permission to access the DescribeAuditFinding action.

describe-audit-mitigation-actions-task

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

describe-audit-suppression

Gets information about a Device Defender audit suppression.

describe-audit-task

Gets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action.

describe-authorizer

Describes an authorizer. Requires permission to access the DescribeAuthorizer action.

describe-billing-group

Returns information about a billing group. Requires permission to access the DescribeBillingGroup action.

describe-ca-certificate

Describes a registered CA certificate. Requires permission to access the DescribeCACertificate action.

describe-certificate

Gets information about the specified certificate. Requires permission to access the DescribeCertificate action.

describe-certificate-provider

Describes a certificate provider. Requires permission to access the DescribeCertificateProvider action.

describe-custom-metric

Gets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action.

describe-default-authorizer

Describes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action.

describe-detect-mitigation-actions-task

Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action.

describe-dimension

Provides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action.

describe-domain-configuration

Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.

describe-encryption-configuration

Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.

describe-endpoint

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call. The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint. Requires permission to access the DescribeEndpoint action.

describe-event-configurations

Describes event configurations. Requires permission to access the DescribeEventConfigurations action.

describe-fleet-metric

Gets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action.

describe-index

Describes a search index. Requires permission to access the DescribeIndex action.

describe-job

Describes a job. Requires permission to access the DescribeJob action.

describe-job-execution

Describes a job execution. Requires permission to access the DescribeJobExecution action.

describe-job-template

Returns information about a job template.

describe-managed-job-template

View details of a managed job template.

describe-mitigation-action

Gets information about a mitigation action. Requires permission to access the DescribeMitigationAction action.

describe-provisioning-template

Returns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate action.

describe-provisioning-template-version

Returns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.

describe-role-alias

Describes a role alias. Requires permission to access the DescribeRoleAlias action.

describe-scheduled-audit

Gets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action.

describe-security-profile

Gets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action.

describe-stream

Gets information about a stream. Requires permission to access the DescribeStream action.

describe-thing

Gets information about the specified thing. Requires permission to access the DescribeThing action.

describe-thing-group

Describe a thing group. Requires permission to access the DescribeThingGroup action.

describe-thing-registration-task

Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.

describe-thing-type

Gets information about the specified thing type. Requires permission to access the DescribeThingType action.

detach-policy

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.

detach-principal-policy

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.

detach-security-profile

Disassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action.

detach-thing-principal

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

disable-topic-rule

Disables the rule. Requires permission to access the DisableTopicRule action.

disassociate-sbom-from-package-version

Disassociates the selected software bill of materials (SBOM) from a specific software package version. Requires permission to access the DisassociateSbomWithPackageVersion action.

enable-topic-rule

Enables the rule. Requires permission to access the EnableTopicRule action.

get-behavior-model-training-summaries

Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.

get-buckets-aggregation

Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.

get-cardinality

Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.

get-command

Gets information about the specified command.

get-command-execution

Gets information about the specific command execution on a single device.

get-effective-policies

Gets 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 permission to access the GetEffectivePolicies action.

get-indexing-configuration

Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.

get-job-document

Gets a job document. Requires permission to access the GetJobDocument action.

get-logging-options

Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action.

get-ota-update

Gets an OTA update. Requires permission to access the GetOTAUpdate action.

get-package

Gets information about the specified software package. Requires permission to access the GetPackage action.

get-package-configuration

Gets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action.

get-package-version

Gets information about the specified package version. Requires permission to access the GetPackageVersion action.

get-percentiles

Groups 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 specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile grouping

get-policy

Gets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.

get-policy-version

Gets information about the specified policy version. Requires permission to access the GetPolicyVersion action.

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 permis

get-statistics

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned. Requires permission to access the GetStatistics action.

get-thing-connectivity-data

Retrieves the live connectivity status per device.

get-topic-rule

Gets information about the rule. Requires permission to access the GetTopicRule action.

get-topic-rule-destination

Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.

get-v2-logging-options

Gets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action.

list-active-violations

Lists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action.

list-attached-policies

Lists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action.

list-audit-findings

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.) Requires permission to access the ListAuditFindings action.

list-audit-mitigation-actions-executions

Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.

list-audit-mitigation-actions-tasks

Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.

list-audit-suppressions

Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.

list-audit-tasks

Lists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action.

list-authorizers

Lists the authorizers registered in your account. Requires permission to access the ListAuthorizers action.

list-billing-groups

Lists the billing groups you have created. Requires permission to access the ListBillingGroups action.

list-ca-certificates

Lists 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 marker to retrieve additional results. Requires permission to access the ListCACertificates action.

list-certificate-providers

Lists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action.

list-certificates

Lists 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 marker to retrieve additional results. Requires permission to access the ListCertificates action.

list-certificates-by-ca

List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.

list-command-executions

List all command executions. You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API will generate an error. You can use this information to retrieve a list of command executions within a specific timeframe. You must provide

list-commands

List all commands in your account.

list-custom-metrics

Lists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action.

list-detect-mitigation-actions-executions

Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.

list-detect-mitigation-actions-tasks

List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.

list-dimensions

List the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action.

list-domain-configurations

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.

list-fleet-metrics

Lists all your fleet metrics. Requires permission to access the ListFleetMetrics action.

list-indices

Lists the search indices. Requires permission to access the ListIndices action.

list-job-executions-for-job

Lists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action.

list-job-executions-for-thing

Lists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action.

list-job-templates

Returns a list of job templates. Requires permission to access the ListJobTemplates action.

list-jobs

Lists jobs. Requires permission to access the ListJobs action.

list-managed-job-templates

Returns a list of managed job templates.

list-metric-values

Lists 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-actions

Gets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action.

list-ota-updates

Lists OTA updates. Requires permission to access the ListOTAUpdates action.

list-outgoing-certificates

Lists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action.

list-package-versions

Lists the software package versions associated to the account. Requires permission to access the ListPackageVersions action.

list-packages

Lists the software packages associated to the account. Requires permission to access the ListPackages action.

list-policies

Lists your policies. Requires permission to access the ListPolicies action.

list-policy-principals

Lists the principals associated with the specified policy. Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead. Requires permission to access the ListPolicyPrincipals action.

list-policy-versions

Lists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.

list-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 permis

list-principal-things

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the ListPrincipalThings action.

list-principal-things-v2

Lists 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 ListPrincipalThings action.

list-provisioning-template-versions

A list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.

list-provisioning-templates

Lists the provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action.

list-related-resources-for-audit-finding

The related resources of an Audit finding. The following resources can be returned from calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY COGNITO_IDENTITY_POOL CLIENT_ID ACCOUNT_SETTINGS ROLE_ALIAS IAM_ROLE ISSUER_CERTIFICATE This API is similar to DescribeAuditFind

list-role-aliases

Lists the role aliases registered in your account. Requires permission to access the ListRoleAliases action.

list-sbom-validation-results

The validation results for all software bill of materials (SBOM) attached to a specific software package version. Requires permission to access the ListSbomValidationResults action.

list-scheduled-audits

Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits action.

list-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.

list-security-profiles-for-target

Lists the Device Defender security profiles attached to a target (thing group). Requires permission to access the ListSecurityProfilesForTarget action.

list-streams

Lists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action.

list-tags-for-resource

Lists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action.

list-targets-for-policy

List targets for the specified policy. Requires permission to access the ListTargetsForPolicy action.

list-targets-for-security-profile

Lists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action.

list-thing-groups

List the thing groups in your account. Requires permission to access the ListThingGroups action.

list-thing-groups-for-thing

List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action.

list-thing-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.

list-thing-principals-v2

Lists 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 ListThingPrincipals action.

list-thing-registration-task-reports

Information about the thing registration tasks.

list-thing-registration-tasks

List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.

list-thing-types

Lists the existing thing types. Requires permission to access the ListThingTypes action.

list-things

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things

list-things-in-billing-group

Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action.

list-things-in-thing-group

Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action.

list-topic-rule-destinations

Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.

list-topic-rules

Lists the rules for the specific topic. Requires permission to access the ListTopicRules action.

list-v2-logging-levels

Lists logging levels. Requires permission to access the ListV2LoggingLevels action.

list-violation-events

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device). Requires permission to access the ListViolationEvents action.

put-verification-state-on-violation

Set a verification state and provide a description of that verification state on a violation (detect alarm).

register-ca-certificate

Registers 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 account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account. Requires permission to acce

register-certificate

Registers 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 field, you must specify the CA certificate that was used to sign the device certificate being registered. Requires permission to access the Regis

register-certificate-without-ca

Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

register-thing

Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permis

reject-certificate-transfer

Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer dest

remove-thing-from-billing-group

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.

remove-thing-from-thing-group

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.

replace-topic-rule

Replaces 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 rules will be able to access data processed by the rule. Requires permission to access the ReplaceTopicRule action.

search-index

The query search index. Requires permission to access the SearchIndex action.

set-default-authorizer

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.

set-default-policy-version

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action. Requires permission to access the SetDefaultPo

set-logging-options

Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action.

set-v2-logging-level

Sets the logging level. Requires permission to access the SetV2LoggingLevel action.

set-v2-logging-options

Sets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.

start-audit-mitigation-actions-task

Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.

start-detect-mitigation-actions-task

Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.

start-on-demand-audit-task

Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.

start-thing-registration-task

Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.

stop-thing-registration-task

Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.

tag-resource

Adds 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 action.

test-authorization

Tests 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 devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action.

test-invoke-authorizer

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestInvokeAuthorizer action.

transfer-certificate

Transfers the specified certificate to the specified Amazon Web Services account. Requires permission to access the TransferCertificate action. You can cancel the transfer until it is accepted by the recipient. No notification is sent to the transfer destination's account. The caller is responsible

untag-resource

Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action.

update-account-audit-configuration

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action.

update-audit-suppression

Updates a Device Defender audit suppression.

update-authorizer

Updates an authorizer. Requires permission to access the UpdateAuthorizer action.

update-billing-group

Updates information about the billing group. Requires permission to access the UpdateBillingGroup action.

update-ca-certificate

Updates a registered CA certificate. Requires permission to access the UpdateCACertificate action.

update-certificate

Updates the status of the specified certificate. This operation is idempotent. Requires permission to access the UpdateCertificate action. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT. Within a few minutes of updating a certificate from th

update-certificate-provider

Updates a certificate provider. Requires permission to access the UpdateCertificateProvider action.

update-command

Update information about a command or mark a command for deprecation.

update-custom-metric

Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.

update-dimension

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action.

update-domain-configuration

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.

update-dynamic-thing-group

Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.

update-encryption-configuration

Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, a

update-event-configurations

Updates the event configurations. Requires permission to access the UpdateEventConfigurations action.

update-fleet-metric

Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.

update-indexing-configuration

Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.

update-job

Updates supported fields of the specified job. Requires permission to access the UpdateJob action.

update-mitigation-action

Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.

update-package

Updates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

update-package-configuration

Updates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

update-package-version

Updates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

update-provisioning-template

Updates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.

update-role-alias

Updates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (A

update-scheduled-audit

Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.

update-security-profile

Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.

update-stream

Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.

update-thing

Updates the data for a thing. Requires permission to access the UpdateThing action.

update-thing-group

Update a thing group. Requires permission to access the UpdateThingGroup action.

update-thing-groups-for-thing

Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.

update-thing-type

Updates a thing type.

update-topic-rule-destination

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.

validate-security-profile-behaviors

Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands272
ServiceIoT