IoT

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas . You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4  to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide .

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services .

Installation

NPM
npm install @aws-sdk/client-iot
Yarn
yarn add @aws-sdk/client-iot
pnpm
pnpm add @aws-sdk/client-iot

IoTClient Operations

Command
Summary
AcceptCertificateTransferCommand

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.

AddThingToBillingGroupCommand

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup  action.

AddThingToThingGroupCommand

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup  action.

AssociateSbomWithPackageVersionCommand

Associates the selected software bill of materials (SBOM) with a specific software package version.

Requires permission to access the AssociateSbomWithPackageVersion  action.

AssociateTargetsWithJobCommand

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

Requires permission to access the AssociateTargetsWithJob  action.

AttachPolicyCommand

Attaches the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy  action.

AttachPrincipalPolicyCommand

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.

AttachSecurityProfileCommand

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.

AttachThingPrincipalCommand

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.

CancelAuditMitigationActionsTaskCommand

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.

CancelAuditTaskCommand

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.

CancelCertificateTransferCommand

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. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Requires permission to access the CancelCertificateTransfer  action.

CancelDetectMitigationActionsTaskCommand

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask  action.

CancelJobCommand

Cancels a job.

Requires permission to access the CancelJob  action.

CancelJobExecutionCommand

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution  action.

ClearDefaultAuthorizerCommand

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer  action.

ConfirmTopicRuleDestinationCommand

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

Requires permission to access the ConfirmTopicRuleDestination  action.

CreateAuditSuppressionCommand

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression  action.

CreateAuthorizerCommand

Creates an authorizer.

Requires permission to access the CreateAuthorizer  action.

CreateBillingGroupCommand

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

CreateCertificateFromCsrCommand

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 curves. For supported certificates, consult Certificate signing algorithms supported by IoT .

Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.

You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://path"

CreateCertificateProviderCommand

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 Core certificate provider  from Amazon Web Services IoT Core Developer Guide.

Requires permission to access the CreateCertificateProvider  action.

After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning  will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

CreateCommandCommand

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

CreateCustomMetricCommand

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric  action.

CreateDimensionCommand

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

CreateDomainConfigurationCommand

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration  action.

CreateDynamicThingGroupCommand

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup  action.

CreateFleetMetricCommand

Creates a fleet metric.

Requires permission to access the CreateFleetMetric  action.

CreateJobCommand

Creates a job.

Requires permission to access the CreateJob  action.

CreateJobTemplateCommand

Creates a job template.

Requires permission to access the CreateJobTemplate  action.

CreateKeysAndCertificateCommand

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 important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate  action.

CreateMitigationActionCommand

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

CreateOTAUpdateCommand

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate  action.

CreatePackageCommand

Creates an IoT software package that can be deployed to your fleet.

Requires permission to access the CreatePackage  and GetIndexingConfiguration  actions.

CreatePackageVersionCommand

Creates a new version for an existing IoT software package.

Requires permission to access the CreatePackageVersion  and GetIndexingConfiguration  actions.

CreatePolicyCommand

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.

CreatePolicyVersionCommand

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 new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion  action.

CreateProvisioningClaimCommand

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim  action.

CreateProvisioningTemplateCommand

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate  action.

CreateProvisioningTemplateVersionCommand

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion  action.

CreateRoleAliasCommand

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 (Amazon Web Services API)  from the Amazon Web Services Identity and Access Management User Guide.

CreateScheduledAuditCommand

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit  action.

CreateSecurityProfileCommand

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile  action.

CreateStreamCommand

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.

CreateThingCommand

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization  for information about authorizing control plane actions.

Requires permission to access the CreateThing  action.

CreateThingGroupCommand

Create a thing group.

This is a control plane operation. See Authorization  for information about authorizing control plane actions.

If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response.

Requires permission to access the CreateThingGroup  action.

CreateThingTypeCommand

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

CreateTopicRuleCommand

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.

CreateTopicRuleDestinationCommand

Creates a topic rule destination. The destination must be confirmed prior to use.

Requires permission to access the CreateTopicRuleDestination  action.

DeleteAccountAuditConfigurationCommand

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.

DeleteAuditSuppressionCommand

Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression  action.

DeleteAuthorizerCommand

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer  action.

DeleteBillingGroupCommand

Deletes the billing group.

