aws iot272 CLI commands available for AWS IoT.
| Command | API Operation | Sample |
|---|---|---|
accept-certificate-transferAccepts 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. | AcceptCertificateTransfer | |
add-thing-to-billing-groupAdds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action. | AddThingToBillingGroup | |
add-thing-to-thing-groupAdds a thing to a thing group. Requires permission to access the AddThingToThingGroup action. | AddThingToThingGroup | |
associate-sbom-with-package-versionAssociates the selected software bill of materials (SBOM) with a specific software package version. Requires permission to access the AssociateSbomWithPackageVersion action. | AssociateSbomWithPackageVersion | |
associate-targets-with-jobAssociates 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 | AssociateTargetsWithJob | |
attach-policyAttaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action. | AttachPolicy | |
attach-principal-policyAttaches 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. | AttachPrincipalPolicy | |
attach-security-profileAssociates 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. | AttachSecurityProfile | |
attach-thing-principalAttaches 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. | AttachThingPrincipal | |
cancel-audit-mitigation-actions-taskCancels 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. | CancelAuditMitigationActionsTask | |
cancel-audit-taskCancels 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. | CancelAuditTask | |
cancel-certificate-transferCancels 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 | CancelCertificateTransfer | |
cancel-detect-mitigation-actions-taskCancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action. | CancelDetectMitigationActionsTask | |
cancel-jobCancels a job. Requires permission to access the CancelJob action. | CancelJob | |
cancel-job-executionCancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action. | CancelJobExecution | |
clear-default-authorizerClears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action. | ClearDefaultAuthorizer | |
confirm-topic-rule-destinationConfirms 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 | ConfirmTopicRuleDestination | |
create-audit-suppressionCreates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action. | CreateAuditSuppression | |
create-authorizerCreates an authorizer. Requires permission to access the CreateAuthorizer action. | CreateAuthorizer | |
create-billing-groupCreates 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 | CreateBillingGroup | |
create-certificate-from-csrCreates 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 | CreateCertificateFromCsr | |
create-certificate-providerCreates 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 | CreateCertificateProvider | |
create-commandCreates a command. A command contains reusable configurations that can be applied before they are sent to the devices. | CreateCommand | |
create-custom-metricUse this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action. | CreateCustomMetric | |
create-dimensionCreate 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 | CreateDimension | |
create-domain-configurationCreates a domain configuration. Requires permission to access the CreateDomainConfiguration action. | CreateDomainConfiguration | |
create-dynamic-thing-groupCreates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action. | CreateDynamicThingGroup | |
create-fleet-metricCreates a fleet metric. Requires permission to access the CreateFleetMetric action. | CreateFleetMetric | |
create-jobCreates a job. Requires permission to access the CreateJob action. | CreateJob | |
create-job-templateCreates a job template. Requires permission to access the CreateJobTemplate action. | CreateJobTemplate | |
create-keys-and-certificateCreates 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 | CreateKeysAndCertificate | |
create-mitigation-actionDefines 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 | CreateMitigationAction | |
create-ota-updateCreates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action. | CreateOTAUpdate | |
create-packageCreates an IoT software package that can be deployed to your fleet. Requires permission to access the CreatePackage and GetIndexingConfiguration actions. | CreatePackage | |
create-package-versionCreates a new version for an existing IoT software package. Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions. | CreatePackageVersion | |
create-policyCreates 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. | CreatePolicy | |
create-policy-versionCreates 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 | CreatePolicyVersion | |
create-provisioning-claimCreates a provisioning claim. Requires permission to access the CreateProvisioningClaim action. | CreateProvisioningClaim | |
create-provisioning-templateCreates a provisioning template. Requires permission to access the CreateProvisioningTemplate action. | CreateProvisioningTemplate | |
create-provisioning-template-versionCreates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action. | CreateProvisioningTemplateVersion | |
create-role-aliasCreates 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 | CreateRoleAlias | |
create-scheduled-auditCreates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action. | CreateScheduledAudit | |
create-security-profileCreates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action. | CreateSecurityProfile | |
create-streamCreates 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. | CreateStream | |
create-thingCreates 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 | CreateThing | |
create-thing-groupCreate 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 | CreateThingGroup | |
create-thing-typeCreates 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 | CreateThingType | |
create-topic-ruleCreates 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. | CreateTopicRule | |
create-topic-rule-destinationCreates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action. | CreateTopicRuleDestination | |
delete-account-audit-configurationRestores 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. | DeleteAccountAuditConfiguration | |
delete-audit-suppressionDeletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action. | DeleteAuditSuppression | |
delete-authorizerDeletes an authorizer. Requires permission to access the DeleteAuthorizer action. | DeleteAuthorizer | |
delete-billing-groupDeletes the billing group. Requires permission to access the DeleteBillingGroup action. | DeleteBillingGroup | |
delete-ca-certificateDeletes a registered CA certificate. Requires permission to access the DeleteCACertificate action. | DeleteCACertificate | |
delete-certificateDeletes 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 | DeleteCertificate | |
delete-certificate-providerDeletes 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). | DeleteCertificateProvider | |
delete-commandDelete a command resource. | DeleteCommand | |
delete-command-executionDelete a command execution. Only command executions that enter a terminal state can be deleted from your account. | DeleteCommandExecution | |
delete-custom-metricDeletes 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 | DeleteCustomMetric | |
delete-dimensionRemoves the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action. | DeleteDimension | |
delete-domain-configurationDeletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action. | DeleteDomainConfiguration | |
delete-dynamic-thing-groupDeletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action. | DeleteDynamicThingGroup | |
delete-fleet-metricDeletes 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. | DeleteFleetMetric | |
delete-jobDeletes 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 | DeleteJob | |
delete-job-executionDeletes a job execution. Requires permission to access the DeleteJobExecution action. | DeleteJobExecution | |
delete-job-templateDeletes the specified job template. | DeleteJobTemplate | |
delete-mitigation-actionDeletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action. | DeleteMitigationAction | |
delete-ota-updateDelete an OTA update. Requires permission to access the DeleteOTAUpdate action. | DeleteOTAUpdate | |
delete-packageDeletes 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. | DeletePackage | |
delete-package-versionDeletes 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. | DeletePackageVersion | |
delete-policyDeletes 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 | DeletePolicy | |
delete-policy-versionDeletes 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 | DeletePolicyVersion | |
delete-provisioning-templateDeletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action. | DeleteProvisioningTemplate | |
delete-provisioning-template-versionDeletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action. | DeleteProvisioningTemplateVersion | |
delete-registration-codeDeletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action. | DeleteRegistrationCode | |
delete-role-aliasDeletes a role alias Requires permission to access the DeleteRoleAlias action. | DeleteRoleAlias | |
delete-scheduled-auditDeletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action. | DeleteScheduledAudit | |
delete-security-profileDeletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action. | DeleteSecurityProfile | |
delete-streamDeletes a stream. Requires permission to access the DeleteStream action. | DeleteStream | |
delete-thingDeletes 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. | DeleteThing | |
delete-thing-groupDeletes a thing group. Requires permission to access the DeleteThingGroup action. | DeleteThingGroup | |
delete-thing-typeDeletes 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 | DeleteThingType | |
delete-topic-ruleDeletes the rule. Requires permission to access the DeleteTopicRule action. | DeleteTopicRule | |
delete-topic-rule-destinationDeletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action. | DeleteTopicRuleDestination | |
delete-v2-logging-levelDeletes a logging level. Requires permission to access the DeleteV2LoggingLevel action. | DeleteV2LoggingLevel | |
deprecate-thing-typeDeprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action. | DeprecateThingType | |
describe-account-audit-configurationGets 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. | DescribeAccountAuditConfiguration | |
describe-audit-findingGets 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. | DescribeAuditFinding | |
describe-audit-mitigation-actions-taskGets 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. | DescribeAuditMitigationActionsTask | |
describe-audit-suppressionGets information about a Device Defender audit suppression. | DescribeAuditSuppression | |
describe-audit-taskGets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action. | DescribeAuditTask | |
describe-authorizerDescribes an authorizer. Requires permission to access the DescribeAuthorizer action. | DescribeAuthorizer | |
describe-billing-groupReturns information about a billing group. Requires permission to access the DescribeBillingGroup action. | DescribeBillingGroup | |
describe-ca-certificateDescribes a registered CA certificate. Requires permission to access the DescribeCACertificate action. | DescribeCACertificate | |
describe-certificateGets information about the specified certificate. Requires permission to access the DescribeCertificate action. | DescribeCertificate | |
describe-certificate-providerDescribes a certificate provider. Requires permission to access the DescribeCertificateProvider action. | DescribeCertificateProvider | |
describe-custom-metricGets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action. | DescribeCustomMetric | |
describe-default-authorizerDescribes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action. | DescribeDefaultAuthorizer | |
describe-detect-mitigation-actions-taskGets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action. | DescribeDetectMitigationActionsTask | |
describe-dimensionProvides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action. | DescribeDimension | |
describe-domain-configurationGets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action. | DescribeDomainConfiguration | |
describe-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 Data encryption at rest in the Amazon Web Services IoT Core Developer Guide. | DescribeEncryptionConfiguration | |
describe-endpointReturns 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. | DescribeEndpoint | |
describe-event-configurationsDescribes event configurations. Requires permission to access the DescribeEventConfigurations action. | DescribeEventConfigurations | |
describe-fleet-metricGets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action. | DescribeFleetMetric | |
describe-indexDescribes a search index. Requires permission to access the DescribeIndex action. | DescribeIndex | |
describe-jobDescribes a job. Requires permission to access the DescribeJob action. | DescribeJob | |
describe-job-executionDescribes a job execution. Requires permission to access the DescribeJobExecution action. | DescribeJobExecution | |
describe-job-templateReturns information about a job template. | DescribeJobTemplate | |
describe-managed-job-templateView details of a managed job template. | DescribeManagedJobTemplate | |
describe-mitigation-actionGets information about a mitigation action. Requires permission to access the DescribeMitigationAction action. | DescribeMitigationAction | |
describe-provisioning-templateReturns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate action. | DescribeProvisioningTemplate | |
describe-provisioning-template-versionReturns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action. | DescribeProvisioningTemplateVersion | |
describe-role-aliasDescribes a role alias. Requires permission to access the DescribeRoleAlias action. | DescribeRoleAlias | |
describe-scheduled-auditGets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action. | DescribeScheduledAudit | |
describe-security-profileGets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action. | DescribeSecurityProfile | |
describe-streamGets information about a stream. Requires permission to access the DescribeStream action. | DescribeStream | |
describe-thingGets information about the specified thing. Requires permission to access the DescribeThing action. | DescribeThing | |
describe-thing-groupDescribe a thing group. Requires permission to access the DescribeThingGroup action. | DescribeThingGroup | |
describe-thing-registration-taskDescribes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action. | DescribeThingRegistrationTask | |
describe-thing-typeGets information about the specified thing type. Requires permission to access the DescribeThingType action. | DescribeThingType | |
detach-policyDetaches 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. | DetachPolicy | |
detach-principal-policyRemoves 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. | DetachPrincipalPolicy | |
detach-security-profileDisassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action. | DetachSecurityProfile | |
detach-thing-principalDetaches 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 | DetachThingPrincipal | |
disable-topic-ruleDisables the rule. Requires permission to access the DisableTopicRule action. | DisableTopicRule | |
disassociate-sbom-from-package-versionDisassociates the selected software bill of materials (SBOM) from a specific software package version. Requires permission to access the DisassociateSbomWithPackageVersion action. | DisassociateSbomFromPackageVersion | |
enable-topic-ruleEnables the rule. Requires permission to access the EnableTopicRule action. | EnableTopicRule | |
get-behavior-model-training-summariesReturns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action. | GetBehaviorModelTrainingSummaries | |
get-buckets-aggregationAggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action. | GetBucketsAggregation | |
get-cardinalityReturns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action. | GetCardinality | |
get-commandGets information about the specified command. | GetCommand | |
get-command-executionGets information about the specific command execution on a single device. | GetCommandExecution | |
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. Requires permission to access the GetEffectivePolicies action. | GetEffectivePolicies | |
get-indexing-configurationGets the indexing configuration. Requires permission to access the GetIndexingConfiguration action. | GetIndexingConfiguration | |
get-job-documentGets a job document. Requires permission to access the GetJobDocument action. | GetJobDocument | |
get-logging-optionsGets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action. | GetLoggingOptions | |
get-ota-updateGets an OTA update. Requires permission to access the GetOTAUpdate action. | GetOTAUpdate | |
get-packageGets information about the specified software package. Requires permission to access the GetPackage action. | GetPackage | |
get-package-configurationGets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action. | GetPackageConfiguration | |
get-package-versionGets information about the specified package version. Requires permission to access the GetPackageVersion action. | GetPackageVersion | |
get-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 specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile grouping | GetPercentiles | |
get-policyGets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action. | GetPolicy | |
get-policy-versionGets information about the specified policy version. Requires permission to access the GetPolicyVersion action. | GetPolicyVersion | |
get-registration-codeGets 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 | GetRegistrationCode | |
get-statisticsReturns 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. | GetStatistics | |
get-thing-connectivity-dataRetrieves the live connectivity status per device. | GetThingConnectivityData | |
get-topic-ruleGets information about the rule. Requires permission to access the GetTopicRule action. | GetTopicRule | |
get-topic-rule-destinationGets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action. | GetTopicRuleDestination | |
get-v2-logging-optionsGets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action. | GetV2LoggingOptions | |
list-active-violationsLists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action. | ListActiveViolations | |
list-attached-policiesLists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action. | ListAttachedPolicies | |
list-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.) Requires permission to access the ListAuditFindings action. | ListAuditFindings | |
list-audit-mitigation-actions-executionsGets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action. | ListAuditMitigationActionsExecutions | |
list-audit-mitigation-actions-tasksGets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action. | ListAuditMitigationActionsTasks | |
list-audit-suppressionsLists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action. | ListAuditSuppressions | |
list-audit-tasksLists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action. | ListAuditTasks | |
list-authorizersLists the authorizers registered in your account. Requires permission to access the ListAuthorizers action. | ListAuthorizers | |
list-billing-groupsLists the billing groups you have created. Requires permission to access the ListBillingGroups action. | ListBillingGroups | |
list-ca-certificatesLists 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. | ListCACertificates | |
list-certificate-providersLists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action. | ListCertificateProviders | |
list-certificatesLists 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. | ListCertificates | |
list-certificates-by-caList the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action. | ListCertificatesByCA | |
list-command-executionsList 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 | ListCommandExecutions | |
list-commandsList all commands in your account. | ListCommands | |
list-custom-metricsLists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action. | ListCustomMetrics | |
list-detect-mitigation-actions-executionsLists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action. | ListDetectMitigationActionsExecutions | |
list-detect-mitigation-actions-tasksList of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action. | ListDetectMitigationActionsTasks | |
list-dimensionsList the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action. | ListDimensions | |
list-domain-configurationsGets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action. | ListDomainConfigurations | |
list-fleet-metricsLists all your fleet metrics. Requires permission to access the ListFleetMetrics action. | ListFleetMetrics | |
list-indicesLists the search indices. Requires permission to access the ListIndices action. | ListIndices | |
list-job-executions-for-jobLists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action. | ListJobExecutionsForJob | |
list-job-executions-for-thingLists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action. | ListJobExecutionsForThing | |
list-job-templatesReturns a list of job templates. Requires permission to access the ListJobTemplates action. | ListJobTemplates | |
list-jobsLists jobs. Requires permission to access the ListJobs action. | ListJobs | |
list-managed-job-templatesReturns a list of managed job templates. | ListManagedJobTemplates | |
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. | ListMetricValues | |
list-mitigation-actionsGets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action. | ListMitigationActions | |
list-ota-updatesLists OTA updates. Requires permission to access the ListOTAUpdates action. | ListOTAUpdates | |
list-outgoing-certificatesLists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action. | ListOutgoingCertificates | |
list-package-versionsLists the software package versions associated to the account. Requires permission to access the ListPackageVersions action. | ListPackageVersions | |
list-packagesLists the software packages associated to the account. Requires permission to access the ListPackages action. | ListPackages | |
list-policiesLists your policies. Requires permission to access the ListPolicies action. | ListPolicies | |
list-policy-principalsLists 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. | ListPolicyPrincipals | |
list-policy-versionsLists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action. | ListPolicyVersions | |
list-principal-policiesLists 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 | ListPrincipalPolicies | |
list-principal-thingsLists 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. | ListPrincipalThings | |
list-principal-things-v2Lists 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. | ListPrincipalThingsV2 | |
list-provisioning-template-versionsA list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action. | ListProvisioningTemplateVersions | |
list-provisioning-templatesLists the provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action. | ListProvisioningTemplates | |
list-related-resources-for-audit-findingThe 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 | ListRelatedResourcesForAuditFinding | |
list-role-aliasesLists the role aliases registered in your account. Requires permission to access the ListRoleAliases action. | ListRoleAliases | |
list-sbom-validation-resultsThe validation results for all software bill of materials (SBOM) attached to a specific software package version. Requires permission to access the ListSbomValidationResults action. | ListSbomValidationResults | |
list-scheduled-auditsLists all of your scheduled audits. Requires permission to access the ListScheduledAudits action. | ListScheduledAudits | |
list-security-profilesLists 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. | ListSecurityProfiles | |
list-security-profiles-for-targetLists the Device Defender security profiles attached to a target (thing group). Requires permission to access the ListSecurityProfilesForTarget action. | ListSecurityProfilesForTarget | |
list-streamsLists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action. | ListStreams | |
list-tags-for-resourceLists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action. | ListTagsForResource | |
list-targets-for-policyList targets for the specified policy. Requires permission to access the ListTargetsForPolicy action. | ListTargetsForPolicy | |
list-targets-for-security-profileLists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action. | ListTargetsForSecurityProfile | |
list-thing-groupsList the thing groups in your account. Requires permission to access the ListThingGroups action. | ListThingGroups | |
list-thing-groups-for-thingList the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action. | ListThingGroupsForThing | |
list-thing-principalsLists 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. | ListThingPrincipals | |
list-thing-principals-v2Lists 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. | ListThingPrincipalsV2 | |
list-thing-registration-task-reportsInformation about the thing registration tasks. | ListThingRegistrationTaskReports | |
list-thing-registration-tasksList bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action. | ListThingRegistrationTasks | |
list-thing-typesLists the existing thing types. Requires permission to access the ListThingTypes action. | ListThingTypes | |
list-thingsLists 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 | ListThings | |
list-things-in-billing-groupLists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action. | ListThingsInBillingGroup | |
list-things-in-thing-groupLists the things in the specified group. Requires permission to access the ListThingsInThingGroup action. | ListThingsInThingGroup | |
list-topic-rule-destinationsLists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action. | ListTopicRuleDestinations | |
list-topic-rulesLists the rules for the specific topic. Requires permission to access the ListTopicRules action. | ListTopicRules | |
list-v2-logging-levelsLists logging levels. Requires permission to access the ListV2LoggingLevels action. | ListV2LoggingLevels | |
list-violation-eventsLists 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. | ListViolationEvents | |
put-verification-state-on-violationSet a verification state and provide a description of that verification state on a violation (detect alarm). | PutVerificationStateOnViolation | |
register-ca-certificateRegisters 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 | RegisterCACertificate | |
register-certificateRegisters 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 | RegisterCertificate | |
register-certificate-without-caRegister a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT. | RegisterCertificateWithoutCA | |
register-thingProvisions 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 | RegisterThing | |
reject-certificate-transferRejects 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 | RejectCertificateTransfer | |
remove-thing-from-billing-groupRemoves 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. | RemoveThingFromBillingGroup | |
remove-thing-from-thing-groupRemove 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. | RemoveThingFromThingGroup | |
replace-topic-ruleReplaces 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. | ReplaceTopicRule | |
search-indexThe query search index. Requires permission to access the SearchIndex action. | SearchIndex | |
set-default-authorizerSets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action. | SetDefaultAuthorizer | |
set-default-policy-versionSets 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 | SetDefaultPolicyVersion | |
set-logging-optionsSets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action. | SetLoggingOptions | |
set-v2-logging-levelSets the logging level. Requires permission to access the SetV2LoggingLevel action. | SetV2LoggingLevel | |
set-v2-logging-optionsSets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action. | SetV2LoggingOptions | |
start-audit-mitigation-actions-taskStarts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action. | StartAuditMitigationActionsTask | |
start-detect-mitigation-actions-taskStarts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action. | StartDetectMitigationActionsTask | |
start-on-demand-audit-taskStarts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action. | StartOnDemandAuditTask | |
start-thing-registration-taskCreates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action. | StartThingRegistrationTask | |
stop-thing-registration-taskCancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action. | StopThingRegistrationTask | |
tag-resourceAdds 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. | TagResource | |
test-authorizationTests 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. | TestAuthorization | |
test-invoke-authorizerTests 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. | TestInvokeAuthorizer | |
transfer-certificateTransfers 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 | TransferCertificate | |
untag-resourceRemoves the given tags (metadata) from the resource. Requires permission to access the UntagResource action. | UntagResource | |
update-account-audit-configurationConfigures 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. | UpdateAccountAuditConfiguration | |
update-audit-suppressionUpdates a Device Defender audit suppression. | UpdateAuditSuppression | |
update-authorizerUpdates an authorizer. Requires permission to access the UpdateAuthorizer action. | UpdateAuthorizer | |
update-billing-groupUpdates information about the billing group. Requires permission to access the UpdateBillingGroup action. | UpdateBillingGroup | |
update-ca-certificateUpdates a registered CA certificate. Requires permission to access the UpdateCACertificate action. | UpdateCACertificate | |
update-certificateUpdates 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 | UpdateCertificate | |
update-certificate-providerUpdates a certificate provider. Requires permission to access the UpdateCertificateProvider action. | UpdateCertificateProvider | |
update-commandUpdate information about a command or mark a command for deprecation. | UpdateCommand | |
update-custom-metricUpdates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action. | UpdateCustomMetric | |
update-dimensionUpdates 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. | UpdateDimension | |
update-domain-configurationUpdates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action. | UpdateDomainConfiguration | |
update-dynamic-thing-groupUpdates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action. | UpdateDynamicThingGroup | |
update-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 Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, a | UpdateEncryptionConfiguration | |
update-event-configurationsUpdates the event configurations. Requires permission to access the UpdateEventConfigurations action. | UpdateEventConfigurations | |
update-fleet-metricUpdates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action. | UpdateFleetMetric | |
update-indexing-configurationUpdates the search configuration. Requires permission to access the UpdateIndexingConfiguration action. | UpdateIndexingConfiguration | |
update-jobUpdates supported fields of the specified job. Requires permission to access the UpdateJob action. | UpdateJob | |
update-mitigation-actionUpdates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action. | UpdateMitigationAction | |
update-packageUpdates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions. | UpdatePackage | |
update-package-configurationUpdates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions. | UpdatePackageConfiguration | |
update-package-versionUpdates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions. | UpdatePackageVersion | |
update-provisioning-templateUpdates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action. | UpdateProvisioningTemplate | |
update-role-aliasUpdates 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 | UpdateRoleAlias | |
update-scheduled-auditUpdates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action. | UpdateScheduledAudit | |
update-security-profileUpdates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action. | UpdateSecurityProfile | |
update-streamUpdates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action. | UpdateStream | |
update-thingUpdates the data for a thing. Requires permission to access the UpdateThing action. | UpdateThing | |
update-thing-groupUpdate a thing group. Requires permission to access the UpdateThingGroup action. | UpdateThingGroup | |
update-thing-groups-for-thingUpdates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action. | UpdateThingGroupsForThing | |
update-thing-typeUpdates a thing type. | UpdateThingType | |
update-topic-rule-destinationUpdates 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. | UpdateTopicRuleDestination | |
validate-security-profile-behaviorsValidates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action. | ValidateSecurityProfileBehaviors |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterIoT