@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IotAsyncClient extends SdkClient
builder() method.
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.
| 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.
Requires permission to access the AcceptCertificateTransfer action.
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.
Requires permission to access the AcceptCertificateTransfer action.
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.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroupRequest - default CompletableFuture<AddThingToBillingGroupResponse> addThingToBillingGroup(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest)
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
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.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroupRequest - default CompletableFuture<AddThingToThingGroupResponse> addThingToThingGroup(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest)
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
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.
Requires permission to access the AssociateTargetsWithJob action.
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.
Requires permission to access the AssociateTargetsWithJob action.
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 the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
attachPolicyRequest - default CompletableFuture<AttachPolicyResponse> attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
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.
Requires permission to access the AttachSecurityProfile action.
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.
Requires permission to access the AttachSecurityProfile action.
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.
Requires permission to access the AttachThingPrincipal action.
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.
Requires permission to access the AttachThingPrincipal action.
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.
Requires permission to access the CancelAuditMitigationActionsTask action.
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.
Requires permission to access the CancelAuditMitigationActionsTask action.
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.
Requires permission to access the CancelAuditTask action.
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.
Requires permission to access the CancelAuditTask action.
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, 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.
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, 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.
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.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTaskRequest - default CompletableFuture<CancelDetectMitigationActionsTaskResponse> cancelDetectMitigationActionsTask(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask 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.
Requires permission to access the CancelJob action.
cancelJobRequest - default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels a job.
Requires permission to access the CancelJob action.
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.
Requires permission to access the CancelJobExecution action.
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.
Requires permission to access the CancelJobExecution action.
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.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizerRequest - default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest)
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
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.
Requires permission to access the ClearDefaultAuthorizer action.
default CompletableFuture<ConfirmTopicRuleDestinationResponse> confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest)
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.
confirmTopicRuleDestinationRequest - default CompletableFuture<ConfirmTopicRuleDestinationResponse> confirmTopicRuleDestination(Consumer<ConfirmTopicRuleDestinationRequest.Builder> confirmTopicRuleDestinationRequest)
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.
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.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppressionRequest - default CompletableFuture<CreateAuditSuppressionResponse> createAuditSuppression(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
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.
Requires permission to access the CreateAuthorizer action.
createAuthorizerRequest - default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
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.
Requires permission to access the CreateBillingGroup action.
createBillingGroupRequest - default CompletableFuture<CreateBillingGroupResponse> createBillingGroup(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest)
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
Requires permission to access the CreateCertificateFromCsr action.
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 Amazon Web Services 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
Requires permission to access the CreateCertificateFromCsr action.
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 Amazon Web Services 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.
Requires permission to access the CreateCustomMetric action.
createCustomMetricRequest - default CompletableFuture<CreateCustomMetricResponse> createCustomMetric(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
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 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.
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 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.
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.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfigurationRequest - default CompletableFuture<CreateDomainConfigurationResponse> createDomainConfiguration(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest)
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
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.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroupRequest - default CompletableFuture<CreateDynamicThingGroupResponse> createDynamicThingGroup(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest)
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
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<CreateFleetMetricResponse> createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetricRequest - default CompletableFuture<CreateFleetMetricResponse> createFleetMetric(Consumer<CreateFleetMetricRequest.Builder> createFleetMetricRequest)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
This is a convenience which creates an instance of the CreateFleetMetricRequest.Builder avoiding the need
to create one manually via CreateFleetMetricRequest.builder()
createFleetMetricRequest - A Consumer that will call methods on CreateFleetMetricRequest.Builder to create a request.default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)
Creates a job.
Requires permission to access the CreateJob action.
createJobRequest - default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job.
Requires permission to access the CreateJob action.
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<CreateJobTemplateResponse> createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplateRequest - default CompletableFuture<CreateJobTemplateResponse> createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
This is a convenience which creates an instance of the CreateJobTemplateRequest.Builder avoiding the need
to create one manually via CreateJobTemplateRequest.builder()
createJobTemplateRequest - A Consumer that will call methods on CreateJobTemplateRequest.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 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.
createKeysAndCertificateRequest - The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
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 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.
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.
Requires permission to access the CreateKeysAndCertificateRequest action.
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 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.
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.
Requires permission to access the CreateMitigationAction action.
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.
Requires permission to access the CreateMitigationAction action.
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 IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOtaUpdateRequest - default CompletableFuture<CreateOtaUpdateResponse> createOTAUpdate(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest)
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
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 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.
createPolicyRequest - The input for the CreatePolicy operation.default CompletableFuture<CreatePolicyResponse> createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest)
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.
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 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.
createPolicyVersionRequest - The input for the CreatePolicyVersion operation.default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest)
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.
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.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaimRequest - default CompletableFuture<CreateProvisioningClaimResponse> createProvisioningClaim(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest)
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
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.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplateRequest - default CompletableFuture<CreateProvisioningTemplateResponse> createProvisioningTemplate(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest)
Creates a fleet provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
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.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersionRequest - default CompletableFuture<CreateProvisioningTemplateVersionResponse> createProvisioningTemplateVersion(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest)
Creates a new version of a fleet provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
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.
Requires permission to access the CreateRoleAlias action.
createRoleAliasRequest - default CompletableFuture<CreateRoleAliasResponse> createRoleAlias(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest)
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
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.
Requires permission to access the CreateScheduledAudit action.
createScheduledAuditRequest - default CompletableFuture<CreateScheduledAuditResponse> createScheduledAudit(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
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.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfileRequest - default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest)
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
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.
Requires permission to access the CreateStream action.
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.
Requires permission to access the CreateStream action.
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.
Requires permission to access the CreateThing action.
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.
Requires permission to access the CreateThing action.
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.
Requires permission to access the CreateThingGroup action.
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.
Requires permission to access the CreateThingGroup action.
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.
Requires permission to access the CreateThingType action.
createThingTypeRequest - The input for the CreateThingType operation.default CompletableFuture<CreateThingTypeResponse> createThingType(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest)
Creates a new thing type.
Requires permission to access the CreateThingType action.
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.
Requires permission to access the CreateTopicRule action.
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.
Requires permission to access the CreateTopicRule action.
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.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestinationRequest - default CompletableFuture<CreateTopicRuleDestinationResponse> createTopicRuleDestination(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest)
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
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.
Requires permission to access the DeleteAccountAuditConfiguration action.
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.
Requires permission to access the DeleteAccountAuditConfiguration action.
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.
Requires permission to access the DeleteAccountAuditConfiguration action.
default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppressionRequest - default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
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.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizerRequest - default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
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.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroupRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteBillingGroupResponse> deleteBillingGroup(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest)
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
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.
Requires permission to access the DeleteCACertificate action.
deleteCaCertificateRequest - Input for the DeleteCACertificate operation.default CompletableFuture<DeleteCaCertificateResponse> deleteCACertificate(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest)
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
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 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.
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 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.
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)
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.
deleteCustomMetricRequest - default CompletableFuture<DeleteCustomMetricResponse> deleteCustomMetric(Consumer<DeleteCustomMetricRequest.Builder> deleteCustomMetricRequest)
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.
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 Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimensionRequest - default CompletableFuture<DeleteDimensionResponse> deleteDimension(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
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.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfigurationRequest - default CompletableFuture<DeleteDomainConfigurationResponse> deleteDomainConfiguration(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
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.
Requires permission to access the DeleteDynamicThingGroup action.
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.
Requires permission to access the DeleteDynamicThingGroup action.
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<DeleteFleetMetricResponse> deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest)
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.
deleteFleetMetricRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteFleetMetricResponse> deleteFleetMetric(Consumer<DeleteFleetMetricRequest.Builder> deleteFleetMetricRequest)
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.
This is a convenience which creates an instance of the DeleteFleetMetricRequest.Builder avoiding the need
to create one manually via DeleteFleetMetricRequest.builder()
deleteFleetMetricRequest - A Consumer that will call methods on DeleteFleetMetricRequest.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.
Requires permission to access the DeleteJob action.
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.
Requires permission to access the DeleteJob action.
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.
Requires permission to access the DeleteJobExecution action.
deleteJobExecutionRequest - force
parameter.default CompletableFuture<DeleteJobExecutionResponse> deleteJobExecution(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest)
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
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<DeleteJobTemplateResponse> deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest)
Deletes the specified job template.
deleteJobTemplateRequest - default CompletableFuture<DeleteJobTemplateResponse> deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest)
Deletes the specified job template.
This is a convenience which creates an instance of the DeleteJobTemplateRequest.Builder avoiding the need
to create one manually via DeleteJobTemplateRequest.builder()
deleteJobTemplateRequest - A Consumer that will call methods on DeleteJobTemplateRequest.Builder to create a request.default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationActionRequest - default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
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.
Requires permission to access the DeleteOTAUpdate action.
deleteOtaUpdateRequest - expectedVersion parameter does not match the latest version in the system.default CompletableFuture<DeleteOtaUpdateResponse> deleteOTAUpdate(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest)
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
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 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.
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 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.
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 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.
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 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.
This is a convenience which creates an instance of the DeletePolicyVersionRequest.Builder avoiding the
need to create one manually via DeletePolicyVersionRequest.builder()