Requires permission to access the DeleteBillingGroup  action.

DeleteCACertificateCommand

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate  action.

DeleteCertificateCommand

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 INACTIVE status.

Requires permission to access the DeleteCertificate  action.

DeleteCertificateProviderCommand

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

DeleteCommandCommand

Delete a command resource.

DeleteCommandExecutionCommand

Delete a command execution.

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

DeleteCustomMetricCommand

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 found using the ListSecurityProfiles  API with metricName set to your custom metric name.

DeleteDimensionCommand

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension  action.

DeleteDomainConfigurationCommand

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration  action.

DeleteDynamicThingGroupCommand

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup  action.

DeleteFleetMetricCommand

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.

DeleteJobCommand

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Requires permission to access the DeleteJob  action.

DeleteJobExecutionCommand

Deletes a job execution.

Requires permission to access the DeleteJobExecution  action.

DeleteJobTemplateCommand

Deletes the specified job template.

DeleteMitigationActionCommand

Deletes a defined mitigation action from your Amazon Web Services accounts.

Requires permission to access the DeleteMitigationAction  action.

DeleteOTAUpdateCommand

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate  action.

DeletePackageCommand

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.

DeletePackageVersionCommand

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.

DeletePolicyCommand

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; and then use the DeletePolicy action to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

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

DeletePolicyVersionCommand

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 to access the DeletePolicyVersion  action.

DeleteProvisioningTemplateCommand

Deletes a provisioning template.

Requires permission to access the DeleteProvisioningTemplate  action.

DeleteProvisioningTemplateVersionCommand

Deletes a provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion  action.

DeleteRegistrationCodeCommand

Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode  action.

DeleteRoleAliasCommand

Deletes a role alias

Requires permission to access the DeleteRoleAlias  action.

DeleteScheduledAuditCommand

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit  action.

DeleteSecurityProfileCommand

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile  action.

DeleteStreamCommand

Deletes a stream.

Requires permission to access the DeleteStream  action.

DeleteThingCommand

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.

DeleteThingGroupCommand

Deletes a thing group.

Requires permission to access the DeleteThingGroup  action.

DeleteThingTypeCommand

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 finally use DeleteThingType to delete the thing type.

Requires permission to access the DeleteThingType  action.

DeleteTopicRuleCommand

Deletes the rule.

Requires permission to access the DeleteTopicRule  action.

DeleteTopicRuleDestinationCommand

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination  action.

DeleteV2LoggingLevelCommand

Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel  action.

DeprecateThingTypeCommand

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType  action.

DescribeAccountAuditConfigurationCommand

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.

DescribeAuditFindingCommand

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.

DescribeAuditMitigationActionsTaskCommand

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.

DescribeAuditSuppressionCommand

Gets information about a Device Defender audit suppression.

DescribeAuditTaskCommand

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask  action.

DescribeAuthorizerCommand

Describes an authorizer.

Requires permission to access the DescribeAuthorizer  action.

DescribeBillingGroupCommand

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup  action.

DescribeCACertificateCommand

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate  action.

DescribeCertificateCommand

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate  action.

DescribeCertificateProviderCommand

Describes a certificate provider.

Requires permission to access the DescribeCertificateProvider  action.

DescribeCustomMetricCommand

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric  action.

DescribeDefaultAuthorizerCommand

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer  action.

DescribeDetectMitigationActionsTaskCommand

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask  action.

DescribeDimensionCommand

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension  action.

DescribeDomainConfigurationCommand

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration  action.

DescribeEndpointCommand

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.

DescribeEventConfigurationsCommand

Describes event configurations.

Requires permission to access the DescribeEventConfigurations  action.

DescribeFleetMetricCommand

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric  action.

DescribeIndexCommand

Describes a search index.

Requires permission to access the DescribeIndex  action.

DescribeJobCommand

Describes a job.

Requires permission to access the DescribeJob  action.

DescribeJobExecutionCommand

Describes a job execution.

Requires permission to access the DescribeJobExecution  action.

DescribeJobTemplateCommand

Returns information about a job template.

DescribeManagedJobTemplateCommand

View details of a managed job template.

DescribeMitigationActionCommand

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction  action.

DescribeProvisioningTemplateCommand

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate  action.

DescribeProvisioningTemplateVersionCommand

