@Generated(value="software.amazon.awssdk:codegen") public interface IotAsyncClient extends SdkClient
builder() method.
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS 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 AWS 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 AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IotAsyncClient create()
IotAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IotAsyncClientBuilder builder()
IotAsyncClient.default CompletableFuture<AcceptCertificateTransferResponse> acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)
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.
acceptCertificateTransferRequest - The input for the AcceptCertificateTransfer operation.default CompletableFuture<AcceptCertificateTransferResponse> acceptCertificateTransfer(Consumer<AcceptCertificateTransferRequest.Builder> acceptCertificateTransferRequest)
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.
This is a convenience which creates an instance of the AcceptCertificateTransferRequest.Builder avoiding
the need to create one manually via AcceptCertificateTransferRequest.builder()
acceptCertificateTransferRequest - A Consumer that will call methods on AcceptCertificateTransferRequest.Builder to create a
request. The input for the AcceptCertificateTransfer operation.default CompletableFuture<AddThingToBillingGroupResponse> addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest)
Adds a thing to a billing group.
addThingToBillingGroupRequest - default CompletableFuture<AddThingToBillingGroupResponse> addThingToBillingGroup(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest)
Adds a thing to a billing group.
This is a convenience which creates an instance of the AddThingToBillingGroupRequest.Builder avoiding the
need to create one manually via AddThingToBillingGroupRequest.builder()
addThingToBillingGroupRequest - A Consumer that will call methods on AddThingToBillingGroupRequest.Builder to create a
request.default CompletableFuture<AddThingToThingGroupResponse> addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.
addThingToThingGroupRequest - default CompletableFuture<AddThingToThingGroupResponse> addThingToThingGroup(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest)
Adds a thing to a thing group.
This is a convenience which creates an instance of the AddThingToThingGroupRequest.Builder avoiding the
need to create one manually via AddThingToThingGroupRequest.builder()
addThingToThingGroupRequest - A Consumer that will call methods on AddThingToThingGroupRequest.Builder to create a
request.default CompletableFuture<AssociateTargetsWithJobResponse> associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest)
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.
associateTargetsWithJobRequest - default CompletableFuture<AssociateTargetsWithJobResponse> associateTargetsWithJob(Consumer<AssociateTargetsWithJobRequest.Builder> associateTargetsWithJobRequest)
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.
This is a convenience which creates an instance of the AssociateTargetsWithJobRequest.Builder avoiding
the need to create one manually via AssociateTargetsWithJobRequest.builder()
associateTargetsWithJobRequest - A Consumer that will call methods on AssociateTargetsWithJobRequest.Builder to create a
request.default CompletableFuture<AttachPolicyResponse> attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy to the specified target.
attachPolicyRequest - default CompletableFuture<AttachPolicyResponse> attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest)
Attaches a policy to the specified target.
This is a convenience which creates an instance of the AttachPolicyRequest.Builder avoiding the need to
create one manually via AttachPolicyRequest.builder()
attachPolicyRequest - A Consumer that will call methods on AttachPolicyRequest.Builder to create a request.default CompletableFuture<AttachSecurityProfileResponse> attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest)
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.
attachSecurityProfileRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<AttachSecurityProfileResponse> attachSecurityProfile(Consumer<AttachSecurityProfileRequest.Builder> attachSecurityProfileRequest)
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.
This is a convenience which creates an instance of the AttachSecurityProfileRequest.Builder avoiding the
need to create one manually via AttachSecurityProfileRequest.builder()
attachSecurityProfileRequest - A Consumer that will call methods on AttachSecurityProfileRequest.Builder to create a
request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<AttachThingPrincipalResponse> attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
attachThingPrincipalRequest - The input for the AttachThingPrincipal operation.default CompletableFuture<AttachThingPrincipalResponse> attachThingPrincipal(Consumer<AttachThingPrincipalRequest.Builder> attachThingPrincipalRequest)
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This is a convenience which creates an instance of the AttachThingPrincipalRequest.Builder avoiding the
need to create one manually via AttachThingPrincipalRequest.builder()
attachThingPrincipalRequest - A Consumer that will call methods on AttachThingPrincipalRequest.Builder to create a
request. The input for the AttachThingPrincipal operation.default CompletableFuture<CancelAuditMitigationActionsTaskResponse> cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
cancelAuditMitigationActionsTaskRequest - default CompletableFuture<CancelAuditMitigationActionsTaskResponse> cancelAuditMitigationActionsTask(Consumer<CancelAuditMitigationActionsTaskRequest.Builder> cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
This is a convenience which creates an instance of the CancelAuditMitigationActionsTaskRequest.Builder
avoiding the need to create one manually via CancelAuditMitigationActionsTaskRequest.builder()
cancelAuditMitigationActionsTaskRequest - A Consumer that will call methods on CancelAuditMitigationActionsTaskRequest.Builder to
create a request.default CompletableFuture<CancelAuditTaskResponse> cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest)
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.
cancelAuditTaskRequest - default CompletableFuture<CancelAuditTaskResponse> cancelAuditTask(Consumer<CancelAuditTaskRequest.Builder> cancelAuditTaskRequest)
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.
This is a convenience which creates an instance of the CancelAuditTaskRequest.Builder avoiding the need
to create one manually via CancelAuditTaskRequest.builder()
cancelAuditTaskRequest - A Consumer that will call methods on CancelAuditTaskRequest.Builder to create a request.default CompletableFuture<CancelCertificateTransferResponse> cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
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, AWS 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.
cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.default CompletableFuture<CancelCertificateTransferResponse> cancelCertificateTransfer(Consumer<CancelCertificateTransferRequest.Builder> cancelCertificateTransferRequest)
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, AWS 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.
This is a convenience which creates an instance of the CancelCertificateTransferRequest.Builder avoiding
the need to create one manually via CancelCertificateTransferRequest.builder()
cancelCertificateTransferRequest - A Consumer that will call methods on CancelCertificateTransferRequest.Builder to create a
request. The input for the CancelCertificateTransfer operation.default CompletableFuture<CancelDetectMitigationActionsTaskResponse> cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
cancelDetectMitigationActionsTaskRequest - default CompletableFuture<CancelDetectMitigationActionsTaskResponse> cancelDetectMitigationActionsTask(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
This is a convenience which creates an instance of the CancelDetectMitigationActionsTaskRequest.Builder
avoiding the need to create one manually via CancelDetectMitigationActionsTaskRequest.builder()
cancelDetectMitigationActionsTaskRequest - A Consumer that will call methods on CancelDetectMitigationActionsTaskRequest.Builder to
create a request.default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job.
cancelJobRequest - default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels a job.
This is a convenience which creates an instance of the CancelJobRequest.Builder avoiding the need to
create one manually via CancelJobRequest.builder()
cancelJobRequest - A Consumer that will call methods on CancelJobRequest.Builder to create a request.default CompletableFuture<CancelJobExecutionResponse> cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
cancelJobExecutionRequest - force
parameter.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<CancelJobExecutionResponse> cancelJobExecution(Consumer<CancelJobExecutionRequest.Builder> cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
This is a convenience which creates an instance of the CancelJobExecutionRequest.Builder avoiding the
need to create one manually via CancelJobExecutionRequest.builder()
cancelJobExecutionRequest - A Consumer that will call methods on CancelJobExecutionRequest.Builder to create a
request.force
parameter.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.
clearDefaultAuthorizerRequest - default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest)
Clears the default authorizer.
This is a convenience which creates an instance of the ClearDefaultAuthorizerRequest.Builder avoiding the
need to create one manually via ClearDefaultAuthorizerRequest.builder()
clearDefaultAuthorizerRequest - A Consumer that will call methods on ClearDefaultAuthorizerRequest.Builder to create a
request.default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer()
Clears the default authorizer.
default CompletableFuture<ConfirmTopicRuleDestinationResponse> confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest)
Confirms a topic rule destination. When you create a rule requiring a destination, AWS 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.
confirmTopicRuleDestinationRequest - default CompletableFuture<ConfirmTopicRuleDestinationResponse> confirmTopicRuleDestination(Consumer<ConfirmTopicRuleDestinationRequest.Builder> confirmTopicRuleDestinationRequest)
Confirms a topic rule destination. When you create a rule requiring a destination, AWS 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.
This is a convenience which creates an instance of the ConfirmTopicRuleDestinationRequest.Builder
avoiding the need to create one manually via ConfirmTopicRuleDestinationRequest.builder()
confirmTopicRuleDestinationRequest - A Consumer that will call methods on ConfirmTopicRuleDestinationRequest.Builder to create
a request.default CompletableFuture<CreateAuditSuppressionResponse> createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
createAuditSuppressionRequest - default CompletableFuture<CreateAuditSuppressionResponse> createAuditSuppression(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
This is a convenience which creates an instance of the CreateAuditSuppressionRequest.Builder avoiding the
need to create one manually via CreateAuditSuppressionRequest.builder()
createAuditSuppressionRequest - A Consumer that will call methods on CreateAuditSuppressionRequest.Builder to create a
request.default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.
createAuthorizerRequest - default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
Creates an authorizer.
This is a convenience which creates an instance of the CreateAuthorizerRequest.Builder avoiding the need
to create one manually via CreateAuthorizerRequest.builder()
createAuthorizerRequest - A Consumer that will call methods on CreateAuthorizerRequest.Builder to create a request.default CompletableFuture<CreateBillingGroupResponse> createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest)
Creates a billing group.
createBillingGroupRequest - default CompletableFuture<CreateBillingGroupResponse> createBillingGroup(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest)
Creates a billing group.
This is a convenience which creates an instance of the CreateBillingGroupRequest.Builder avoiding the
need to create one manually via CreateBillingGroupRequest.builder()
createBillingGroupRequest - A Consumer that will call methods on CreateBillingGroupRequest.Builder to create a
request.default CompletableFuture<CreateCertificateFromCsrResponse> createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.
Note: 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 or NIST P-384 curves.
Note: 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.
Assuming 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 AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run 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"
createCertificateFromCsrRequest - The input for the CreateCertificateFromCsr operation.default CompletableFuture<CreateCertificateFromCsrResponse> createCertificateFromCsr(Consumer<CreateCertificateFromCsrRequest.Builder> createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.
Note: 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 or NIST P-384 curves.
Note: 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.
Assuming 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 AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run 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"
This is a convenience which creates an instance of the CreateCertificateFromCsrRequest.Builder avoiding
the need to create one manually via CreateCertificateFromCsrRequest.builder()
createCertificateFromCsrRequest - A Consumer that will call methods on CreateCertificateFromCsrRequest.Builder to create a
request. The input for the CreateCertificateFromCsr operation.default CompletableFuture<CreateCustomMetricResponse> createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.
createCustomMetricRequest - default CompletableFuture<CreateCustomMetricResponse> createCustomMetric(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.
This is a convenience which creates an instance of the CreateCustomMetricRequest.Builder avoiding the
need to create one manually via CreateCustomMetricRequest.builder()
createCustomMetricRequest - A Consumer that will call methods on CreateCustomMetricRequest.Builder to create a
request.default CompletableFuture<CreateDimensionResponse> createDimension(CreateDimensionRequest createDimensionRequest)
Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS 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.
createDimensionRequest - default CompletableFuture<CreateDimensionResponse> createDimension(Consumer<CreateDimensionRequest.Builder> createDimensionRequest)
Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS 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.
This is a convenience which creates an instance of the CreateDimensionRequest.Builder avoiding the need
to create one manually via CreateDimensionRequest.builder()
createDimensionRequest - A Consumer that will call methods on CreateDimensionRequest.Builder to create a request.default CompletableFuture<CreateDomainConfigurationResponse> createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
createDomainConfigurationRequest - default CompletableFuture<CreateDomainConfigurationResponse> createDomainConfiguration(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest)
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
This is a convenience which creates an instance of the CreateDomainConfigurationRequest.Builder avoiding
the need to create one manually via CreateDomainConfigurationRequest.builder()
createDomainConfigurationRequest - A Consumer that will call methods on CreateDomainConfigurationRequest.Builder to create a
request.default CompletableFuture<CreateDynamicThingGroupResponse> createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.
createDynamicThingGroupRequest - default CompletableFuture<CreateDynamicThingGroupResponse> createDynamicThingGroup(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest)
Creates a dynamic thing group.
This is a convenience which creates an instance of the CreateDynamicThingGroupRequest.Builder avoiding
the need to create one manually via CreateDynamicThingGroupRequest.builder()
createDynamicThingGroupRequest - A Consumer that will call methods on CreateDynamicThingGroupRequest.Builder to create a
request.default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)
Creates a job.
createJobRequest - default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job.
This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.default CompletableFuture<CreateKeysAndCertificateResponse> createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificateRequest - The input for the CreateKeysAndCertificate operation.default CompletableFuture<CreateKeysAndCertificateResponse> createKeysAndCertificate(Consumer<CreateKeysAndCertificateRequest.Builder> createKeysAndCertificateRequest)
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
This is a convenience which creates an instance of the CreateKeysAndCertificateRequest.Builder avoiding
the need to create one manually via CreateKeysAndCertificateRequest.builder()
createKeysAndCertificateRequest - A Consumer that will call methods on CreateKeysAndCertificateRequest.Builder to create a
request. The input for the CreateKeysAndCertificate operation.default CompletableFuture<CreateKeysAndCertificateResponse> createKeysAndCertificate()
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
default CompletableFuture<CreateMitigationActionResponse> createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest)
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.
createMitigationActionRequest - default CompletableFuture<CreateMitigationActionResponse> createMitigationAction(Consumer<CreateMitigationActionRequest.Builder> createMitigationActionRequest)
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.
This is a convenience which creates an instance of the CreateMitigationActionRequest.Builder avoiding the
need to create one manually via CreateMitigationActionRequest.builder()
createMitigationActionRequest - A Consumer that will call methods on CreateMitigationActionRequest.Builder to create a
request.default CompletableFuture<CreateOtaUpdateResponse> createOTAUpdate(CreateOtaUpdateRequest createOtaUpdateRequest)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOtaUpdateRequest - default CompletableFuture<CreateOtaUpdateResponse> createOTAUpdate(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
This is a convenience which creates an instance of the CreateOtaUpdateRequest.Builder avoiding the need
to create one manually via CreateOtaUpdateRequest.builder()
createOtaUpdateRequest - A Consumer that will call methods on CreateOTAUpdateRequest.Builder to create a request.default CompletableFuture<CreatePolicyResponse> createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an AWS 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.
createPolicyRequest - The input for the CreatePolicy operation.default CompletableFuture<CreatePolicyResponse> createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest)
Creates an AWS 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.
This is a convenience which creates an instance of the CreatePolicyRequest.Builder avoiding the need to
create one manually via CreatePolicyRequest.builder()
createPolicyRequest - A Consumer that will call methods on CreatePolicyRequest.Builder to create a request. The
input for the CreatePolicy operation.default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified AWS 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).
createPolicyVersionRequest - The input for the CreatePolicyVersion operation.default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest)
Creates a new version of the specified AWS 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).
This is a convenience which creates an instance of the CreatePolicyVersionRequest.Builder avoiding the
need to create one manually via CreatePolicyVersionRequest.builder()
createPolicyVersionRequest - A Consumer that will call methods on CreatePolicyVersionRequest.Builder to create a
request. The input for the CreatePolicyVersion operation.default CompletableFuture<CreateProvisioningClaimResponse> createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.
createProvisioningClaimRequest - default CompletableFuture<CreateProvisioningClaimResponse> createProvisioningClaim(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest)
Creates a provisioning claim.
This is a convenience which creates an instance of the CreateProvisioningClaimRequest.Builder avoiding
the need to create one manually via CreateProvisioningClaimRequest.builder()
createProvisioningClaimRequest - A Consumer that will call methods on CreateProvisioningClaimRequest.Builder to create a
request.default CompletableFuture<CreateProvisioningTemplateResponse> createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a fleet provisioning template.
createProvisioningTemplateRequest - default CompletableFuture<CreateProvisioningTemplateResponse> createProvisioningTemplate(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest)
Creates a fleet provisioning template.
This is a convenience which creates an instance of the CreateProvisioningTemplateRequest.Builder avoiding
the need to create one manually via CreateProvisioningTemplateRequest.builder()
createProvisioningTemplateRequest - A Consumer that will call methods on CreateProvisioningTemplateRequest.Builder to create a
request.default CompletableFuture<CreateProvisioningTemplateVersionResponse> createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a fleet provisioning template.
createProvisioningTemplateVersionRequest - default CompletableFuture<CreateProvisioningTemplateVersionResponse> createProvisioningTemplateVersion(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest)
Creates a new version of a fleet provisioning template.
This is a convenience which creates an instance of the CreateProvisioningTemplateVersionRequest.Builder
avoiding the need to create one manually via CreateProvisioningTemplateVersionRequest.builder()
createProvisioningTemplateVersionRequest - A Consumer that will call methods on CreateProvisioningTemplateVersionRequest.Builder to
create a request.default CompletableFuture<CreateRoleAliasResponse> createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.
createRoleAliasRequest - default CompletableFuture<CreateRoleAliasResponse> createRoleAlias(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest)
Creates a role alias.
This is a convenience which creates an instance of the CreateRoleAliasRequest.Builder avoiding the need
to create one manually via CreateRoleAliasRequest.builder()
createRoleAliasRequest - A Consumer that will call methods on CreateRoleAliasRequest.Builder to create a request.default CompletableFuture<CreateScheduledAuditResponse> createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
createScheduledAuditRequest - default CompletableFuture<CreateScheduledAuditResponse> createScheduledAudit(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
This is a convenience which creates an instance of the CreateScheduledAuditRequest.Builder avoiding the
need to create one manually via CreateScheduledAuditRequest.builder()
createScheduledAuditRequest - A Consumer that will call methods on CreateScheduledAuditRequest.Builder to create a
request.default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a Device Defender security profile.
createSecurityProfileRequest - default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest)
Creates a Device Defender security profile.
This is a convenience which creates an instance of the CreateSecurityProfileRequest.Builder avoiding the
need to create one manually via CreateSecurityProfileRequest.builder()
createSecurityProfileRequest - A Consumer that will call methods on CreateSecurityProfileRequest.Builder to create a
request.default CompletableFuture<CreateStreamResponse> createStream(CreateStreamRequest createStreamRequest)
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.
createStreamRequest - default CompletableFuture<CreateStreamResponse> createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
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.
This is a convenience which creates an instance of the CreateStreamRequest.Builder avoiding the need to
create one manually via CreateStreamRequest.builder()
createStreamRequest - A Consumer that will call methods on CreateStreamRequest.Builder to create a request.default CompletableFuture<CreateThingResponse> createThing(CreateThingRequest createThingRequest)
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.
createThingRequest - The input for the CreateThing operation.default CompletableFuture<CreateThingResponse> createThing(Consumer<CreateThingRequest.Builder> createThingRequest)
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.
This is a convenience which creates an instance of the CreateThingRequest.Builder avoiding the need to
create one manually via CreateThingRequest.builder()
createThingRequest - A Consumer that will call methods on CreateThingRequest.Builder to create a request. The
input for the CreateThing operation.default CompletableFuture<CreateThingGroupResponse> createThingGroup(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
createThingGroupRequest - default CompletableFuture<CreateThingGroupResponse> createThingGroup(Consumer<CreateThingGroupRequest.Builder> createThingGroupRequest)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
This is a convenience which creates an instance of the CreateThingGroupRequest.Builder avoiding the need
to create one manually via CreateThingGroupRequest.builder()
createThingGroupRequest - A Consumer that will call methods on CreateThingGroupRequest.Builder to create a request.default CompletableFuture<CreateThingTypeResponse> createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
createThingTypeRequest - The input for the CreateThingType operation.default CompletableFuture<CreateThingTypeResponse> createThingType(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest)
Creates a new thing type.
This is a convenience which creates an instance of the CreateThingTypeRequest.Builder avoiding the need
to create one manually via CreateThingTypeRequest.builder()
createThingTypeRequest - A Consumer that will call methods on CreateThingTypeRequest.Builder to create a request.
The input for the CreateThingType operation.default CompletableFuture<CreateTopicRuleResponse> createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
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.
createTopicRuleRequest - The input for the CreateTopicRule operation.default CompletableFuture<CreateTopicRuleResponse> createTopicRule(Consumer<CreateTopicRuleRequest.Builder> createTopicRuleRequest)
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.
This is a convenience which creates an instance of the CreateTopicRuleRequest.Builder avoiding the need
to create one manually via CreateTopicRuleRequest.builder()
createTopicRuleRequest - A Consumer that will call methods on CreateTopicRuleRequest.Builder to create a request.
The input for the CreateTopicRule operation.default CompletableFuture<CreateTopicRuleDestinationResponse> createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest)
Creates a topic rule destination. The destination must be confirmed prior to use.
createTopicRuleDestinationRequest - default CompletableFuture<CreateTopicRuleDestinationResponse> createTopicRuleDestination(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest)
Creates a topic rule destination. The destination must be confirmed prior to use.
This is a convenience which creates an instance of the CreateTopicRuleDestinationRequest.Builder avoiding
the need to create one manually via CreateTopicRuleDestinationRequest.builder()
createTopicRuleDestinationRequest - A Consumer that will call methods on CreateTopicRuleDestinationRequest.Builder to create a
request.default CompletableFuture<DeleteAccountAuditConfigurationResponse> deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest)
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.
deleteAccountAuditConfigurationRequest - default CompletableFuture<DeleteAccountAuditConfigurationResponse> deleteAccountAuditConfiguration(Consumer<DeleteAccountAuditConfigurationRequest.Builder> deleteAccountAuditConfigurationRequest)
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.
This is a convenience which creates an instance of the DeleteAccountAuditConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAccountAuditConfigurationRequest.builder()
deleteAccountAuditConfigurationRequest - A Consumer that will call methods on DeleteAccountAuditConfigurationRequest.Builder to
create a request.default CompletableFuture<DeleteAccountAuditConfigurationResponse> deleteAccountAuditConfiguration()
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.
default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
deleteAuditSuppressionRequest - default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
This is a convenience which creates an instance of the DeleteAuditSuppressionRequest.Builder avoiding the
need to create one manually via DeleteAuditSuppressionRequest.builder()
deleteAuditSuppressionRequest - A Consumer that will call methods on DeleteAuditSuppressionRequest.Builder to create a
request.default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.
deleteAuthorizerRequest - default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
Deletes an authorizer.
This is a convenience which creates an instance of the DeleteAuthorizerRequest.Builder avoiding the need
to create one manually via DeleteAuthorizerRequest.builder()
deleteAuthorizerRequest - A Consumer that will call methods on DeleteAuthorizerRequest.Builder to create a request.default CompletableFuture<DeleteBillingGroupResponse> deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest)
Deletes the billing group.
deleteBillingGroupRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteBillingGroupResponse> deleteBillingGroup(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest)
Deletes the billing group.
This is a convenience which creates an instance of the DeleteBillingGroupRequest.Builder avoiding the
need to create one manually via DeleteBillingGroupRequest.builder()
deleteBillingGroupRequest - A Consumer that will call methods on DeleteBillingGroupRequest.Builder to create a
request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteCaCertificateResponse> deleteCACertificate(DeleteCaCertificateRequest deleteCaCertificateRequest)
Deletes a registered CA certificate.
deleteCaCertificateRequest - Input for the DeleteCACertificate operation.default CompletableFuture<DeleteCaCertificateResponse> deleteCACertificate(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest)
Deletes a registered CA certificate.
This is a convenience which creates an instance of the DeleteCaCertificateRequest.Builder avoiding the
need to create one manually via DeleteCaCertificateRequest.builder()
deleteCaCertificateRequest - A Consumer that will call methods on DeleteCACertificateRequest.Builder to create a
request. Input for the DeleteCACertificate operation.default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest - The input for the DeleteCertificate operation.default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
This is a convenience which creates an instance of the DeleteCertificateRequest.Builder avoiding the need
to create one manually via DeleteCertificateRequest.builder()
deleteCertificateRequest - A Consumer that will call methods on DeleteCertificateRequest.Builder to create a request.
The input for the DeleteCertificate operation.default CompletableFuture<DeleteCustomMetricResponse> deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest)
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.
Deletes a Device Defender detect custom metric.
deleteCustomMetricRequest - default CompletableFuture<DeleteCustomMetricResponse> deleteCustomMetric(Consumer<DeleteCustomMetricRequest.Builder> deleteCustomMetricRequest)
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.
Deletes a Device Defender detect custom metric.
This is a convenience which creates an instance of the DeleteCustomMetricRequest.Builder avoiding the
need to create one manually via DeleteCustomMetricRequest.builder()
deleteCustomMetricRequest - A Consumer that will call methods on DeleteCustomMetricRequest.Builder to create a
request.default CompletableFuture<DeleteDimensionResponse> deleteDimension(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your AWS account.
deleteDimensionRequest - default CompletableFuture<DeleteDimensionResponse> deleteDimension(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest)
Removes the specified dimension from your AWS account.
This is a convenience which creates an instance of the DeleteDimensionRequest.Builder avoiding the need
to create one manually via DeleteDimensionRequest.builder()
deleteDimensionRequest - A Consumer that will call methods on DeleteDimensionRequest.Builder to create a request.default CompletableFuture<DeleteDomainConfigurationResponse> deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
deleteDomainConfigurationRequest - default CompletableFuture<DeleteDomainConfigurationResponse> deleteDomainConfiguration(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
This is a convenience which creates an instance of the DeleteDomainConfigurationRequest.Builder avoiding
the need to create one manually via DeleteDomainConfigurationRequest.builder()
deleteDomainConfigurationRequest - A Consumer that will call methods on DeleteDomainConfigurationRequest.Builder to create a
request.default CompletableFuture<DeleteDynamicThingGroupResponse> deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
deleteDynamicThingGroupRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteDynamicThingGroupResponse> deleteDynamicThingGroup(Consumer<DeleteDynamicThingGroupRequest.Builder> deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
This is a convenience which creates an instance of the DeleteDynamicThingGroupRequest.Builder avoiding
the need to create one manually via DeleteDynamicThingGroupRequest.builder()
deleteDynamicThingGroupRequest - A Consumer that will call methods on DeleteDynamicThingGroupRequest.Builder to create a
request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteJobResponse> deleteJob(DeleteJobRequest deleteJobRequest)
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.
deleteJobRequest - force
parameter.default CompletableFuture<DeleteJobResponse> deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)
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.
This is a convenience which creates an instance of the DeleteJobRequest.Builder avoiding the need to
create one manually via DeleteJobRequest.builder()
deleteJobRequest - A Consumer that will call methods on DeleteJobRequest.Builder to create a request.force
parameter.default CompletableFuture<DeleteJobExecutionResponse> deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
deleteJobExecutionRequest - force
parameter.default CompletableFuture<DeleteJobExecutionResponse> deleteJobExecution(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest)
Deletes a job execution.
This is a convenience which creates an instance of the DeleteJobExecutionRequest.Builder avoiding the
need to create one manually via DeleteJobExecutionRequest.builder()
deleteJobExecutionRequest - A Consumer that will call methods on DeleteJobExecutionRequest.Builder to create a
request.force
parameter.default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your AWS account.
deleteMitigationActionRequest - default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest)
Deletes a defined mitigation action from your AWS account.
This is a convenience which creates an instance of the DeleteMitigationActionRequest.Builder avoiding the
need to create one manually via DeleteMitigationActionRequest.builder()
deleteMitigationActionRequest - A Consumer that will call methods on DeleteMitigationActionRequest.Builder to create a
request.default CompletableFuture<DeleteOtaUpdateResponse> deleteOTAUpdate(DeleteOtaUpdateRequest deleteOtaUpdateRequest)
Delete an OTA update.
deleteOtaUpdateRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteOtaUpdateResponse> deleteOTAUpdate(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest)
Delete an OTA update.
This is a convenience which creates an instance of the DeleteOtaUpdateRequest.Builder avoiding the need
to create one manually via DeleteOtaUpdateRequest.builder()
deleteOtaUpdateRequest - A Consumer that will call methods on DeleteOTAUpdateRequest.Builder to create a request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest)
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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest - The input for the DeletePolicy operation.default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)
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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
This is a convenience which creates an instance of the DeletePolicyRequest.Builder avoiding the need to
create one manually via DeletePolicyRequest.builder()
deletePolicyRequest - A Consumer that will call methods on DeletePolicyRequest.Builder to create a request. The
input for the DeletePolicy operation.default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. 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.
deletePolicyVersionRequest - The input for the DeletePolicyVersion operation.default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest)
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. 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.
This is a convenience which creates an instance of the DeletePolicyVersionRequest.Builder avoiding the
need to create one manually via DeletePolicyVersionRequest.builder()
deletePolicyVersionRequest - A Consumer that will call methods on DeletePolicyVersionRequest.Builder to create a
request. The input for the DeletePolicyVersion operation.default CompletableFuture<DeleteProvisioningTemplateResponse> deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a fleet provisioning template.
deleteProvisioningTemplateRequest - default CompletableFuture<DeleteProvisioningTemplateResponse> deleteProvisioningTemplate(Consumer<DeleteProvisioningTemplateRequest.Builder> deleteProvisioningTemplateRequest)
Deletes a fleet provisioning template.
This is a convenience which creates an instance of the DeleteProvisioningTemplateRequest.Builder avoiding
the need to create one manually via DeleteProvisioningTemplateRequest.builder()
deleteProvisioningTemplateRequest - A Consumer that will call methods on DeleteProvisioningTemplateRequest.Builder to create a
request.default CompletableFuture<DeleteProvisioningTemplateVersionResponse> deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a fleet provisioning template version.
deleteProvisioningTemplateVersionRequest - default CompletableFuture<DeleteProvisioningTemplateVersionResponse> deleteProvisioningTemplateVersion(Consumer<DeleteProvisioningTemplateVersionRequest.Builder> deleteProvisioningTemplateVersionRequest)
Deletes a fleet provisioning template version.
This is a convenience which creates an instance of the DeleteProvisioningTemplateVersionRequest.Builder
avoiding the need to create one manually via DeleteProvisioningTemplateVersionRequest.builder()
deleteProvisioningTemplateVersionRequest - A Consumer that will call methods on DeleteProvisioningTemplateVersionRequest.Builder to
create a request.default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
deleteRegistrationCodeRequest - The input for the DeleteRegistrationCode operation.default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode(Consumer<DeleteRegistrationCodeRequest.Builder> deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
This is a convenience which creates an instance of the DeleteRegistrationCodeRequest.Builder avoiding the
need to create one manually via DeleteRegistrationCodeRequest.builder()
deleteRegistrationCodeRequest - A Consumer that will call methods on DeleteRegistrationCodeRequest.Builder to create a
request. The input for the DeleteRegistrationCode operation.default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode()
Deletes a CA certificate registration code.
default CompletableFuture<DeleteRoleAliasResponse> deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role alias
deleteRoleAliasRequest - default CompletableFuture<DeleteRoleAliasResponse> deleteRoleAlias(Consumer<DeleteRoleAliasRequest.Builder> deleteRoleAliasRequest)
Deletes a role alias
This is a convenience which creates an instance of the DeleteRoleAliasRequest.Builder avoiding the need
to create one manually via DeleteRoleAliasRequest.builder()
deleteRoleAliasRequest - A Consumer that will call methods on DeleteRoleAliasRequest.Builder to create a request.default CompletableFuture<DeleteScheduledAuditResponse> deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest)
Deletes a scheduled audit.
deleteScheduledAuditRequest - default CompletableFuture<DeleteScheduledAuditResponse> deleteScheduledAudit(Consumer<DeleteScheduledAuditRequest.Builder> deleteScheduledAuditRequest)
Deletes a scheduled audit.
This is a convenience which creates an instance of the DeleteScheduledAuditRequest.Builder avoiding the
need to create one manually via DeleteScheduledAuditRequest.builder()
deleteScheduledAuditRequest - A Consumer that will call methods on DeleteScheduledAuditRequest.Builder to create a
request.default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a Device Defender security profile.
deleteSecurityProfileRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest)
Deletes a Device Defender security profile.
This is a convenience which creates an instance of the DeleteSecurityProfileRequest.Builder avoiding the
need to create one manually via DeleteSecurityProfileRequest.builder()
deleteSecurityProfileRequest - A Consumer that will call methods on DeleteSecurityProfileRequest.Builder to create a
request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteStreamResponse> deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.
deleteStreamRequest - default CompletableFuture<DeleteStreamResponse> deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a stream.
This is a convenience which creates an instance of the DeleteStreamRequest.Builder avoiding the need to
create one manually via DeleteStreamRequest.builder()
deleteStreamRequest - A Consumer that will call methods on DeleteStreamRequest.Builder to create a request.default CompletableFuture<DeleteThingResponse> deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
deleteThingRequest - The input for the DeleteThing operation.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteThingResponse> deleteThing(Consumer<DeleteThingRequest.Builder> deleteThingRequest)
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
This is a convenience which creates an instance of the DeleteThingRequest.Builder avoiding the need to
create one manually via DeleteThingRequest.builder()
deleteThingRequest - A Consumer that will call methods on DeleteThingRequest.Builder to create a request. The
input for the DeleteThing operation.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteThingGroupResponse> deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.
deleteThingGroupRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteThingGroupResponse> deleteThingGroup(Consumer<DeleteThingGroupRequest.Builder> deleteThingGroupRequest)
Deletes a thing group.
This is a convenience which creates an instance of the DeleteThingGroupRequest.Builder avoiding the need
to create one manually via DeleteThingGroupRequest.builder()
deleteThingGroupRequest - A Consumer that will call methods on DeleteThingGroupRequest.Builder to create a request.expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteThingTypeResponse> deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
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.
deleteThingTypeRequest - The input for the DeleteThingType operation.default CompletableFuture<DeleteThingTypeResponse> deleteThingType(Consumer<DeleteThingTypeRequest.Builder> deleteThingTypeRequest)
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.
This is a convenience which creates an instance of the DeleteThingTypeRequest.Builder avoiding the need
to create one manually via DeleteThingTypeRequest.builder()
deleteThingTypeRequest - A Consumer that will call methods on DeleteThingTypeRequest.Builder to create a request.
The input for the DeleteThingType operation.default CompletableFuture<DeleteTopicRuleResponse> deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
deleteTopicRuleRequest - The input for the DeleteTopicRule operation.default CompletableFuture<DeleteTopicRuleResponse> deleteTopicRule(Consumer<DeleteTopicRuleRequest.Builder> deleteTopicRuleRequest)
Deletes the rule.
This is a convenience which creates an instance of the DeleteTopicRuleRequest.Builder avoiding the need
to create one manually via DeleteTopicRuleRequest.builder()
deleteTopicRuleRequest - A Consumer that will call methods on DeleteTopicRuleRequest.Builder to create a request.
The input for the DeleteTopicRule operation.default CompletableFuture<DeleteTopicRuleDestinationResponse> deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
deleteTopicRuleDestinationRequest - default CompletableFuture<DeleteTopicRuleDestinationResponse> deleteTopicRuleDestination(Consumer<DeleteTopicRuleDestinationRequest.Builder> deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
This is a convenience which creates an instance of the DeleteTopicRuleDestinationRequest.Builder avoiding
the need to create one manually via DeleteTopicRuleDestinationRequest.builder()
deleteTopicRuleDestinationRequest - A Consumer that will call methods on DeleteTopicRuleDestinationRequest.Builder to create a
request.default CompletableFuture<DeleteV2LoggingLevelResponse> deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.
deleteV2LoggingLevelRequest - default CompletableFuture<DeleteV2LoggingLevelResponse> deleteV2LoggingLevel(Consumer<DeleteV2LoggingLevelRequest.Builder> deleteV2LoggingLevelRequest)
Deletes a logging level.
This is a convenience which creates an instance of the DeleteV2LoggingLevelRequest.Builder avoiding the
need to create one manually via DeleteV2LoggingLevelRequest.builder()
deleteV2LoggingLevelRequest - A Consumer that will call methods on DeleteV2LoggingLevelRequest.Builder to create a
request.default CompletableFuture<DeprecateThingTypeResponse> deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingTypeRequest - The input for the DeprecateThingType operation.default CompletableFuture<DeprecateThingTypeResponse> deprecateThingType(Consumer<DeprecateThingTypeRequest.Builder> deprecateThingTypeRequest)
Deprecates a thing type. You can not associate new things with deprecated thing type.
This is a convenience which creates an instance of the DeprecateThingTypeRequest.Builder avoiding the
need to create one manually via DeprecateThingTypeRequest.builder()
deprecateThingTypeRequest - A Consumer that will call methods on DeprecateThingTypeRequest.Builder to create a
request. The input for the DeprecateThingType operation.default CompletableFuture<DescribeAccountAuditConfigurationResponse> describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest)
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.
describeAccountAuditConfigurationRequest -