/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iot; import javax.annotation.Generated; import com.amazonaws.services.iot.model.*; /** * Interface for accessing AWS IoT asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.iot.AbstractAWSIotAsync} instead. *
*
*
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIotAsync extends AWSIot { /** ** 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. *
* * @param acceptCertificateTransferRequest * The input for the AcceptCertificateTransfer operation. * @return A Java Future containing the result of the AcceptCertificateTransfer operation returned by the service. * @sample AWSIotAsync.AcceptCertificateTransfer */ java.util.concurrent.Future* 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. *
* * @param acceptCertificateTransferRequest * The input for the AcceptCertificateTransfer operation. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AcceptCertificateTransfer operation returned by the service. * @sample AWSIotAsyncHandler.AcceptCertificateTransfer */ java.util.concurrent.Future* Adds a thing to a billing group. *
** Requires permission to access the AddThingToBillingGroup action. *
* * @param addThingToBillingGroupRequest * @return A Java Future containing the result of the AddThingToBillingGroup operation returned by the service. * @sample AWSIotAsync.AddThingToBillingGroup */ java.util.concurrent.Future* Adds a thing to a billing group. *
** Requires permission to access the AddThingToBillingGroup action. *
* * @param addThingToBillingGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AddThingToBillingGroup operation returned by the service. * @sample AWSIotAsyncHandler.AddThingToBillingGroup */ java.util.concurrent.Future* Adds a thing to a thing group. *
** Requires permission to access the AddThingToThingGroup action. *
* * @param addThingToThingGroupRequest * @return A Java Future containing the result of the AddThingToThingGroup operation returned by the service. * @sample AWSIotAsync.AddThingToThingGroup */ java.util.concurrent.Future* Adds a thing to a thing group. *
** Requires permission to access the AddThingToThingGroup action. *
* * @param addThingToThingGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AddThingToThingGroup operation returned by the service. * @sample AWSIotAsyncHandler.AddThingToThingGroup */ java.util.concurrent.Future* 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. *
* * @param associateTargetsWithJobRequest * @return A Java Future containing the result of the AssociateTargetsWithJob operation returned by the service. * @sample AWSIotAsync.AssociateTargetsWithJob */ java.util.concurrent.Future* 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. *
* * @param associateTargetsWithJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AssociateTargetsWithJob operation returned by the service. * @sample AWSIotAsyncHandler.AssociateTargetsWithJob */ java.util.concurrent.Future* Attaches the specified policy to the specified principal (certificate or other credential). *
** Requires permission to access the AttachPolicy action. *
* * @param attachPolicyRequest * @return A Java Future containing the result of the AttachPolicy operation returned by the service. * @sample AWSIotAsync.AttachPolicy */ java.util.concurrent.Future* Attaches the specified policy to the specified principal (certificate or other credential). *
** Requires permission to access the AttachPolicy action. *
* * @param attachPolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AttachPolicy operation returned by the service. * @sample AWSIotAsyncHandler.AttachPolicy */ java.util.concurrent.Future* Attaches the specified policy to the specified principal (certificate or other credential). *
** Note: This action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use AttachPolicy instead. *
** Requires permission to access the AttachPrincipalPolicy action. *
* * @param attachPrincipalPolicyRequest * The input for the AttachPrincipalPolicy operation. * @return A Java Future containing the result of the AttachPrincipalPolicy operation returned by the service. * @sample AWSIotAsync.AttachPrincipalPolicy */ @Deprecated java.util.concurrent.Future* Attaches the specified policy to the specified principal (certificate or other credential). *
** Note: This action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use AttachPolicy instead. *
** Requires permission to access the AttachPrincipalPolicy action. *
* * @param attachPrincipalPolicyRequest * The input for the AttachPrincipalPolicy operation. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AttachPrincipalPolicy operation returned by the service. * @sample AWSIotAsyncHandler.AttachPrincipalPolicy */ @Deprecated java.util.concurrent.Future* 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. *
* * @param attachSecurityProfileRequest * @return A Java Future containing the result of the AttachSecurityProfile operation returned by the service. * @sample AWSIotAsync.AttachSecurityProfile */ java.util.concurrent.Future* 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. *
* * @param attachSecurityProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AttachSecurityProfile operation returned by the service. * @sample AWSIotAsyncHandler.AttachSecurityProfile */ java.util.concurrent.Future* Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito * identities or federated identities. *
** Requires permission to access the AttachThingPrincipal action. *
* * @param attachThingPrincipalRequest * The input for the AttachThingPrincipal operation. * @return A Java Future containing the result of the AttachThingPrincipal operation returned by the service. * @sample AWSIotAsync.AttachThingPrincipal */ java.util.concurrent.Future* Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito * identities or federated identities. *
** Requires permission to access the AttachThingPrincipal action. *
* * @param attachThingPrincipalRequest * The input for the AttachThingPrincipal operation. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AttachThingPrincipal operation returned by the service. * @sample AWSIotAsyncHandler.AttachThingPrincipal */ java.util.concurrent.Future* 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. *
* * @param cancelAuditMitigationActionsTaskRequest * @return A Java Future containing the result of the CancelAuditMitigationActionsTask operation returned by the * service. * @sample AWSIotAsync.CancelAuditMitigationActionsTask */ java.util.concurrent.Future* 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. *
* * @param cancelAuditMitigationActionsTaskRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelAuditMitigationActionsTask operation returned by the * service. * @sample AWSIotAsyncHandler.CancelAuditMitigationActionsTask */ java.util.concurrent.Future* 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. *
* * @param cancelAuditTaskRequest * @return A Java Future containing the result of the CancelAuditTask operation returned by the service. * @sample AWSIotAsync.CancelAuditTask */ java.util.concurrent.Future* 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. *
* * @param cancelAuditTaskRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelAuditTask operation returned by the service. * @sample AWSIotAsyncHandler.CancelAuditTask */ java.util.concurrent.Future* 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. *
* * @param cancelCertificateTransferRequest * The input for the CancelCertificateTransfer operation. * @return A Java Future containing the result of the CancelCertificateTransfer operation returned by the service. * @sample AWSIotAsync.CancelCertificateTransfer */ java.util.concurrent.Future* 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. *
* * @param cancelCertificateTransferRequest * The input for the CancelCertificateTransfer operation. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelCertificateTransfer operation returned by the service. * @sample AWSIotAsyncHandler.CancelCertificateTransfer */ java.util.concurrent.Future* Cancels a Device Defender ML Detect mitigation action. *
** Requires permission to access the CancelDetectMitigationActionsTask action. *
* * @param cancelDetectMitigationActionsTaskRequest * @return A Java Future containing the result of the CancelDetectMitigationActionsTask operation returned by the * service. * @sample AWSIotAsync.CancelDetectMitigationActionsTask */ java.util.concurrent.Future* Cancels a Device Defender ML Detect mitigation action. *
** Requires permission to access the CancelDetectMitigationActionsTask action. *
* * @param cancelDetectMitigationActionsTaskRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelDetectMitigationActionsTask operation returned by the * service. * @sample AWSIotAsyncHandler.CancelDetectMitigationActionsTask */ java.util.concurrent.Future* Cancels a job. *
** Requires permission to access the CancelJob action. *
* * @param cancelJobRequest * @return A Java Future containing the result of the CancelJob operation returned by the service. * @sample AWSIotAsync.CancelJob */ java.util.concurrent.Future* Cancels a job. *
** Requires permission to access the CancelJob action. *
* * @param cancelJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelJob operation returned by the service. * @sample AWSIotAsyncHandler.CancelJob */ java.util.concurrent.Future* Cancels the execution of a job for a given thing. *
** Requires permission to access the CancelJobExecution action. *
* * @param cancelJobExecutionRequest * @return A Java Future containing the result of the CancelJobExecution operation returned by the service. * @sample AWSIotAsync.CancelJobExecution */ java.util.concurrent.Future* Cancels the execution of a job for a given thing. *
** Requires permission to access the CancelJobExecution action. *
* * @param cancelJobExecutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelJobExecution operation returned by the service. * @sample AWSIotAsyncHandler.CancelJobExecution */ java.util.concurrent.Future* Clears the default authorizer. *
** Requires permission to access the ClearDefaultAuthorizer action. *
* * @param clearDefaultAuthorizerRequest * @return A Java Future containing the result of the ClearDefaultAuthorizer operation returned by the service. * @sample AWSIotAsync.ClearDefaultAuthorizer */ java.util.concurrent.Future* Clears the default authorizer. *
** Requires permission to access the ClearDefaultAuthorizer action. *
* * @param clearDefaultAuthorizerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ClearDefaultAuthorizer operation returned by the service. * @sample AWSIotAsyncHandler.ClearDefaultAuthorizer */ java.util.concurrent.Future
* 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. *
* * @param confirmTopicRuleDestinationRequest * @return A Java Future containing the result of the ConfirmTopicRuleDestination operation returned by the service. * @sample AWSIotAsync.ConfirmTopicRuleDestination */ java.util.concurrent.Future
* 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. *
* * @param confirmTopicRuleDestinationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ConfirmTopicRuleDestination operation returned by the service. * @sample AWSIotAsyncHandler.ConfirmTopicRuleDestination */ java.util.concurrent.Future* Creates a Device Defender audit suppression. *
** Requires permission to access the CreateAuditSuppression action. *
* * @param createAuditSuppressionRequest * @return A Java Future containing the result of the CreateAuditSuppression operation returned by the service. * @sample AWSIotAsync.CreateAuditSuppression */ java.util.concurrent.Future* Creates a Device Defender audit suppression. *
** Requires permission to access the CreateAuditSuppression action. *
* * @param createAuditSuppressionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateAuditSuppression operation returned by the service. * @sample AWSIotAsyncHandler.CreateAuditSuppression */ java.util.concurrent.Future* Creates an authorizer. *
** Requires permission to access the CreateAuthorizer action. *
* * @param createAuthorizerRequest * @return A Java Future containing the result of the CreateAuthorizer operation returned by the service. * @sample AWSIotAsync.CreateAuthorizer */ java.util.concurrent.Future* Creates an authorizer. *
** Requires permission to access the CreateAuthorizer action. *
* * @param createAuthorizerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateAuthorizer operation returned by the service. * @sample AWSIotAsyncHandler.CreateAuthorizer */ java.util.concurrent.Future* Creates a billing group. *
** Requires permission to access the CreateBillingGroup action. *
* * @param createBillingGroupRequest * @return A Java Future containing the result of the CreateBillingGroup operation returned by the service. * @sample AWSIotAsync.CreateBillingGroup */ java.util.concurrent.Future* Creates a billing group. *
** Requires permission to access the CreateBillingGroup action. *
* * @param createBillingGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateBillingGroup operation returned by the service. * @sample AWSIotAsyncHandler.CreateBillingGroup */ java.util.concurrent.Future* Creates an X.509 certificate using the specified certificate signing request. *
** Requires permission to access the CreateCertificateFromCsr action. *
** The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key * from NIST P-256 or NIST P-384 curves. For supported certificates, consult * Certificate signing algorithms supported by IoT. *
** Reusing the same certificate signing request (CSR) results in a distinct certificate. *
*
* You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
* into that directory, and then specifying that directory on the command line. The following commands show how to
* create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
* located inside of the directory my-csr-directory:
*
* On Linux and OS X, the command is: *
*
* $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
* aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
* corresponding CSR.
*
* You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
* the certificate creation process:
*
* $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
*
* On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*
* Creates an X.509 certificate using the specified certificate signing request. *
** Requires permission to access the CreateCertificateFromCsr action. *
** The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key * from NIST P-256 or NIST P-384 curves. For supported certificates, consult * Certificate signing algorithms supported by IoT. *
** Reusing the same certificate signing request (CSR) results in a distinct certificate. *
*
* You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
* into that directory, and then specifying that directory on the command line. The following commands show how to
* create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
* located inside of the directory my-csr-directory:
*
* On Linux and OS X, the command is: *
*
* $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
* aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
* corresponding CSR.
*
* You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
* the certificate creation process:
*
* $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
*
* On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*
* Use this API to define a Custom Metric published by your devices to Device Defender. *
** Requires permission to access the CreateCustomMetric action. *
* * @param createCustomMetricRequest * @return A Java Future containing the result of the CreateCustomMetric operation returned by the service. * @sample AWSIotAsync.CreateCustomMetric */ java.util.concurrent.Future* Use this API to define a Custom Metric published by your devices to Device Defender. *
** Requires permission to access the CreateCustomMetric action. *
* * @param createCustomMetricRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateCustomMetric operation returned by the service. * @sample AWSIotAsyncHandler.CreateCustomMetric */ java.util.concurrent.Future
* 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. *
* * @param createDimensionRequest * @return A Java Future containing the result of the CreateDimension operation returned by the service. * @sample AWSIotAsync.CreateDimension */ java.util.concurrent.Future
* 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. *
* * @param createDimensionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateDimension operation returned by the service. * @sample AWSIotAsyncHandler.CreateDimension */ java.util.concurrent.Future* Creates a domain configuration. *
** Requires permission to access the CreateDomainConfiguration action. *
* * @param createDomainConfigurationRequest * @return A Java Future containing the result of the CreateDomainConfiguration operation returned by the service. * @sample AWSIotAsync.CreateDomainConfiguration */ java.util.concurrent.Future* Creates a domain configuration. *
** Requires permission to access the CreateDomainConfiguration action. *
* * @param createDomainConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateDomainConfiguration operation returned by the service. * @sample AWSIotAsyncHandler.CreateDomainConfiguration */ java.util.concurrent.Future* Creates a dynamic thing group. *
** Requires permission to access the CreateDynamicThingGroup action. *
* * @param createDynamicThingGroupRequest * @return A Java Future containing the result of the CreateDynamicThingGroup operation returned by the service. * @sample AWSIotAsync.CreateDynamicThingGroup */ java.util.concurrent.Future* Creates a dynamic thing group. *
** Requires permission to access the CreateDynamicThingGroup action. *
* * @param createDynamicThingGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateDynamicThingGroup operation returned by the service. * @sample AWSIotAsyncHandler.CreateDynamicThingGroup */ java.util.concurrent.Future* Creates a fleet metric. *
** Requires permission to access the CreateFleetMetric action. *
* * @param createFleetMetricRequest * @return A Java Future containing the result of the CreateFleetMetric operation returned by the service. * @sample AWSIotAsync.CreateFleetMetric */ java.util.concurrent.Future* Creates a fleet metric. *
** Requires permission to access the CreateFleetMetric action. *
* * @param createFleetMetricRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateFleetMetric operation returned by the service. * @sample AWSIotAsyncHandler.CreateFleetMetric */ java.util.concurrent.Future* Creates a job. *
** Requires permission to access the CreateJob action. *
* * @param createJobRequest * @return A Java Future containing the result of the CreateJob operation returned by the service. * @sample AWSIotAsync.CreateJob */ java.util.concurrent.Future* Creates a job. *
** Requires permission to access the CreateJob action. *
* * @param createJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateJob operation returned by the service. * @sample AWSIotAsyncHandler.CreateJob */ java.util.concurrent.Future* Creates a job template. *
** Requires permission to access the CreateJobTemplate action. *
* * @param createJobTemplateRequest * @return A Java Future containing the result of the CreateJobTemplate operation returned by the service. * @sample AWSIotAsync.CreateJobTemplate */ java.util.concurrent.Future* Creates a job template. *
** Requires permission to access the CreateJobTemplate action. *
* * @param createJobTemplateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateJobTemplate operation returned by the service. * @sample AWSIotAsyncHandler.CreateJobTemplate */ java.util.concurrent.Future
* 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. *
* * @param createKeysAndCertificateRequest * The input for the CreateKeysAndCertificate operation. *
* Requires permission to access the CreateKeysAndCertificateRequest action.
* @return A Java Future containing the result of the CreateKeysAndCertificate operation returned by the service.
* @sample AWSIotAsync.CreateKeysAndCertificate
*/
java.util.concurrent.Future
* Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
*
* 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.
* CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT API.
*
* Requires permission to access the CreateKeysAndCertificateRequest action.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateKeysAndCertificate operation returned by the service.
* @sample AWSIotAsyncHandler.CreateKeysAndCertificate
*/
java.util.concurrent.Future
* 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.
*
* 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.
*
* Creates an IoT OTA update on a target group of things or groups.
*
* Requires permission to access the CreateOTAUpdate action.
*
* Creates an IoT OTA update on a target group of things or groups.
*
* Requires permission to access the CreateOTAUpdate action.
*
* Creates an IoT software package that can be deployed to your fleet.
*
* Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
*
* Creates an IoT software package that can be deployed to your fleet.
*
* Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
*
* Creates a new version for an existing IoT software package.
*
* Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
*
* Creates a new version for an existing IoT software package.
*
* Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Creates a provisioning claim.
*
* Requires permission to access the CreateProvisioningClaim action.
*
* Creates a provisioning claim.
*
* Requires permission to access the CreateProvisioningClaim action.
*
* Creates a provisioning template.
*
* Requires permission to access the CreateProvisioningTemplate action.
*
* Creates a provisioning template.
*
* Requires permission to access the CreateProvisioningTemplate action.
*
* Creates a new version of a provisioning template.
*
* Requires permission to access the CreateProvisioningTemplateVersion action.
*
* Creates a new version of a provisioning template.
*
* Requires permission to access the CreateProvisioningTemplateVersion action.
*
* Creates a role alias.
*
* Requires permission to access the CreateRoleAlias action.
*
* Creates a role alias.
*
* Requires permission to access the CreateRoleAlias action.
*
* Creates a scheduled audit that is run at a specified time interval.
*
* Requires permission to access the CreateScheduledAudit action.
*
* Creates a scheduled audit that is run at a specified time interval.
*
* Requires permission to access the CreateScheduledAudit action.
*
* Creates a Device Defender security profile.
*
* Requires permission to access the CreateSecurityProfile action.
*
* Creates a Device Defender security profile.
*
* Requires permission to access the CreateSecurityProfile action.
*
* 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.
*
* 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.
*
* 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
*
* This is a control plane operation. See Authorization for
* information about authorizing control plane actions.
*
* Requires permission to access the CreateThing action.
*
* 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
*
* This is a control plane operation. See Authorization for
* information about authorizing control plane actions.
*
* Requires permission to access the CreateThing action.
*
* 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.
*
* 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.
*
* Creates a new thing type.
*
* Requires permission to access the CreateThingType action.
*
* Creates a new thing type.
*
* Requires permission to access the CreateThingType action.
*
* 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.
*
* 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.
*
* Creates a topic rule destination. The destination must be confirmed prior to use.
*
* Requires permission to access the CreateTopicRuleDestination action.
*
* Creates a topic rule destination. The destination must be confirmed prior to use.
*
* Requires permission to access the CreateTopicRuleDestination action.
*
* 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.
*
* 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.
*
* Deletes a Device Defender audit suppression.
*
* Requires permission to access the DeleteAuditSuppression action.
*
* Deletes a Device Defender audit suppression.
*
* Requires permission to access the DeleteAuditSuppression action.
*
* Deletes an authorizer.
*
* Requires permission to access the DeleteAuthorizer action.
*
* Deletes an authorizer.
*
* Requires permission to access the DeleteAuthorizer action.
*
* Deletes the billing group.
*
* Requires permission to access the DeleteBillingGroup action.
*
* Deletes the billing group.
*
* Requires permission to access the DeleteBillingGroup action.
*
* Deletes a registered CA certificate.
*
* Requires permission to access the DeleteCACertificate action.
*
* Deletes a registered CA certificate.
*
* Requires permission to access the DeleteCACertificate action.
*
* 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.
*
* 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.
*
* 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
* 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
* Removes the specified dimension from your Amazon Web Services accounts.
*
* Requires permission to access the DeleteDimension action.
*
* Removes the specified dimension from your Amazon Web Services accounts.
*
* Requires permission to access the DeleteDimension action.
*
* Deletes the specified domain configuration.
*
* Requires permission to access the DeleteDomainConfiguration action.
*
* Deletes the specified domain configuration.
*
* Requires permission to access the DeleteDomainConfiguration action.
*
* Deletes a dynamic thing group.
*
* Requires permission to access the DeleteDynamicThingGroup action.
*
* Deletes a dynamic thing group.
*
* Requires permission to access the DeleteDynamicThingGroup action.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Deletes a job execution.
*
* Requires permission to access the DeleteJobExecution action.
*
* Deletes a job execution.
*
* Requires permission to access the DeleteJobExecution action.
*
* Deletes the specified job template.
*
* Deletes the specified job template.
*
* Deletes a defined mitigation action from your Amazon Web Services accounts.
*
* Requires permission to access the DeleteMitigationAction action.
*
* Deletes a defined mitigation action from your Amazon Web Services accounts.
*
* Requires permission to access the DeleteMitigationAction action.
*
* Delete an OTA update.
*
* Requires permission to access the DeleteOTAUpdate action.
*
* Delete an OTA update.
*
* Requires permission to access the DeleteOTAUpdate action.
*
* Deletes a specific version from a software package.
*
* Note: All package versions must be deleted before deleting the software package.
*
* Requires permission to access the DeletePackageVersion action.
*
* Deletes a specific version from a software package.
*
* Note: All package versions must be deleted before deleting the software package.
*
* Requires permission to access the DeletePackageVersion action.
*
* Deletes a specific version from a software package.
*
* Note: If a package version is designated as default, you must remove the designation from the package
* using the UpdatePackage action.
*
* Deletes a specific version from a software package.
*
* Note: If a package version is designated as default, you must remove the designation from the package
* using the UpdatePackage action.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Deletes a provisioning template.
*
* Requires permission to access the DeleteProvisioningTemplate action.
*
* Deletes a provisioning template.
*
* Requires permission to access the DeleteProvisioningTemplate action.
*
* Deletes a provisioning template version.
*
* Requires permission to access the DeleteProvisioningTemplateVersion action.
*
* Deletes a provisioning template version.
*
* Requires permission to access the DeleteProvisioningTemplateVersion action.
*
* Deletes a CA certificate registration code.
*
* Requires permission to access the DeleteRegistrationCode action.
*
* Deletes a CA certificate registration code.
*
* Requires permission to access the DeleteRegistrationCode action.
*
* Deletes a role alias
*
* Requires permission to access the DeleteRoleAlias action.
*
* Deletes a role alias
*
* Requires permission to access the DeleteRoleAlias action.
*
* Deletes a scheduled audit.
*
* Requires permission to access the DeleteScheduledAudit action.
*
* Deletes a scheduled audit.
*
* Requires permission to access the DeleteScheduledAudit action.
*
* Deletes a Device Defender security profile.
*
* Requires permission to access the DeleteSecurityProfile action.
*
* Deletes a Device Defender security profile.
*
* Requires permission to access the DeleteSecurityProfile action.
*
* Deletes a stream.
*
* Requires permission to access the DeleteStream action.
*
* Deletes a stream.
*
* Requires permission to access the DeleteStream action.
*
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a
* thing that doesn't exist.
*
* Requires permission to access the DeleteThing action.
*
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a
* thing that doesn't exist.
*
* Requires permission to access the DeleteThing action.
*
* Deletes a thing group.
*
* Requires permission to access the DeleteThingGroup action.
*
* Deletes a thing group.
*
* Requires permission to access the DeleteThingGroup action.
*
* Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a
* thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things
* by calling UpdateThing to change the thing type on any associated thing, and finally use
* DeleteThingType to delete the thing type.
*
* Requires permission to access the DeleteThingType action.
*
* Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a
* thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things
* by calling UpdateThing to change the thing type on any associated thing, and finally use
* DeleteThingType to delete the thing type.
*
* Requires permission to access the DeleteThingType action.
*
* Deletes the rule.
*
* Requires permission to access the DeleteTopicRule action.
*
* Deletes the rule.
*
* Requires permission to access the DeleteTopicRule action.
*
* Deletes a topic rule destination.
*
* Requires permission to access the DeleteTopicRuleDestination action.
*
* Deletes a topic rule destination.
*
* Requires permission to access the DeleteTopicRuleDestination action.
*
* Deletes a logging level.
*
* Requires permission to access the DeleteV2LoggingLevel action.
*
* Deletes a logging level.
*
* Requires permission to access the DeleteV2LoggingLevel action.
*
* Deprecates a thing type. You can not associate new things with deprecated thing type.
*
* Requires permission to access the DeprecateThingType action.
*
* Deprecates a thing type. You can not associate new things with deprecated thing type.
*
* Requires permission to access the DeprecateThingType action.
*
* Gets information about the Device Defender audit settings for this account. Settings include how audit
* notifications are sent and which audit checks are enabled or disabled.
*
* Requires permission to access the DescribeAccountAuditConfiguration action.
*
* Gets information about the Device Defender audit settings for this account. Settings include how audit
* notifications are sent and which audit checks are enabled or disabled.
*
* Requires permission to access the DescribeAccountAuditConfiguration action.
*
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of
* the issue, and the start time when the audit that returned the finding.
*
* Requires permission to access the DescribeAuditFinding action.
*
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of
* the issue, and the start time when the audit that returned the finding.
*
* Requires permission to access the DescribeAuditFinding action.
*
* Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit
* findings. Properties include the actions being applied, the audit checks to which they're being applied, the task
* status, and aggregated task statistics.
*
* Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit
* findings. Properties include the actions being applied, the audit checks to which they're being applied, the task
* status, and aggregated task statistics.
*
* Gets information about a Device Defender audit suppression.
*
* Gets information about a Device Defender audit suppression.
*
* Gets information about a Device Defender audit.
*
* Requires permission to access the DescribeAuditTask action.
*
* Gets information about a Device Defender audit.
*
* Requires permission to access the DescribeAuditTask action.
* ResourceAlreadyExistsException
is thrown.
* ResourceAlreadyExistsException
is thrown.
* metricName
set to your custom metric name.
* metricName
set to your custom metric name.
*