Returns information about a provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion  action.

DescribeRoleAliasCommand

Describes a role alias.

Requires permission to access the DescribeRoleAlias  action.

DescribeScheduledAuditCommand

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit  action.

DescribeSecurityProfileCommand

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile  action.

DescribeStreamCommand

Gets information about a stream.

Requires permission to access the DescribeStream  action.

DescribeThingCommand

Gets information about the specified thing.

Requires permission to access the DescribeThing  action.

DescribeThingGroupCommand

Describe a thing group.

Requires permission to access the DescribeThingGroup  action.

DescribeThingRegistrationTaskCommand

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask  action.

DescribeThingTypeCommand

Gets information about the specified thing type.

Requires permission to access the DescribeThingType  action.

DetachPolicyCommand

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.

DetachPrincipalPolicyCommand

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.

DetachSecurityProfileCommand

Disassociates a Device Defender security profile from a thing group or from this account.

Requires permission to access the DetachSecurityProfile  action.

DetachThingPrincipalCommand

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

This call is asynchronous. It might take several seconds for the detachment to propagate.

Requires permission to access the DetachThingPrincipal  action.

DisableTopicRuleCommand

Disables the rule.

Requires permission to access the DisableTopicRule  action.

DisassociateSbomFromPackageVersionCommand

Disassociates the selected software bill of materials (SBOM) from a specific software package version.

Requires permission to access the DisassociateSbomWithPackageVersion  action.

EnableTopicRuleCommand

Enables the rule.

Requires permission to access the EnableTopicRule  action.

GetBehaviorModelTrainingSummariesCommand

Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries  action.

GetBucketsAggregationCommand

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation  action.

GetCardinalityCommand

Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality  action.

GetCommandCommand

Gets information about the specified command.

GetCommandExecutionCommand

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

GetEffectivePoliciesCommand

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.

GetIndexingConfigurationCommand

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration  action.

GetJobDocumentCommand

Gets a job document.

Requires permission to access the GetJobDocument  action.

GetLoggingOptionsCommand

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

Requires permission to access the GetLoggingOptions  action.

GetOTAUpdateCommand

Gets an OTA update.

Requires permission to access the GetOTAUpdate  action.

GetPackageCommand

Gets information about the specified software package.

Requires permission to access the GetPackage  action.

GetPackageConfigurationCommand

Gets information about the specified software package's configuration.

Requires permission to access the GetPackageConfiguration  action.

GetPackageVersionCommand

Gets information about the specified package version.

Requires permission to access the GetPackageVersion  action.

GetPercentilesCommand

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 groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles  action.

GetPolicyCommand

Gets information about the specified policy with the policy document of the default version.

Requires permission to access the GetPolicy  action.

GetPolicyVersionCommand

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion  action.

GetRegistrationCodeCommand

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

GetStatisticsCommand

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.

GetThingConnectivityDataCommand

Retrieves the live connectivity status per device.

GetTopicRuleCommand

Gets information about the rule.

Requires permission to access the GetTopicRule  action.

GetTopicRuleDestinationCommand

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination  action.

GetV2LoggingOptionsCommand

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions  action.

ListActiveViolationsCommand

Lists the active violations for a given Device Defender security profile.

Requires permission to access the ListActiveViolations  action.

ListAttachedPoliciesCommand

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies  action.

ListAuditFindingsCommand

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.

ListAuditMitigationActionsExecutionsCommand

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions  action.

ListAuditMitigationActionsTasksCommand

Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks  action.

ListAuditSuppressionsCommand

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions  action.

ListAuditTasksCommand

Lists the Device Defender audits that have been performed during a given time period.

Requires permission to access the ListAuditTasks  action.

ListAuthorizersCommand

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers  action.

ListBillingGroupsCommand

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups  action.

ListCACertificatesCommand

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.

ListCertificateProvidersCommand

Lists all your certificate providers in your Amazon Web Services account.

Requires permission to access the ListCertificateProviders  action.

ListCertificatesByCACommand

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA  action.

ListCertificatesCommand

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.

ListCommandExecutionsCommand

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 only the commandArn or the thingArn information depending on whether you want to list executions for a specific command or an IoT thing. If you provide both fields, the API will generate an error.

For more information about considerations for using this API, see List command executions in your account (CLI) .

