@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIotAsync extends AWSIot
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
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.
ENDPOINT_PREFIX
acceptCertificateTransfer, addThingToBillingGroup, addThingToThingGroup, associateTargetsWithJob, attachPolicy, attachPrincipalPolicy, attachSecurityProfile, attachThingPrincipal, cancelAuditMitigationActionsTask, cancelAuditTask, cancelCertificateTransfer, cancelDetectMitigationActionsTask, cancelJob, cancelJobExecution, clearDefaultAuthorizer, confirmTopicRuleDestination, createAuditSuppression, createAuthorizer, createBillingGroup, createCertificateFromCsr, createCertificateProvider, createCustomMetric, createDimension, createDomainConfiguration, createDynamicThingGroup, createFleetMetric, createJob, createJobTemplate, createKeysAndCertificate, createMitigationAction, createOTAUpdate, createPackage, createPackageVersion, createPolicy, createPolicyVersion, createProvisioningClaim, createProvisioningTemplate, createProvisioningTemplateVersion, createRoleAlias, createScheduledAudit, createSecurityProfile, createStream, createThing, createThingGroup, createThingType, createTopicRule, createTopicRuleDestination, deleteAccountAuditConfiguration, deleteAuditSuppression, deleteAuthorizer, deleteBillingGroup, deleteCACertificate, deleteCertificate, deleteCertificateProvider, deleteCustomMetric, deleteDimension, deleteDomainConfiguration, deleteDynamicThingGroup, deleteFleetMetric, deleteJob, deleteJobExecution, deleteJobTemplate, deleteMitigationAction, deleteOTAUpdate, deletePackage, deletePackageVersion, deletePolicy, deletePolicyVersion, deleteProvisioningTemplate, deleteProvisioningTemplateVersion, deleteRegistrationCode, deleteRoleAlias, deleteScheduledAudit, deleteSecurityProfile, deleteStream, deleteThing, deleteThingGroup, deleteThingType, deleteTopicRule, deleteTopicRuleDestination, deleteV2LoggingLevel, deprecateThingType, describeAccountAuditConfiguration, describeAuditFinding, describeAuditMitigationActionsTask, describeAuditSuppression, describeAuditTask, describeAuthorizer, describeBillingGroup, describeCACertificate, describeCertificate, describeCertificateProvider, describeCustomMetric, describeDefaultAuthorizer, describeDetectMitigationActionsTask, describeDimension, describeDomainConfiguration, describeEndpoint, describeEventConfigurations, describeFleetMetric, describeIndex, describeJob, describeJobExecution, describeJobTemplate, describeManagedJobTemplate, describeMitigationAction, describeProvisioningTemplate, describeProvisioningTemplateVersion, describeRoleAlias, describeScheduledAudit, describeSecurityProfile, describeStream, describeThing, describeThingGroup, describeThingRegistrationTask, describeThingType, detachPolicy, detachPrincipalPolicy, detachSecurityProfile, detachThingPrincipal, disableTopicRule, enableTopicRule, getBehaviorModelTrainingSummaries, getBucketsAggregation, getCachedResponseMetadata, getCardinality, getEffectivePolicies, getIndexingConfiguration, getJobDocument, getLoggingOptions, getOTAUpdate, getPackage, getPackageConfiguration, getPackageVersion, getPercentiles, getPolicy, getPolicyVersion, getRegistrationCode, getStatistics, getTopicRule, getTopicRuleDestination, getV2LoggingOptions, listActiveViolations, listAttachedPolicies, listAuditFindings, listAuditMitigationActionsExecutions, listAuditMitigationActionsTasks, listAuditSuppressions, listAuditTasks, listAuthorizers, listBillingGroups, listCACertificates, listCertificateProviders, listCertificates, listCertificatesByCA, listCustomMetrics, listDetectMitigationActionsExecutions, listDetectMitigationActionsTasks, listDimensions, listDomainConfigurations, listFleetMetrics, listIndices, listJobExecutionsForJob, listJobExecutionsForThing, listJobs, listJobTemplates, listManagedJobTemplates, listMetricValues, listMitigationActions, listOTAUpdates, listOutgoingCertificates, listPackages, listPackageVersions, listPolicies, listPolicyPrincipals, listPolicyVersions, listPrincipalPolicies, listPrincipalThings, listProvisioningTemplates, listProvisioningTemplateVersions, listRelatedResourcesForAuditFinding, listRoleAliases, listScheduledAudits, listSecurityProfiles, listSecurityProfilesForTarget, listStreams, listTagsForResource, listTargetsForPolicy, listTargetsForSecurityProfile, listThingGroups, listThingGroupsForThing, listThingPrincipals, listThingRegistrationTaskReports, listThingRegistrationTasks, listThings, listThingsInBillingGroup, listThingsInThingGroup, listThingTypes, listTopicRuleDestinations, listTopicRules, listV2LoggingLevels, listViolationEvents, putVerificationStateOnViolation, registerCACertificate, registerCertificate, registerCertificateWithoutCA, registerThing, rejectCertificateTransfer, removeThingFromBillingGroup, removeThingFromThingGroup, replaceTopicRule, searchIndex, setDefaultAuthorizer, setDefaultPolicyVersion, setEndpoint, setLoggingOptions, setRegion, setV2LoggingLevel, setV2LoggingOptions, shutdown, startAuditMitigationActionsTask, startDetectMitigationActionsTask, startOnDemandAuditTask, startThingRegistrationTask, stopThingRegistrationTask, tagResource, testAuthorization, testInvokeAuthorizer, transferCertificate, untagResource, updateAccountAuditConfiguration, updateAuditSuppression, updateAuthorizer, updateBillingGroup, updateCACertificate, updateCertificate, updateCertificateProvider, updateCustomMetric, updateDimension, updateDomainConfiguration, updateDynamicThingGroup, updateEventConfigurations, updateFleetMetric, updateIndexingConfiguration, updateJob, updateMitigationAction, updatePackage, updatePackageConfiguration, updatePackageVersion, updateProvisioningTemplate, updateRoleAlias, updateScheduledAudit, updateSecurityProfile, updateStream, updateThing, updateThingGroup, updateThingGroupsForThing, updateTopicRuleDestination, validateSecurityProfileBehaviors
Future<AcceptCertificateTransferResult> acceptCertificateTransferAsync(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.Future<AcceptCertificateTransferResult> acceptCertificateTransferAsync(AcceptCertificateTransferRequest acceptCertificateTransferRequest, AsyncHandler<AcceptCertificateTransferRequest,AcceptCertificateTransferResult> asyncHandler)
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.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.Future<AddThingToBillingGroupResult> addThingToBillingGroupAsync(AddThingToBillingGroupRequest addThingToBillingGroupRequest)
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroupRequest
- Future<AddThingToBillingGroupResult> addThingToBillingGroupAsync(AddThingToBillingGroupRequest addThingToBillingGroupRequest, AsyncHandler<AddThingToBillingGroupRequest,AddThingToBillingGroupResult> asyncHandler)
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroupRequest
- 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.Future<AddThingToThingGroupResult> addThingToThingGroupAsync(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroupRequest
- Future<AddThingToThingGroupResult> addThingToThingGroupAsync(AddThingToThingGroupRequest addThingToThingGroupRequest, AsyncHandler<AddThingToThingGroupRequest,AddThingToThingGroupResult> asyncHandler)
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroupRequest
- 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.Future<AssociateTargetsWithJobResult> associateTargetsWithJobAsync(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
- Future<AssociateTargetsWithJobResult> associateTargetsWithJobAsync(AssociateTargetsWithJobRequest associateTargetsWithJobRequest, AsyncHandler<AssociateTargetsWithJobRequest,AssociateTargetsWithJobResult> asyncHandler)
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
- 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.Future<AttachPolicyResult> attachPolicyAsync(AttachPolicyRequest attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
attachPolicyRequest
- Future<AttachPolicyResult> attachPolicyAsync(AttachPolicyRequest attachPolicyRequest, AsyncHandler<AttachPolicyRequest,AttachPolicyResult> asyncHandler)
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
attachPolicyRequest
- 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.@Deprecated Future<AttachPrincipalPolicyResult> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
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.
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.@Deprecated Future<AttachPrincipalPolicyResult> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest, AsyncHandler<AttachPrincipalPolicyRequest,AttachPrincipalPolicyResult> asyncHandler)
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.
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.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.Future<AttachSecurityProfileResult> attachSecurityProfileAsync(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
- Future<AttachSecurityProfileResult> attachSecurityProfileAsync(AttachSecurityProfileRequest attachSecurityProfileRequest, AsyncHandler<AttachSecurityProfileRequest,AttachSecurityProfileResult> asyncHandler)
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
- 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.Future<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest attachThingPrincipalRequest)
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.
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.Future<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest attachThingPrincipalRequest, AsyncHandler<AttachThingPrincipalRequest,AttachThingPrincipalResult> asyncHandler)
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.
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.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.Future<CancelAuditMitigationActionsTaskResult> cancelAuditMitigationActionsTaskAsync(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
- Future<CancelAuditMitigationActionsTaskResult> cancelAuditMitigationActionsTaskAsync(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest, AsyncHandler<CancelAuditMitigationActionsTaskRequest,CancelAuditMitigationActionsTaskResult> asyncHandler)
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
- 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.Future<CancelAuditTaskResult> cancelAuditTaskAsync(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
- Future<CancelAuditTaskResult> cancelAuditTaskAsync(CancelAuditTaskRequest cancelAuditTaskRequest, AsyncHandler<CancelAuditTaskRequest,CancelAuditTaskResult> asyncHandler)
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
- 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.Future<CancelCertificateTransferResult> cancelCertificateTransferAsync(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.Future<CancelCertificateTransferResult> cancelCertificateTransferAsync(CancelCertificateTransferRequest cancelCertificateTransferRequest, AsyncHandler<CancelCertificateTransferRequest,CancelCertificateTransferResult> asyncHandler)
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.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.Future<CancelDetectMitigationActionsTaskResult> cancelDetectMitigationActionsTaskAsync(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTaskRequest
- Future<CancelDetectMitigationActionsTaskResult> cancelDetectMitigationActionsTaskAsync(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest, AsyncHandler<CancelDetectMitigationActionsTaskRequest,CancelDetectMitigationActionsTaskResult> asyncHandler)
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTaskRequest
- 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.Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)
Cancels a job.
Requires permission to access the CancelJob action.
cancelJobRequest
- Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
Cancels a job.
Requires permission to access the CancelJob action.
cancelJobRequest
- 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.Future<CancelJobExecutionResult> cancelJobExecutionAsync(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
cancelJobExecutionRequest
- Future<CancelJobExecutionResult> cancelJobExecutionAsync(CancelJobExecutionRequest cancelJobExecutionRequest, AsyncHandler<CancelJobExecutionRequest,CancelJobExecutionResult> asyncHandler)
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
cancelJobExecutionRequest
- 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.Future<ClearDefaultAuthorizerResult> clearDefaultAuthorizerAsync(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizerRequest
- Future<ClearDefaultAuthorizerResult> clearDefaultAuthorizerAsync(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest, AsyncHandler<ClearDefaultAuthorizerRequest,ClearDefaultAuthorizerResult> asyncHandler)
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizerRequest
- 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.Future<ConfirmTopicRuleDestinationResult> confirmTopicRuleDestinationAsync(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
- Future<ConfirmTopicRuleDestinationResult> confirmTopicRuleDestinationAsync(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest, AsyncHandler<ConfirmTopicRuleDestinationRequest,ConfirmTopicRuleDestinationResult> asyncHandler)
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
- 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.Future<CreateAuditSuppressionResult> createAuditSuppressionAsync(CreateAuditSuppressionRequest createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppressionRequest
- Future<CreateAuditSuppressionResult> createAuditSuppressionAsync(CreateAuditSuppressionRequest createAuditSuppressionRequest, AsyncHandler<CreateAuditSuppressionRequest,CreateAuditSuppressionResult> asyncHandler)
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppressionRequest
- 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.Future<CreateAuthorizerResult> createAuthorizerAsync(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
createAuthorizerRequest
- Future<CreateAuthorizerResult> createAuthorizerAsync(CreateAuthorizerRequest createAuthorizerRequest, AsyncHandler<CreateAuthorizerRequest,CreateAuthorizerResult> asyncHandler)
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
createAuthorizerRequest
- 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.Future<CreateBillingGroupResult> createBillingGroupAsync(CreateBillingGroupRequest createBillingGroupRequest)
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
createBillingGroupRequest
- Future<CreateBillingGroupResult> createBillingGroupAsync(CreateBillingGroupRequest createBillingGroupRequest, AsyncHandler<CreateBillingGroupRequest,CreateBillingGroupResult> asyncHandler)
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
createBillingGroupRequest
- 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.Future<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
into that directory, and then specifying that directory on the command line. The following commands show how to
create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.Future<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest createCertificateFromCsrRequest, AsyncHandler<CreateCertificateFromCsrRequest,CreateCertificateFromCsrResult> asyncHandler)
Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
into that directory, and then specifying that directory on the command line. The following commands show how to
create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.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.Future<CreateCertificateProviderResult> createCertificateProviderAsync(CreateCertificateProviderRequest createCertificateProviderRequest)
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr
API for fleet provisioning will change and all API calls to
CreateCertificateFromCsr
will invoke the certificate provider to create the certificates. It can
take up to a few minutes for this behavior to change after a certificate provider is created.
createCertificateProviderRequest
- Future<CreateCertificateProviderResult> createCertificateProviderAsync(CreateCertificateProviderRequest createCertificateProviderRequest, AsyncHandler<CreateCertificateProviderRequest,CreateCertificateProviderResult> asyncHandler)
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr
API for fleet provisioning will change and all API calls to
CreateCertificateFromCsr
will invoke the certificate provider to create the certificates. It can
take up to a few minutes for this behavior to change after a certificate provider is created.
createCertificateProviderRequest
- 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.Future<CreateCustomMetricResult> createCustomMetricAsync(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
- Future<CreateCustomMetricResult> createCustomMetricAsync(CreateCustomMetricRequest createCustomMetricRequest, AsyncHandler<CreateCustomMetricRequest,CreateCustomMetricResult> asyncHandler)
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
createCustomMetricRequest
- 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.Future<CreateDimensionResult> createDimensionAsync(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
- Future<CreateDimensionResult> createDimensionAsync(CreateDimensionRequest createDimensionRequest, AsyncHandler<CreateDimensionRequest,CreateDimensionResult> asyncHandler)
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
- 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.Future<CreateDomainConfigurationResult> createDomainConfigurationAsync(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfigurationRequest
- Future<CreateDomainConfigurationResult> createDomainConfigurationAsync(CreateDomainConfigurationRequest createDomainConfigurationRequest, AsyncHandler<CreateDomainConfigurationRequest,CreateDomainConfigurationResult> asyncHandler)
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfigurationRequest
- 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.Future<CreateDynamicThingGroupResult> createDynamicThingGroupAsync(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroupRequest
- Future<CreateDynamicThingGroupResult> createDynamicThingGroupAsync(CreateDynamicThingGroupRequest createDynamicThingGroupRequest, AsyncHandler<CreateDynamicThingGroupRequest,CreateDynamicThingGroupResult> asyncHandler)
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroupRequest
- 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.Future<CreateFleetMetricResult> createFleetMetricAsync(CreateFleetMetricRequest createFleetMetricRequest)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetricRequest
- Future<CreateFleetMetricResult> createFleetMetricAsync(CreateFleetMetricRequest createFleetMetricRequest, AsyncHandler<CreateFleetMetricRequest,CreateFleetMetricResult> asyncHandler)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetricRequest
- 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.Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)
Creates a job.
Requires permission to access the CreateJob action.
createJobRequest
- Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
Creates a job.
Requires permission to access the CreateJob action.
createJobRequest
- 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.Future<CreateJobTemplateResult> createJobTemplateAsync(CreateJobTemplateRequest createJobTemplateRequest)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplateRequest
- Future<CreateJobTemplateResult> createJobTemplateAsync(CreateJobTemplateRequest createJobTemplateRequest, AsyncHandler<CreateJobTemplateRequest,CreateJobTemplateResult> asyncHandler)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplateRequest
- 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.Future<CreateKeysAndCertificateResult> createKeysAndCertificateAsync(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.
Future<CreateKeysAndCertificateResult> createKeysAndCertificateAsync(CreateKeysAndCertificateRequest createKeysAndCertificateRequest, AsyncHandler<CreateKeysAndCertificateRequest,CreateKeysAndCertificateResult> asyncHandler)
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.
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.Future<CreateMitigationActionResult> createMitigationActionAsync(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
- Future<CreateMitigationActionResult> createMitigationActionAsync(CreateMitigationActionRequest createMitigationActionRequest, AsyncHandler<CreateMitigationActionRequest,CreateMitigationActionResult> asyncHandler)
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
- 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.Future<CreateOTAUpdateResult> createOTAUpdateAsync(CreateOTAUpdateRequest createOTAUpdateRequest)
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOTAUpdateRequest
- Future<CreateOTAUpdateResult> createOTAUpdateAsync(CreateOTAUpdateRequest createOTAUpdateRequest, AsyncHandler<CreateOTAUpdateRequest,CreateOTAUpdateResult> asyncHandler)
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOTAUpdateRequest
- 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.Future<CreatePackageResult> createPackageAsync(CreatePackageRequest createPackageRequest)
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackageRequest
- Future<CreatePackageResult> createPackageAsync(CreatePackageRequest createPackageRequest, AsyncHandler<CreatePackageRequest,CreatePackageResult> asyncHandler)
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackageRequest
- 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.Future<CreatePackageVersionResult> createPackageVersionAsync(CreatePackageVersionRequest createPackageVersionRequest)
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersionRequest
- Future<CreatePackageVersionResult> createPackageVersionAsync(CreatePackageVersionRequest createPackageVersionRequest, AsyncHandler<CreatePackageVersionRequest,CreatePackageVersionResult> asyncHandler)
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersionRequest
- 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.Future<CreatePolicyResult> createPolicyAsync(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.Future<CreatePolicyResult> createPolicyAsync(CreatePolicyRequest createPolicyRequest, AsyncHandler<CreatePolicyRequest,CreatePolicyResult> asyncHandler)
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.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.Future<CreatePolicyVersionResult> createPolicyVersionAsync(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.Future<CreatePolicyVersionResult> createPolicyVersionAsync(CreatePolicyVersionRequest createPolicyVersionRequest, AsyncHandler<CreatePolicyVersionRequest,CreatePolicyVersionResult> asyncHandler)
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.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.Future<CreateProvisioningClaimResult> createProvisioningClaimAsync(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaimRequest
- Future<CreateProvisioningClaimResult> createProvisioningClaimAsync(CreateProvisioningClaimRequest createProvisioningClaimRequest, AsyncHandler<CreateProvisioningClaimRequest,CreateProvisioningClaimResult> asyncHandler)
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaimRequest
- 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.Future<CreateProvisioningTemplateResult> createProvisioningTemplateAsync(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplateRequest
- Future<CreateProvisioningTemplateResult> createProvisioningTemplateAsync(CreateProvisioningTemplateRequest createProvisioningTemplateRequest, AsyncHandler<CreateProvisioningTemplateRequest,CreateProvisioningTemplateResult> asyncHandler)
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplateRequest
- 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.Future<CreateProvisioningTemplateVersionResult> createProvisioningTemplateVersionAsync(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersionRequest
- Future<CreateProvisioningTemplateVersionResult> createProvisioningTemplateVersionAsync(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest, AsyncHandler<CreateProvisioningTemplateVersionRequest,CreateProvisioningTemplateVersionResult> asyncHandler)
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersionRequest
- 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.Future<CreateRoleAliasResult> createRoleAliasAsync(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
createRoleAliasRequest
- Future<CreateRoleAliasResult> createRoleAliasAsync(CreateRoleAliasRequest createRoleAliasRequest, AsyncHandler<CreateRoleAliasRequest,CreateRoleAliasResult> asyncHandler)
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
createRoleAliasRequest
- 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.Future<CreateScheduledAuditResult> createScheduledAuditAsync(CreateScheduledAuditRequest createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
createScheduledAuditRequest
- Future<CreateScheduledAuditResult> createScheduledAuditAsync(CreateScheduledAuditRequest createScheduledAuditRequest, AsyncHandler<CreateScheduledAuditRequest,CreateScheduledAuditResult> asyncHandler)
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
createScheduledAuditRequest
- 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.Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfileRequest
- Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest createSecurityProfileRequest, AsyncHandler<CreateSecurityProfileRequest,CreateSecurityProfileResult> asyncHandler)
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfileRequest
- 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.Future<CreateStreamResult> createStreamAsync(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
- Future<CreateStreamResult> createStreamAsync(CreateStreamRequest createStreamRequest, AsyncHandler<CreateStreamRequest,CreateStreamResult> asyncHandler)
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
- 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.Future<CreateThingResult> createThingAsync(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.Future<CreateThingResult> createThingAsync(CreateThingRequest createThingRequest, AsyncHandler<CreateThingRequest,CreateThingResult> asyncHandler)
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.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.Future<CreateThingGroupResult> createThingGroupAsync(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
If the ThingGroup
that you create has the exact same attributes as an existing
ThingGroup
, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
createThingGroupRequest
- Future<CreateThingGroupResult> createThingGroupAsync(CreateThingGroupRequest createThingGroupRequest, AsyncHandler<CreateThingGroupRequest,CreateThingGroupResult> asyncHandler)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
If the ThingGroup
that you create has the exact same attributes as an existing
ThingGroup
, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
createThingGroupRequest
- 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.Future<CreateThingTypeResult> createThingTypeAsync(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
Requires permission to access the CreateThingType action.
createThingTypeRequest
- The input for the CreateThingType operation.Future<CreateThingTypeResult> createThingTypeAsync(CreateThingTypeRequest createThingTypeRequest, AsyncHandler<CreateThingTypeRequest,CreateThingTypeResult> asyncHandler)
Creates a new thing type.
Requires permission to access the CreateThingType action.
createThingTypeRequest
- The input for the CreateThingType operation.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.Future<CreateTopicRuleResult> createTopicRuleAsync(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.Future<CreateTopicRuleResult> createTopicRuleAsync(CreateTopicRuleRequest createTopicRuleRequest, AsyncHandler<CreateTopicRuleRequest,CreateTopicRuleResult> asyncHandler)
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.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.Future<CreateTopicRuleDestinationResult> createTopicRuleDestinationAsync(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest)
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestinationRequest
- Future<CreateTopicRuleDestinationResult> createTopicRuleDestinationAsync(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest, AsyncHandler<CreateTopicRuleDestinationRequest,CreateTopicRuleDestinationResult> asyncHandler)
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestinationRequest
- 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.Future<DeleteAccountAuditConfigurationResult> deleteAccountAuditConfigurationAsync(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
- Future<DeleteAccountAuditConfigurationResult> deleteAccountAuditConfigurationAsync(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest, AsyncHandler<DeleteAccountAuditConfigurationRequest,DeleteAccountAuditConfigurationResult> asyncHandler)
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
- 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.Future<DeleteAuditSuppressionResult> deleteAuditSuppressionAsync(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppressionRequest
- Future<DeleteAuditSuppressionResult> deleteAuditSuppressionAsync(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest, AsyncHandler<DeleteAuditSuppressionRequest,DeleteAuditSuppressionResult> asyncHandler)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppressionRequest
- 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.Future<DeleteAuthorizerResult> deleteAuthorizerAsync(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizerRequest
- Future<DeleteAuthorizerResult> deleteAuthorizerAsync(DeleteAuthorizerRequest deleteAuthorizerRequest, AsyncHandler<DeleteAuthorizerRequest,DeleteAuthorizerResult> asyncHandler)
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizerRequest
- 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.Future<DeleteBillingGroupResult> deleteBillingGroupAsync(DeleteBillingGroupRequest deleteBillingGroupRequest)
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroupRequest
- Future<DeleteBillingGroupResult> deleteBillingGroupAsync(DeleteBillingGroupRequest deleteBillingGroupRequest, AsyncHandler<DeleteBillingGroupRequest,DeleteBillingGroupResult> asyncHandler)
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroupRequest
- 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.Future<DeleteCACertificateResult> deleteCACertificateAsync(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.Future<DeleteCACertificateResult> deleteCACertificateAsync(DeleteCACertificateRequest deleteCACertificateRequest, AsyncHandler<DeleteCACertificateRequest,DeleteCACertificateResult> asyncHandler)
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.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.Future<DeleteCertificateResult> deleteCertificateAsync(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.Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResult> asyncHandler)
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.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.Future<DeleteCertificateProviderResult> deleteCertificateProviderAsync(DeleteCertificateProviderRequest deleteCertificateProviderRequest)
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr
will
resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
deleteCertificateProviderRequest
- Future<DeleteCertificateProviderResult> deleteCertificateProviderAsync(DeleteCertificateProviderRequest deleteCertificateProviderRequest, AsyncHandler<DeleteCertificateProviderRequest,DeleteCertificateProviderResult> asyncHandler)
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr
will
resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
deleteCertificateProviderRequest
- 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.Future<DeleteCustomMetricResult> deleteCustomMetricAsync(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
- Future<DeleteCustomMetricResult> deleteCustomMetricAsync(DeleteCustomMetricRequest deleteCustomMetricRequest, AsyncHandler<DeleteCustomMetricRequest,DeleteCustomMetricResult> asyncHandler)
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
- 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.Future<DeleteDimensionResult> deleteDimensionAsync(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimensionRequest
- Future<DeleteDimensionResult> deleteDimensionAsync(DeleteDimensionRequest deleteDimensionRequest, AsyncHandler<DeleteDimensionRequest,DeleteDimensionResult> asyncHandler)
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimensionRequest
- 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.Future<DeleteDomainConfigurationResult> deleteDomainConfigurationAsync(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfigurationRequest
- Future<DeleteDomainConfigurationResult> deleteDomainConfigurationAsync(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest, AsyncHandler<DeleteDomainConfigurationRequest,DeleteDomainConfigurationResult> asyncHandler)
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfigurationRequest
- 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.Future<DeleteDynamicThingGroupResult> deleteDynamicThingGroupAsync(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
deleteDynamicThingGroupRequest
- Future<DeleteDynamicThingGroupResult> deleteDynamicThingGroupAsync(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest, AsyncHandler<DeleteDynamicThingGroupRequest,DeleteDynamicThingGroupResult> asyncHandler)
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
deleteDynamicThingGroupRequest
- 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.Future<DeleteFleetMetricResult> deleteFleetMetricAsync(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
- Future<DeleteFleetMetricResult> deleteFleetMetricAsync(DeleteFleetMetricRequest deleteFleetMetricRequest, AsyncHandler<DeleteFleetMetricRequest,DeleteFleetMetricResult> asyncHandler)
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
- 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.Future<DeleteJobResult> deleteJobAsync(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
- Future<DeleteJobResult> deleteJobAsync(DeleteJobRequest deleteJobRequest, AsyncHandler<DeleteJobRequest,DeleteJobResult> asyncHandler)
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
- 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.Future<DeleteJobExecutionResult> deleteJobExecutionAsync(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
deleteJobExecutionRequest
- Future<DeleteJobExecutionResult> deleteJobExecutionAsync(DeleteJobExecutionRequest deleteJobExecutionRequest, AsyncHandler<DeleteJobExecutionRequest,DeleteJobExecutionResult> asyncHandler)
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
deleteJobExecutionRequest
- 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.Future<DeleteJobTemplateResult> deleteJobTemplateAsync(DeleteJobTemplateRequest deleteJobTemplateRequest)
Deletes the specified job template.
deleteJobTemplateRequest
- Future<DeleteJobTemplateResult> deleteJobTemplateAsync(DeleteJobTemplateRequest deleteJobTemplateRequest, AsyncHandler<DeleteJobTemplateRequest,DeleteJobTemplateResult> asyncHandler)
Deletes the specified job template.
deleteJobTemplateRequest
- 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.Future<DeleteMitigationActionResult> deleteMitigationActionAsync(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationActionRequest
- Future<DeleteMitigationActionResult> deleteMitigationActionAsync(DeleteMitigationActionRequest deleteMitigationActionRequest, AsyncHandler<DeleteMitigationActionRequest,DeleteMitigationActionResult> asyncHandler)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationActionRequest
- 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.Future<DeleteOTAUpdateResult> deleteOTAUpdateAsync(DeleteOTAUpdateRequest deleteOTAUpdateRequest)
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
deleteOTAUpdateRequest
- Future<DeleteOTAUpdateResult> deleteOTAUpdateAsync(DeleteOTAUpdateRequest deleteOTAUpdateRequest, AsyncHandler<DeleteOTAUpdateRequest,DeleteOTAUpdateResult> asyncHandler)
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
deleteOTAUpdateRequest
- 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.Future<DeletePackageResult> deletePackageAsync(DeletePackageRequest deletePackageRequest)
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.
deletePackageRequest
- Future<DeletePackageResult> deletePackageAsync(DeletePackageRequest deletePackageRequest, AsyncHandler<DeletePackageRequest,DeletePackageResult> asyncHandler)
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.
deletePackageRequest
- 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.Future<DeletePackageVersionResult> deletePackageVersionAsync(DeletePackageVersionRequest deletePackageVersionRequest)
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
deletePackageVersionRequest
- Future<DeletePackageVersionResult> deletePackageVersionAsync(DeletePackageVersionRequest deletePackageVersionRequest, AsyncHandler<DeletePackageVersionRequest,DeletePackageVersionResult> asyncHandler)
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
deletePackageVersionRequest
- 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.Future<DeletePolicyResult> deletePolicyAsync(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.Future<DeletePolicyResult> deletePolicyAsync(DeletePolicyRequest deletePolicyRequest, AsyncHandler<DeletePolicyRequest,DeletePolicyResult> asyncHandler)
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.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.Future<DeletePolicyVersionResult> deletePolicyVersionAsync(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.Future<DeletePolicyVersionResult> deletePolicyVersionAsync(DeletePolicyVersionRequest deletePolicyVersionRequest, AsyncHandler<DeletePolicyVersionRequest,DeletePolicyVersionResult> asyncHandler)
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.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.Future<DeleteProvisioningTemplateResult> deleteProvisioningTemplateAsync(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
deleteProvisioningTemplateRequest
- Future<DeleteProvisioningTemplateResult> deleteProvisioningTemplateAsync(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest, AsyncHandler<DeleteProvisioningTemplateRequest,DeleteProvisioningTemplateResult> asyncHandler)
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
deleteProvisioningTemplateRequest
- 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.Future<DeleteProvisioningTemplateVersionResult> deleteProvisioningTemplateVersionAsync(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
deleteProvisioningTemplateVersionRequest
- Future<DeleteProvisioningTemplateVersionResult> deleteProvisioningTemplateVersionAsync(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest, AsyncHandler<DeleteProvisioningTemplateVersionRequest,DeleteProvisioningTemplateVersionResult> asyncHandler)
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
deleteProvisioningTemplateVersionRequest
- 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.Future<DeleteRegistrationCodeResult> deleteRegistrationCodeAsync(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.Future<DeleteRegistrationCodeResult> deleteRegistrationCodeAsync(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest, AsyncHandler<DeleteRegistrationCodeRequest,DeleteRegistrationCodeResult> asyncHandler)
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.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.Future<DeleteRoleAliasResult> deleteRoleAliasAsync(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
deleteRoleAliasRequest
- Future<DeleteRoleAliasResult> deleteRoleAliasAsync(DeleteRoleAliasRequest deleteRoleAliasRequest, AsyncHandler<DeleteRoleAliasRequest,DeleteRoleAliasResult> asyncHandler)
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
deleteRoleAliasRequest
- 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.Future<DeleteScheduledAuditResult> deleteScheduledAuditAsync(DeleteScheduledAuditRequest deleteScheduledAuditRequest)
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
deleteScheduledAuditRequest
- Future<DeleteScheduledAuditResult> deleteScheduledAuditAsync(DeleteScheduledAuditRequest deleteScheduledAuditRequest, AsyncHandler<DeleteScheduledAuditRequest,DeleteScheduledAuditResult> asyncHandler)
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
deleteScheduledAuditRequest
- 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.Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
deleteSecurityProfileRequest
- Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest deleteSecurityProfileRequest, AsyncHandler<DeleteSecurityProfileRequest,DeleteSecurityProfileResult> asyncHandler)
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
deleteSecurityProfileRequest
- 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.Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.
Requires permission to access the DeleteStream action.
deleteStreamRequest
- Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest deleteStreamRequest, AsyncHandler<DeleteStreamRequest,DeleteStreamResult> asyncHandler)
Deletes a stream.
Requires permission to access the DeleteStream action.
deleteStreamRequest
- 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.Future<DeleteThingResult> deleteThingAsync(DeleteThingRequest deleteThingRequest)
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
deleteThingRequest
- The input for the DeleteThing operation.Future<DeleteThingResult> deleteThingAsync(DeleteThingRequest deleteThingRequest, AsyncHandler<DeleteThingRequest,DeleteThingResult> asyncHandler)
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.
deleteThingRequest
- The input for the DeleteThing operation.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.Future<DeleteThingGroupResult> deleteThingGroupAsync(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
deleteThingGroupRequest
- Future<DeleteThingGroupResult> deleteThingGroupAsync(DeleteThingGroupRequest deleteThingGroupRequest, AsyncHandler<DeleteThingGroupRequest,DeleteThingGroupResult> asyncHandler)
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
deleteThingGroupRequest
- 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.Future<DeleteThingTypeResult> deleteThingTypeAsync(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
Requires permission to access the DeleteThingType action.
deleteThingTypeRequest
- The input for the DeleteThingType operation.Future<DeleteThingTypeResult> deleteThingTypeAsync(DeleteThingTypeRequest deleteThingTypeRequest, AsyncHandler<DeleteThingTypeRequest,DeleteThingTypeResult> asyncHandler)
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.
deleteThingTypeRequest
- The input for the DeleteThingType operation.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.Future<DeleteTopicRuleResult> deleteTopicRuleAsync(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.Future<DeleteTopicRuleResult> deleteTopicRuleAsync(DeleteTopicRuleRequest deleteTopicRuleRequest, AsyncHandler<DeleteTopicRuleRequest,DeleteTopicRuleResult> asyncHandler)
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.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.Future<DeleteTopicRuleDestinationResult> deleteTopicRuleDestinationAsync(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
deleteTopicRuleDestinationRequest
- Future<DeleteTopicRuleDestinationResult> deleteTopicRuleDestinationAsync(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest, AsyncHandler<DeleteTopicRuleDestinationRequest,DeleteTopicRuleDestinationResult> asyncHandler)
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
deleteTopicRuleDestinationRequest
- 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.Future<DeleteV2LoggingLevelResult> deleteV2LoggingLevelAsync(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
deleteV2LoggingLevelRequest
- Future<DeleteV2LoggingLevelResult> deleteV2LoggingLevelAsync(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest, AsyncHandler<DeleteV2LoggingLevelRequest,DeleteV2LoggingLevelResult> asyncHandler)
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
deleteV2LoggingLevelRequest
- 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.Future<DeprecateThingTypeResult> deprecateThingTypeAsync(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.Future<DeprecateThingTypeResult> deprecateThingTypeAsync(DeprecateThingTypeRequest deprecateThingTypeRequest, AsyncHandler<DeprecateThingTypeRequest,DeprecateThingTypeResult> asyncHandler)
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.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.Future<DescribeAccountAuditConfigurationResult> describeAccountAuditConfigurationAsync(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest)
Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
describeAccountAuditConfigurationRequest
- Future<DescribeAccountAuditConfigurationResult> describeAccountAuditConfigurationAsync(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest, AsyncHandler<DescribeAccountAuditConfigurationRequest,DescribeAccountAuditConfigurationResult> asyncHandler)
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.
describeAccountAuditConfigurationRequest
- 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.Future<DescribeAuditFindingResult> describeAuditFindingAsync(DescribeAuditFindingRequest describeAuditFindingRequest)
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.
describeAuditFindingRequest
- Future<DescribeAuditFindingResult> describeAuditFindingAsync(DescribeAuditFindingRequest describeAuditFindingRequest, AsyncHandler<DescribeAuditFindingRequest,DescribeAuditFindingResult> asyncHandler)
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.
describeAuditFindingRequest
- 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.Future<DescribeAuditMitigationActionsTaskResult> describeAuditMitigationActionsTaskAsync(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest)
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.
describeAuditMitigationActionsTaskRequest
- Future<DescribeAuditMitigationActionsTaskResult> describeAuditMitigationActionsTaskAsync(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest, AsyncHandler<DescribeAuditMitigationActionsTaskRequest,DescribeAuditMitigationActionsTaskResult> asyncHandler)
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.
describeAuditMitigationActionsTaskRequest
- 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.Future<DescribeAuditSuppressionResult> describeAuditSuppressionAsync(DescribeAuditSuppressionRequest describeAuditSuppressionRequest)
Gets information about a Device Defender audit suppression.
describeAuditSuppressionRequest
- Future<DescribeAuditSuppressionResult> describeAuditSuppressionAsync(DescribeAuditSuppressionRequest describeAuditSuppressionRequest, AsyncHandler<DescribeAuditSuppressionRequest,DescribeAuditSuppressionResult> asyncHandler)
Gets information about a Device Defender audit suppression.
describeAuditSuppressionRequest
- 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.Future<DescribeAuditTaskResult> describeAuditTaskAsync(DescribeAuditTaskRequest describeAuditTaskRequest)
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
describeAuditTaskRequest
- Future<DescribeAuditTaskResult> describeAuditTaskAsync(DescribeAuditTaskRequest describeAuditTaskRequest, AsyncHandler<DescribeAuditTaskRequest,DescribeAuditTaskResult> asyncHandler)
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
describeAuditTaskRequest
- 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.Future<DescribeAuthorizerResult> describeAuthorizerAsync(DescribeAuthorizerRequest describeAuthorizerRequest)
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
describeAuthorizerRequest
- Future<DescribeAuthorizerResult> describeAuthorizerAsync(DescribeAuthorizerRequest describeAuthorizerRequest, AsyncHandler<DescribeAuthorizerRequest,DescribeAuthorizerResult> asyncHandler)
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
describeAuthorizerRequest
- 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.Future<DescribeBillingGroupResult> describeBillingGroupAsync(DescribeBillingGroupRequest describeBillingGroupRequest)
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
describeBillingGroupRequest
- Future<DescribeBillingGroupResult> describeBillingGroupAsync(DescribeBillingGroupRequest describeBillingGroupRequest, AsyncHandler<DescribeBillingGroupRequest,DescribeBillingGroupResult> asyncHandler)
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
describeBillingGroupRequest
- 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.Future<DescribeCACertificateResult> describeCACertificateAsync(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
describeCACertificateRequest
- The input for the DescribeCACertificate operation.Future<DescribeCACertificateResult> describeCACertificateAsync(DescribeCACertificateRequest describeCACertificateRequest, AsyncHandler<DescribeCACertificateRequest,DescribeCACertificateResult> asyncHandler)
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
describeCACertificateRequest
- The input for the DescribeCACertificate operation.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.Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
describeCertificateRequest
- The input for the DescribeCertificate operation.Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
describeCertificateRequest
- The input for the DescribeCertificate operation.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.Future<DescribeCertificateProviderResult> describeCertificateProviderAsync(DescribeCertificateProviderRequest describeCertificateProviderRequest)
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProviderRequest
- Future<DescribeCertificateProviderResult> describeCertificateProviderAsync(DescribeCertificateProviderRequest describeCertificateProviderRequest, AsyncHandler<DescribeCertificateProviderRequest,DescribeCertificateProviderResult> asyncHandler)
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProviderRequest
- 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.Future<DescribeCustomMetricResult> describeCustomMetricAsync(DescribeCustomMetricRequest describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetricRequest
- Future<DescribeCustomMetricResult> describeCustomMetricAsync(DescribeCustomMetricRequest describeCustomMetricRequest, AsyncHandler<DescribeCustomMetricRequest,DescribeCustomMetricResult> asyncHandler)
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetricRequest
- 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.Future<DescribeDefaultAuthorizerResult> describeDefaultAuthorizerAsync(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest)
Describes the default authorizer.
Requires permissi