ListCommandsCommand

List all commands in your account.

ListCustomMetricsCommand

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics  action.

ListDetectMitigationActionsExecutionsCommand

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions  action.

ListDetectMitigationActionsTasksCommand

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks  action.

ListDimensionsCommand

List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions  action.

ListDomainConfigurationsCommand

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.

ListFleetMetricsCommand

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics  action.

ListIndicesCommand

Lists the search indices.

Requires permission to access the ListIndices  action.

ListJobExecutionsForJobCommand

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob  action.

ListJobExecutionsForThingCommand

Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing  action.

ListJobTemplatesCommand

Returns a list of job templates.

Requires permission to access the ListJobTemplates  action.

ListJobsCommand

Lists jobs.

Requires permission to access the ListJobs  action.

ListManagedJobTemplatesCommand

Returns a list of managed job templates.

ListMetricValuesCommand

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.

ListMitigationActionsCommand

Gets a list of all mitigation actions that match the specified filter criteria.

Requires permission to access the ListMitigationActions  action.

ListOTAUpdatesCommand

Lists OTA updates.

Requires permission to access the ListOTAUpdates  action.

ListOutgoingCertificatesCommand

Lists certificates that are being transferred but not yet accepted.

Requires permission to access the ListOutgoingCertificates  action.

ListPackageVersionsCommand

Lists the software package versions associated to the account.

Requires permission to access the ListPackageVersions  action.

ListPackagesCommand

Lists the software packages associated to the account.

Requires permission to access the ListPackages  action.

ListPoliciesCommand

Lists your policies.

Requires permission to access the ListPolicies  action.

ListPolicyPrincipalsCommand

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.

ListPolicyVersionsCommand

Lists the versions of the specified policy and identifies the default version.

Requires permission to access the ListPolicyVersions  action.

ListPrincipalPoliciesCommand

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format .

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

Requires permission to access the ListPrincipalPolicies  action.

ListPrincipalThingsCommand

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.

ListPrincipalThingsV2Command

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.

ListProvisioningTemplateVersionsCommand

A list of provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions  action.

ListProvisioningTemplatesCommand

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates  action.

ListRelatedResourcesForAuditFindingCommand

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 DescribeAuditFinding's RelatedResources  but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding  for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

ListRoleAliasesCommand

Lists the role aliases registered in your account.

Requires permission to access the ListRoleAliases  action.

ListSbomValidationResultsCommand

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

Requires permission to access the ListSbomValidationResults  action.

ListScheduledAuditsCommand

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits  action.

ListSecurityProfilesCommand

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.

ListSecurityProfilesForTargetCommand

Lists the Device Defender security profiles attached to a target (thing group).

Requires permission to access the ListSecurityProfilesForTarget  action.

ListStreamsCommand

Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams  action.

ListTagsForResourceCommand

Lists the tags (metadata) you have assigned to the resource.

Requires permission to access the ListTagsForResource  action.

ListTargetsForPolicyCommand

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy  action.

ListTargetsForSecurityProfileCommand

Lists the targets (thing groups) associated with a given Device Defender security profile.

Requires permission to access the ListTargetsForSecurityProfile  action.

ListThingGroupsCommand

List the thing groups in your account.

Requires permission to access the ListThingGroups  action.

ListThingGroupsForThingCommand

List the thing groups to which the specified thing belongs.

Requires permission to access the ListThingGroupsForThing  action.

ListThingPrincipalsCommand

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.

ListThingPrincipalsV2Command

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.

ListThingRegistrationTaskReportsCommand

Information about the thing registration tasks.

ListThingRegistrationTasksCommand

List bulk thing provisioning tasks.

Requires permission to access the ListThingRegistrationTasks  action.

ListThingTypesCommand

Lists the existing thing types.

Requires permission to access the ListThingTypes  action.

ListThingsCommand

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  from the Amazon Web Services IoT Core Developer Guide.

Requires permission to access the ListThings  action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

ListThingsInBillingGroupCommand

Lists the things you have added to the given billing group.

Requires permission to access the ListThingsInBillingGroup  action.

ListThingsInThingGroupCommand

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup  action.

ListTopicRuleDestinationsCommand

Lists all the topic rule destinations in your Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations  action.

ListTopicRulesCommand

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules  action.

ListV2LoggingLevelsCommand

Lists logging levels.

Requires permission to access the ListV2LoggingLevels  action.

ListViolationEventsCommand

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.

PutVerificationStateOnViolationCommand

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

RegisterCACertificateCommand

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 access the RegisterCACertificate  action.

RegisterCertificateCommand

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

RegisterCertificateWithoutCACommand

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

RegisterThingCommand

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

RejectCertificateTransferCommand

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 destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Requires permission to access the RejectCertificateTransfer  action.

RemoveThingFromBillingGroupCommand

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.

RemoveThingFromThingGroupCommand

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.

ReplaceTopicRuleCommand

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.

SearchIndexCommand

The query search index.

Requires permission to access the SearchIndex  action.

SetDefaultAuthorizerCommand

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.

SetDefaultPolicyVersionCommand

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

SetLoggingOptionsCommand

Sets the logging options.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

Requires permission to access the SetLoggingOptions  action.

SetV2LoggingLevelCommand

Sets the logging level.

Requires permission to access the SetV2LoggingLevel  action.

SetV2LoggingOptionsCommand

Sets the logging options for the V2 logging service.

Requires permission to access the SetV2LoggingOptions  action.

StartAuditMitigationActionsTaskCommand

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask  action.

StartDetectMitigationActionsTaskCommand

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask  action.

StartOnDemandAuditTaskCommand

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask  action.

StartThingRegistrationTaskCommand

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask  action.

StopThingRegistrationTaskCommand

Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask  action.

TagResourceCommand

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.

TestAuthorizationCommand

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.

TestInvokeAuthorizerCommand

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.

TransferCertificateCommand

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 acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.

UntagResourceCommand

Removes the given tags (metadata) from the resource.

Requires permission to access the UntagResource  action.

UpdateAccountAuditConfigurationCommand

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.

UpdateAuditSuppressionCommand

Updates a Device Defender audit suppression.

UpdateAuthorizerCommand

Updates an authorizer.

Requires permission to access the UpdateAuthorizer  action.

UpdateBillingGroupCommand

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup  action.

UpdateCACertificateCommand

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate  action.

UpdateCertificateCommand

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 the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

UpdateCertificateProviderCommand

Updates a certificate provider.

Requires permission to access the UpdateCertificateProvider  action.

UpdateCommandCommand

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

UpdateCustomMetricCommand

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric  action.

UpdateDimensionCommand

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.

UpdateDomainConfigurationCommand

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration  action.

UpdateDynamicThingGroupCommand

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup  action.

UpdateEventConfigurationsCommand

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations  action.

UpdateFleetMetricCommand

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric  action.

UpdateIndexingConfigurationCommand

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration  action.

UpdateJobCommand

Updates supported fields of the specified job.

Requires permission to access the UpdateJob  action.

UpdateMitigationActionCommand

Updates the definition for the specified mitigation action.

Requires permission to access the UpdateMitigationAction  action.

UpdatePackageCommand

Updates the supported fields for a specific software package.

Requires permission to access the UpdatePackage  and GetIndexingConfiguration  actions.

UpdatePackageConfigurationCommand

Updates the software package configuration.

Requires permission to access the UpdatePackageConfiguration  and iam:PassRole  actions.

UpdatePackageVersionCommand

Updates the supported fields for a specific package version.

Requires permission to access the UpdatePackageVersion  and GetIndexingConfiguration  actions.

UpdateProvisioningTemplateCommand

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate  action.

UpdateRoleAliasCommand

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 (Amazon Web Services API)  from the Amazon Web Services Identity and Access Management User Guide.

UpdateScheduledAuditCommand

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit  action.

UpdateSecurityProfileCommand

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile  action.

UpdateStreamCommand

Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream  action.

UpdateThingCommand

Updates the data for a thing.

Requires permission to access the UpdateThing  action.

UpdateThingGroupCommand

Update a thing group.

Requires permission to access the UpdateThingGroup  action.

UpdateThingGroupsForThingCommand

Updates the groups to which the thing belongs.

Requires permission to access the UpdateThingGroupsForThing  action.

UpdateThingTypeCommand

Updates a thing type.

UpdateTopicRuleDestinationCommand

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.

ValidateSecurityProfileBehaviorsCommand

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors  action.

IoTClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: IoTClientConfig