@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.
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
ENDPOINT_PREFIXacceptCertificateTransfer, addThingToBillingGroup, addThingToThingGroup, associateTargetsWithJob, attachPolicy, attachPrincipalPolicy, attachSecurityProfile, attachThingPrincipal, cancelAuditMitigationActionsTask, cancelAuditTask, cancelCertificateTransfer, cancelDetectMitigationActionsTask, cancelJob, cancelJobExecution, clearDefaultAuthorizer, confirmTopicRuleDestination, createAuditSuppression, createAuthorizer, createBillingGroup, createCertificateFromCsr, createCustomMetric, createDimension, createDomainConfiguration, createDynamicThingGroup, createJob, createKeysAndCertificate, createMitigationAction, createOTAUpdate, createPolicy, createPolicyVersion, createProvisioningClaim, createProvisioningTemplate, createProvisioningTemplateVersion, createRoleAlias, createScheduledAudit, createSecurityProfile, createStream, createThing, createThingGroup, createThingType, createTopicRule, createTopicRuleDestination, deleteAccountAuditConfiguration, deleteAuditSuppression, deleteAuthorizer, deleteBillingGroup, deleteCACertificate, deleteCertificate, deleteCustomMetric, deleteDimension, deleteDomainConfiguration, deleteDynamicThingGroup, deleteJob, deleteJobExecution, deleteMitigationAction, deleteOTAUpdate, 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, describeCustomMetric, describeDefaultAuthorizer, describeDetectMitigationActionsTask, describeDimension, describeDomainConfiguration, describeEndpoint, describeEventConfigurations, describeIndex, describeJob, describeJobExecution, describeMitigationAction, describeProvisioningTemplate, describeProvisioningTemplateVersion, describeRoleAlias, describeScheduledAudit, describeSecurityProfile, describeStream, describeThing, describeThingGroup, describeThingRegistrationTask, describeThingType, detachPolicy, detachPrincipalPolicy, detachSecurityProfile, detachThingPrincipal, disableTopicRule, enableTopicRule, getBehaviorModelTrainingSummaries, getCachedResponseMetadata, getCardinality, getEffectivePolicies, getIndexingConfiguration, getJobDocument, getLoggingOptions, getOTAUpdate, getPercentiles, getPolicy, getPolicyVersion, getRegistrationCode, getStatistics, getTopicRule, getTopicRuleDestination, getV2LoggingOptions, listActiveViolations, listAttachedPolicies, listAuditFindings, listAuditMitigationActionsExecutions, listAuditMitigationActionsTasks, listAuditSuppressions, listAuditTasks, listAuthorizers, listBillingGroups, listCACertificates, listCertificates, listCertificatesByCA, listCustomMetrics, listDetectMitigationActionsExecutions, listDetectMitigationActionsTasks, listDimensions, listDomainConfigurations, listIndices, listJobExecutionsForJob, listJobExecutionsForThing, listJobs, listMitigationActions, listOTAUpdates, listOutgoingCertificates, listPolicies, listPolicyPrincipals, listPolicyVersions, listPrincipalPolicies, listPrincipalThings, listProvisioningTemplates, listProvisioningTemplateVersions, listRoleAliases, listScheduledAudits, listSecurityProfiles, listSecurityProfilesForTarget, listStreams, listTagsForResource, listTargetsForPolicy, listTargetsForSecurityProfile, listThingGroups, listThingGroupsForThing, listThingPrincipals, listThingRegistrationTaskReports, listThingRegistrationTasks, listThings, listThingsInBillingGroup, listThingsInThingGroup, listThingTypes, listTopicRuleDestinations, listTopicRules, listV2LoggingLevels, listViolationEvents, 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, updateCustomMetric, updateDimension, updateDomainConfiguration, updateDynamicThingGroup, updateEventConfigurations, updateIndexingConfiguration, updateJob, updateMitigationAction, updateProvisioningTemplate, updateRoleAlias, updateScheduledAudit, updateSecurityProfile, updateStream, updateThing, updateThingGroup, updateThingGroupsForThing, updateTopicRuleDestination, validateSecurityProfileBehaviorsFuture<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.
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.
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.
addThingToBillingGroupRequest - Future<AddThingToBillingGroupResult> addThingToBillingGroupAsync(AddThingToBillingGroupRequest addThingToBillingGroupRequest, AsyncHandler<AddThingToBillingGroupRequest,AddThingToBillingGroupResult> asyncHandler)
Adds a thing to a billing group.
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.
addThingToThingGroupRequest - Future<AddThingToThingGroupResult> addThingToThingGroupAsync(AddThingToThingGroupRequest addThingToThingGroupRequest, AsyncHandler<AddThingToThingGroupRequest,AddThingToThingGroupResult> asyncHandler)
Adds a thing to a thing group.
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.
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.
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 a policy to the specified target.
attachPolicyRequest - Future<AttachPolicyResult> attachPolicyAsync(AttachPolicyRequest attachPolicyRequest, AsyncHandler<AttachPolicyRequest,AttachPolicyResult> asyncHandler)
Attaches a policy to the specified target.
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 API is deprecated. Please use AttachPolicy instead.
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 API is deprecated. Please use AttachPolicy instead.
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.
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.
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, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
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, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
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.
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.
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.
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.
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, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.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, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.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.
cancelDetectMitigationActionsTaskRequest - Future<CancelDetectMitigationActionsTaskResult> cancelDetectMitigationActionsTaskAsync(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest, AsyncHandler<CancelDetectMitigationActionsTaskRequest,CancelDetectMitigationActionsTaskResult> asyncHandler)
Cancels a Device Defender ML Detect mitigation 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.
cancelJobRequest - Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
Cancels a job.
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.
cancelJobExecutionRequest - Future<CancelJobExecutionResult> cancelJobExecutionAsync(CancelJobExecutionRequest cancelJobExecutionRequest, AsyncHandler<CancelJobExecutionRequest,CancelJobExecutionResult> asyncHandler)
Cancels the execution of a job for a given thing.
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.
clearDefaultAuthorizerRequest - Future<ClearDefaultAuthorizerResult> clearDefaultAuthorizerAsync(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest, AsyncHandler<ClearDefaultAuthorizerRequest,ClearDefaultAuthorizerResult> asyncHandler)
Clears the default authorizer.
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, AWS IoT sends a confirmation
message to the endpoint or base address you specify. The message includes a token which you pass back when
calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
confirmTopicRuleDestinationRequest - Future<ConfirmTopicRuleDestinationResult> confirmTopicRuleDestinationAsync(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest, AsyncHandler<ConfirmTopicRuleDestinationRequest,ConfirmTopicRuleDestinationResult> asyncHandler)
Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation
message to the endpoint or base address you specify. The message includes a token which you pass back when
calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
confirmTopicRuleDestinationRequest - 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.
createAuditSuppressionRequest - Future<CreateAuditSuppressionResult> createAuditSuppressionAsync(CreateAuditSuppressionRequest createAuditSuppressionRequest, AsyncHandler<CreateAuditSuppressionRequest,CreateAuditSuppressionResult> asyncHandler)
Creates a Device Defender audit suppression.
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.
createAuthorizerRequest - Future<CreateAuthorizerResult> createAuthorizerAsync(CreateAuthorizerRequest createAuthorizerRequest, AsyncHandler<CreateAuthorizerRequest,CreateAuthorizerResult> asyncHandler)
Creates an authorizer.
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.
createBillingGroupRequest - Future<CreateBillingGroupResult> createBillingGroupAsync(CreateBillingGroupRequest createBillingGroupRequest, AsyncHandler<CreateBillingGroupRequest,CreateBillingGroupResult> asyncHandler)
Creates a billing group.
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.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest - The input for the CreateCertificateFromCsr operation.Future<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest createCertificateFromCsrRequest, AsyncHandler<CreateCertificateFromCsrRequest,CreateCertificateFromCsrResult> asyncHandler)
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest - The input for the CreateCertificateFromCsr operation.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.
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.
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 AWS IoT Device
Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric
only to MQTT topics whose name match the pattern specified in the dimension.
createDimensionRequest - 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 AWS IoT Device
Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric
only to MQTT topics whose name match the pattern specified in the dimension.
createDimensionRequest - 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.
The domain configuration feature is in public preview and is subject to change.
createDomainConfigurationRequest - Future<CreateDomainConfigurationResult> createDomainConfigurationAsync(CreateDomainConfigurationRequest createDomainConfigurationRequest, AsyncHandler<CreateDomainConfigurationRequest,CreateDomainConfigurationResult> asyncHandler)
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
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.
createDynamicThingGroupRequest - Future<CreateDynamicThingGroupResult> createDynamicThingGroupAsync(CreateDynamicThingGroupRequest createDynamicThingGroupRequest, AsyncHandler<CreateDynamicThingGroupRequest,CreateDynamicThingGroupResult> asyncHandler)
Creates a dynamic thing group.
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<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)
Creates a job.
createJobRequest - Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
Creates a job.
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<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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificateRequest - The input for the CreateKeysAndCertificate operation.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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificateRequest - The input for the CreateKeysAndCertificate operation.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.
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.
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 AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdateRequest - Future<CreateOTAUpdateResult> createOTAUpdateAsync(CreateOTAUpdateRequest createOTAUpdateRequest, AsyncHandler<CreateOTAUpdateRequest,CreateOTAUpdateResult> asyncHandler)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
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<CreatePolicyResult> createPolicyAsync(CreatePolicyRequest createPolicyRequest)
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
createPolicyRequest - The input for the CreatePolicy operation.Future<CreatePolicyResult> createPolicyAsync(CreatePolicyRequest createPolicyRequest, AsyncHandler<CreatePolicyRequest,CreatePolicyResult> asyncHandler)
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
createPolicyRequest - The input for the CreatePolicy operation.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 AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
createPolicyVersionRequest - The input for the CreatePolicyVersion operation.Future<CreatePolicyVersionResult> createPolicyVersionAsync(CreatePolicyVersionRequest createPolicyVersionRequest, AsyncHandler<CreatePolicyVersionRequest,CreatePolicyVersionResult> asyncHandler)
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
createPolicyVersionRequest - The input for the CreatePolicyVersion operation.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.
createProvisioningClaimRequest - Future<CreateProvisioningClaimResult> createProvisioningClaimAsync(CreateProvisioningClaimRequest createProvisioningClaimRequest, AsyncHandler<CreateProvisioningClaimRequest,CreateProvisioningClaimResult> asyncHandler)
Creates a provisioning claim.
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 fleet provisioning template.
createProvisioningTemplateRequest - Future<CreateProvisioningTemplateResult> createProvisioningTemplateAsync(CreateProvisioningTemplateRequest createProvisioningTemplateRequest, AsyncHandler<CreateProvisioningTemplateRequest,CreateProvisioningTemplateResult> asyncHandler)
Creates a fleet provisioning template.
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 fleet provisioning template.
createProvisioningTemplateVersionRequest - Future<CreateProvisioningTemplateVersionResult> createProvisioningTemplateVersionAsync(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest, AsyncHandler<CreateProvisioningTemplateVersionRequest,CreateProvisioningTemplateVersionResult> asyncHandler)
Creates a new version of a fleet provisioning template.
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.
createRoleAliasRequest - Future<CreateRoleAliasResult> createRoleAliasAsync(CreateRoleAliasRequest createRoleAliasRequest, AsyncHandler<CreateRoleAliasRequest,CreateRoleAliasResult> asyncHandler)
Creates a role alias.
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.
createScheduledAuditRequest - Future<CreateScheduledAuditResult> createScheduledAuditAsync(CreateScheduledAuditRequest createScheduledAuditRequest, AsyncHandler<CreateScheduledAuditRequest,CreateScheduledAuditResult> asyncHandler)
Creates a scheduled audit that is run at a specified time interval.
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.
createSecurityProfileRequest - Future<CreateSecurityProfileResult> createSecurityProfileAsync(CreateSecurityProfileRequest createSecurityProfileRequest, AsyncHandler<CreateSecurityProfileRequest,CreateSecurityProfileResult> asyncHandler)
Creates a Device Defender security profile.
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.
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.
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.
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.
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.
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.
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.
createThingTypeRequest - The input for the CreateThingType operation.Future<CreateThingTypeResult> createThingTypeAsync(CreateThingTypeRequest createThingTypeRequest, AsyncHandler<CreateThingTypeRequest,CreateThingTypeResult> asyncHandler)
Creates a new thing type.
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.
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.
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.
createTopicRuleDestinationRequest - Future<CreateTopicRuleDestinationResult> createTopicRuleDestinationAsync(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest, AsyncHandler<CreateTopicRuleDestinationRequest,CreateTopicRuleDestinationResult> asyncHandler)
Creates a topic rule destination. The destination must be confirmed prior to use.
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.
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.
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.
deleteAuditSuppressionRequest - Future<DeleteAuditSuppressionResult> deleteAuditSuppressionAsync(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest, AsyncHandler<DeleteAuditSuppressionRequest,DeleteAuditSuppressionResult> asyncHandler)
Deletes a Device Defender audit suppression.
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.
deleteAuthorizerRequest - Future<DeleteAuthorizerResult> deleteAuthorizerAsync(DeleteAuthorizerRequest deleteAuthorizerRequest, AsyncHandler<DeleteAuthorizerRequest,DeleteAuthorizerResult> asyncHandler)
Deletes an authorizer.
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.
deleteBillingGroupRequest - Future<DeleteBillingGroupResult> deleteBillingGroupAsync(DeleteBillingGroupRequest deleteBillingGroupRequest, AsyncHandler<DeleteBillingGroupRequest,DeleteBillingGroupResult> asyncHandler)
Deletes the billing group.
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.
deleteCACertificateRequest - Input for the DeleteCACertificate operation.Future<DeleteCACertificateResult> deleteCACertificateAsync(DeleteCACertificateRequest deleteCACertificateRequest, AsyncHandler<DeleteCACertificateRequest,DeleteCACertificateResult> asyncHandler)
Deletes a registered CA certificate.
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest - The input for the DeleteCertificate operation.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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest - The input for the DeleteCertificate operation.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)
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
API with metricName set to your custom metric name.
Deletes a Device Defender detect custom metric.
deleteCustomMetricRequest - Future<DeleteCustomMetricResult> deleteCustomMetricAsync(DeleteCustomMetricRequest deleteCustomMetricRequest, AsyncHandler<DeleteCustomMetricRequest,DeleteCustomMetricResult> asyncHandler)
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
API with metricName set to your custom metric name.
Deletes a Device Defender detect custom metric.
deleteCustomMetricRequest - 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 AWS account.
deleteDimensionRequest - Future<DeleteDimensionResult> deleteDimensionAsync(DeleteDimensionRequest deleteDimensionRequest, AsyncHandler<DeleteDimensionRequest,DeleteDimensionResult> asyncHandler)
Removes the specified dimension from your AWS account.
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.
The domain configuration feature is in public preview and is subject to change.
deleteDomainConfigurationRequest - Future<DeleteDomainConfigurationResult> deleteDomainConfigurationAsync(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest, AsyncHandler<DeleteDomainConfigurationRequest,DeleteDomainConfigurationResult> asyncHandler)
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
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.
deleteDynamicThingGroupRequest - Future<DeleteDynamicThingGroupResult> deleteDynamicThingGroupAsync(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest, AsyncHandler<DeleteDynamicThingGroupRequest,DeleteDynamicThingGroupResult> asyncHandler)
Deletes a dynamic thing group.
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<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.
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.
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.
deleteJobExecutionRequest - Future<DeleteJobExecutionResult> deleteJobExecutionAsync(DeleteJobExecutionRequest deleteJobExecutionRequest, AsyncHandler<DeleteJobExecutionRequest,DeleteJobExecutionResult> asyncHandler)
Deletes a job execution.
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<DeleteMitigationActionResult> deleteMitigationActionAsync(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your AWS account.
deleteMitigationActionRequest - Future<DeleteMitigationActionResult> deleteMitigationActionAsync(DeleteMitigationActionRequest deleteMitigationActionRequest, AsyncHandler<DeleteMitigationActionRequest,DeleteMitigationActionResult> asyncHandler)
Deletes a defined mitigation action from your AWS account.
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.
deleteOTAUpdateRequest - Future<DeleteOTAUpdateResult> deleteOTAUpdateAsync(DeleteOTAUpdateRequest deleteOTAUpdateRequest, AsyncHandler<DeleteOTAUpdateRequest,DeleteOTAUpdateResult> asyncHandler)
Delete an OTA update.
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<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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest - The input for the DeletePolicy operation.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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest - The input for the DeletePolicy operation.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 API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
deletePolicyVersionRequest - The input for the DeletePolicyVersion operation.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 API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
deletePolicyVersionRequest - The input for the DeletePolicyVersion operation.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 fleet provisioning template.
deleteProvisioningTemplateRequest - Future<DeleteProvisioningTemplateResult> deleteProvisioningTemplateAsync(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest, AsyncHandler<DeleteProvisioningTemplateRequest,DeleteProvisioningTemplateResult> asyncHandler)
Deletes a fleet provisioning template.
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 fleet provisioning template version.
deleteProvisioningTemplateVersionRequest - Future<DeleteProvisioningTemplateVersionResult> deleteProvisioningTemplateVersionAsync(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest, AsyncHandler<DeleteProvisioningTemplateVersionRequest,DeleteProvisioningTemplateVersionResult> asyncHandler)
Deletes a fleet provisioning template version.
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.
deleteRegistrationCodeRequest - The input for the DeleteRegistrationCode operation.Future<DeleteRegistrationCodeResult> deleteRegistrationCodeAsync(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest, AsyncHandler<DeleteRegistrationCodeRequest,DeleteRegistrationCodeResult> asyncHandler)
Deletes a CA certificate registration code.
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
deleteRoleAliasRequest - Future<DeleteRoleAliasResult> deleteRoleAliasAsync(DeleteRoleAliasRequest deleteRoleAliasRequest, AsyncHandler<DeleteRoleAliasRequest,DeleteRoleAliasResult> asyncHandler)
Deletes a role alias
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.
deleteScheduledAuditRequest - Future<DeleteScheduledAuditResult> deleteScheduledAuditAsync(DeleteScheduledAuditRequest deleteScheduledAuditRequest, AsyncHandler<DeleteScheduledAuditRequest,DeleteScheduledAuditResult> asyncHandler)
Deletes a scheduled audit.
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.
deleteSecurityProfileRequest - Future<DeleteSecurityProfileResult> deleteSecurityProfileAsync(DeleteSecurityProfileRequest deleteSecurityProfileRequest, AsyncHandler<DeleteSecurityProfileRequest,DeleteSecurityProfileResult> asyncHandler)
Deletes a Device Defender security profile.
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.
deleteStreamRequest - Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest deleteStreamRequest, AsyncHandler<DeleteStreamRequest,DeleteStreamResult> asyncHandler)
Deletes a stream.
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.
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.
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.
deleteThingGroupRequest - Future<DeleteThingGroupResult> deleteThingGroupAsync(DeleteThingGroupRequest deleteThingGroupRequest, AsyncHandler<DeleteThingGroupRequest,DeleteThingGroupResult> asyncHandler)
Deletes a thing group.
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.
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.
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.
deleteTopicRuleRequest - The input for the DeleteTopicRule operation.Future<DeleteTopicRuleResult> deleteTopicRuleAsync(DeleteTopicRuleRequest deleteTopicRuleRequest, AsyncHandler<DeleteTopicRuleRequest,DeleteTopicRuleResult> asyncHandler)
Deletes the rule.
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.
deleteTopicRuleDestinationRequest - Future<DeleteTopicRuleDestinationResult> deleteTopicRuleDestinationAsync(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest, AsyncHandler<DeleteTopicRuleDestinationRequest,DeleteTopicRuleDestinationResult> asyncHandler)
Deletes a topic rule destination.
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.
deleteV2LoggingLevelRequest - Future<DeleteV2LoggingLevelResult> deleteV2LoggingLevelAsync(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest, AsyncHandler<DeleteV2LoggingLevelRequest,DeleteV2LoggingLevelResult> asyncHandler)
Deletes a logging level.
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.
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.
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.
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.
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.
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.
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.
describeAuditTaskRequest - Future<DescribeAuditTaskResult> describeAuditTaskAsync(DescribeAuditTaskRequest describeAuditTaskRequest, AsyncHandler<DescribeAuditTaskRequest,DescribeAuditTaskResult> asyncHandler)
Gets information about a Device Defender audit.
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.
describeAuthorizerRequest - Future<DescribeAuthorizerResult> describeAuthorizerAsync(DescribeAuthorizerRequest describeAuthorizerRequest, AsyncHandler<DescribeAuthorizerRequest,DescribeAuthorizerResult> asyncHandler)
Describes an authorizer.
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.
describeBillingGroupRequest - Future<DescribeBillingGroupResult> describeBillingGroupAsync(DescribeBillingGroupRequest describeBillingGroupRequest, AsyncHandler<DescribeBillingGroupRequest,DescribeBillingGroupResult> asyncHandler)
Returns information about a billing group.
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.
describeCACertificateRequest - The input for the DescribeCACertificate operation.Future<DescribeCACertificateResult> describeCACertificateAsync(DescribeCACertificateRequest describeCACertificateRequest, AsyncHandler<DescribeCACertificateRequest,DescribeCACertificateResult> asyncHandler)
Describes a registered CA certificate.
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.
describeCertificateRequest - The input for the DescribeCertificate operation.Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
Gets information about the specified certificate.
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<DescribeCustomMetricResult> describeCustomMetricAsync(DescribeCustomMetricRequest describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.
describeCustomMetricRequest - Future<DescribeCustomMetricResult> describeCustomMetricAsync(DescribeCustomMetricRequest describeCustomMetricRequest, AsyncHandler<DescribeCustomMetricRequest,DescribeCustomMetricResult> asyncHandler)
Gets information about a Device Defender detect custom metric.
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.
describeDefaultAuthorizerRequest - Future<DescribeDefaultAuthorizerResult> describeDefaultAuthorizerAsync(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest, AsyncHandler<DescribeDefaultAuthorizerRequest,DescribeDefaultAuthorizerResult> asyncHandler)
Describes the default authorizer.
describeDefaultAuthorizerRequest - 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<DescribeDetectMitigationActionsTaskResult> describeDetectMitigationActionsTaskAsync(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest)
Gets information about a Device Defender ML Detect mitigation action.
describeDetectMitigationActionsTaskRequest - Future<DescribeDetectMitigationActionsTaskResult> describeDetectMitigationActionsTaskAsync(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest, AsyncHandler<DescribeDetectMitigationActionsTaskRequest,DescribeDetectMitigationActionsTaskResult> asyncHandler)
Gets information about a Device Defender ML Detect mitigation action.
describeDetectMitigationActionsTaskRequest - 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<DescribeDimensionResult> describeDimensionAsync(DescribeDimensionRequest describeDimensionRequest)
Provides details about a dimension that is defined in your AWS account.
describeDimensionRequest - Future<DescribeDimensionResult> describeDimensionAsync(DescribeDimensionRequest describeDimensionRequest, AsyncHandler<DescribeDimensionRequest,DescribeDimensionResult> asyncHandler)
Provides details about a dimension that is defined in your AWS account.
describeDimensionRequest - 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<DescribeDomainConfigurationResult> describeDomainConfigurationAsync(DescribeDomainConfigurationRequest describeDomainConfigurationRequest)
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
describeDomainConfigurationRequest - Future<DescribeDomainConfigurationResult> describeDomainConfigurationAsync(DescribeDomainConfigurationRequest describeDomainConfigurationRequest, AsyncHandler<DescribeDomainConfigurationRequest,DescribeDomainConfigurationResult> asyncHandler)
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
describeDomainConfigurationRequest - 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<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest - The input for the DescribeEndpoint operation.Future<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest, AsyncHandler<DescribeEndpointRequest,DescribeEndpointResult> asyncHandler)
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest - The input for the DescribeEndpoint 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<DescribeEventConfigurationsResult> describeEventConfigurationsAsync(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.
describeEventConfigurationsRequest - Future<DescribeEventConfigurationsResult> describeEventConfigurationsAsync(DescribeEventConfigurationsRequest describeEventConfigurationsRequest, AsyncHandler<DescribeEventConfigurationsRequest,DescribeEventConfigurationsResult> asyncHandler)
Describes event configurations.
describeEventConfigurationsRequest - 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<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest describeIndexRequest)
Describes a search index.
describeIndexRequest - Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest describeIndexRequest, AsyncHandler<DescribeIndexRequest,DescribeIndexResult> asyncHandler)
Describes a search index.
describeIndexRequest - 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<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest)
Describes a job.
describeJobRequest - Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
Describes a job.
describeJobRequest - 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<DescribeJobExecutionResult> describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.
describeJobExecutionRequest - Future<DescribeJobExecutionResult> describeJobExecutionAsync(DescribeJobExecutionRequest describeJobExecutionRequest, AsyncHandler<DescribeJobExecutionRequest,DescribeJobExecutionResult> asyncHandler)
Describes a job execution.
describeJobExecutionRequest - 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<DescribeMitigationActionResult> describeMitigationActionAsync(DescribeMitigationActionRequest describeMitigationActionRequest)
Gets information about a mitigation action.
describeMitigationActionRequest - Future<DescribeMitigationActionResult> describeMitigationActionAsync(DescribeMitigationActionRequest describeMitigationActionRequest, AsyncHandler<DescribeMitigationActionRequest,DescribeMitigationActionResult> asyncHandler)
Gets information about a mitigation action.
describeMitigationActionRequest - 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<DescribeProvisioningTemplateResult> describeProvisioningTemplateAsync(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest)
Returns information about a fleet provisioning template.
describeProvisioningTemplateRequest - Future<DescribeProvisioningTemplateResult> describeProvisioningTemplateAsync(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest, AsyncHandler<DescribeProvisioningTemplateRequest,DescribeProvisioningTemplateResult> asyncHandler)
Returns information about a fleet provisioning template.
describeProvisioningTemplateRequest - 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<DescribeProvisioningTemplateVersionResult> describeProvisioningTemplateVersionAsync(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest)
Returns information about a fleet provisioning template version.
describeProvisioningTemplateVersionRequest - Future<DescribeProvisioningTemplateVersionResult> describeProvisioningTemplateVersionAsync(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest, AsyncHandler<DescribeProvisioningTemplateVersionRequest,DescribeProvisioningTemplateVersionResult> asyncHandler)
Returns information about a fleet provisioning template version.
describeProvisioningTemplateVersionRequest - 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<DescribeRoleAliasResult> describeRoleAliasAsync(DescribeRoleAliasRequest describeRoleAliasRequest)
Describes a role alias.
describeRoleAliasRequest - Future<DescribeRoleAliasResult> describeRoleAliasAsync(DescribeRoleAliasRequest describeRoleAliasRequest, AsyncHandler<DescribeRoleAliasRequest,DescribeRoleAliasResult> asyncHandler)
Describes a role alias.
describeRoleAliasRequest - 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<DescribeScheduledAuditResult> describeScheduledAuditAsync(DescribeScheduledAuditRequest describeScheduledAuditRequest)
Gets information about a scheduled audit.
describeScheduledAuditRequest - Future<DescribeScheduledAuditResult> describeScheduledAuditAsync(DescribeScheduledAuditRequest describeScheduledAuditRequest, AsyncHandler<DescribeScheduledAuditRequest,DescribeScheduledAuditResult> asyncHandler)
Gets information about a scheduled audit.
describeScheduledAuditRequest - 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<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets information about a Device Defender security profile.
describeSecurityProfileRequest - Future<DescribeSecurityProfileResult> describeSecurityProfileAsync(DescribeSecurityProfileRequest describeSecurityProfileRequest, AsyncHandler<DescribeSecurityProfileRequest,DescribeSecurityProfileResult> asyncHandler)
Gets information about a Device Defender security profile.
describeSecurityProfileRequest - 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<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest describeStreamRequest)
Gets information about a stream.
describeStreamRequest - Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest describeStreamRequest, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
Gets information about a stream.
describeStreamRequest - 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<DescribeThingResult> describeThingAsync(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
describeThingRequest - The input for the DescribeThing operation.Future<DescribeThingResult> describeThingAsync(DescribeThingRequest describeThingRequest, AsyncHandler<DescribeThingRequest,DescribeThingResult> asyncHandler)
Gets information about the specified thing.
describeThingRequest - The input for the DescribeThing 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<DescribeThingGroupResult> describeThingGroupAsync(DescribeThingGroupRequest describeThingGroupRequest)
Describe a thing group.
describeThingGroupRequest - Future<DescribeThingGroupResult> describeThingGroupAsync(DescribeThingGroupRequest describeThingGroupRequest, AsyncHandler<DescribeThingGroupRequest,DescribeThingGroupResult> asyncHandler)
Describe a thing group.
describeThingGroupRequest - 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<DescribeThingRegistrationTaskResult> describeThingRegistrationTaskAsync(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.
describeThingRegistrationTaskRequest - Future<DescribeThingRegistrationTaskResult> describeThingRegistrationTaskAsync(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest, AsyncHandler<DescribeThingRegistrationTaskRequest,DescribeThingRegistrationTaskResult> asyncHandler)
Describes a bulk thing provisioning task.
describeThingRegistrationTaskRequest - 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<DescribeThingTypeResult> describeThingTypeAsync(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
describeThingTypeRequest - The input for the DescribeThingType operation.Future<DescribeThingTypeResult> describeThingTypeAsync(DescribeThingTypeRequest describeThingTypeRequest, AsyncHandler<DescribeThingTypeRequest,DescribeThingTypeResult> asyncHandler)
Gets information about the specified thing type.
describeThingTypeRequest - The input for the DescribeThingType 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<DetachPolicyResult> detachPolicyAsync(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.
detachPolicyRequest - Future<DetachPolicyResult> detachPolicyAsync(DetachPolicyRequest detachPolicyRequest, AsyncHandler<DetachPolicyRequest,DetachPolicyResult> asyncHandler)
Detaches a policy from the specified target.
detachPolicyRequest - 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<DetachPrincipalPolicyResult> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.@Deprecated Future<DetachPrincipalPolicyResult> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest, AsyncHandler<DetachPrincipalPolicyRequest,DetachPrincipalPolicyResult> asyncHandler)
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy 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<DetachSecurityProfileResult> detachSecurityProfileAsync(DetachSecurityProfileRequest detachSecurityProfileRequest)
Disassociates a Device Defender security profile from a thing group or from this account.
detachSecurityProfileRequest - Future<DetachSecurityProfileResult> detachSecurityProfileAsync(DetachSecurityProfileRequest detachSecurityProfileRequest, AsyncHandler<DetachSecurityProfileRequest,DetachSecurityProfileResult> asyncHandler)
Disassociates a Device Defender security profile from a thing group or from this account.
detachSecurityProfileRequest - 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<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
detachThingPrincipalRequest - The input for the DetachThingPrincipal operation.Future<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest detachThingPrincipalRequest, AsyncHandler<DetachThingPrincipalRequest,DetachThingPrincipalResult> asyncHandler)
Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
detachThingPrincipalRequest - The input for the DetachThingPrincipal 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<DisableTopicRuleResult> disableTopicRuleAsync(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.
disableTopicRuleRequest - The input for the DisableTopicRuleRequest operation.Future<DisableTopicRuleResult> disableTopicRuleAsync(DisableTopicRuleRequest disableTopicRuleRequest, AsyncHandler<DisableTopicRuleRequest,DisableTopicRuleResult> asyncHandler)
Disables the rule.
disableTopicRuleRequest - The input for the DisableTopicRuleRequest 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<EnableTopicRuleResult> enableTopicRuleAsync(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the rule.
enableTopicRuleRequest - The input for the EnableTopicRuleRequest operation.Future<EnableTopicRuleResult> enableTopicRuleAsync(EnableTopicRuleRequest enableTopicRuleRequest, AsyncHandler<EnableTopicRuleRequest,EnableTopicRuleResult> asyncHandler)
Enables the rule.
enableTopicRuleRequest - The input for the EnableTopicRuleRequest 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<GetBehaviorModelTrainingSummariesResult> getBehaviorModelTrainingSummariesAsync(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.
getBehaviorModelTrainingSummariesRequest - Future<GetBehaviorModelTrainingSummariesResult> getBehaviorModelTrainingSummariesAsync(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest, AsyncHandler<GetBehaviorModelTrainingSummariesRequest,GetBehaviorModelTrainingSummariesResult> asyncHandler)
Returns a Device Defender's ML Detect Security Profile training model's status.
getBehaviorModelTrainingSummariesRequest - 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<GetCardinalityResult> getCardinalityAsync(GetCardinalityRequest getCardinalityRequest)
Returns the approximate count of unique values that match the query.
getCardinalityRequest - Future<GetCardinalityResult> getCardinalityAsync(GetCardinalityRequest getCardinalityRequest, AsyncHandler<GetCardinalityRequest,GetCardinalityResult> asyncHandler)
Returns the approximate count of unique values that match the query.
getCardinalityRequest - 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<GetEffectivePoliciesResult> getEffectivePoliciesAsync(GetEffectivePoliciesRequest getEffectivePoliciesRequest)
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
getEffectivePoliciesRequest - Future<GetEffectivePoliciesResult> getEffectivePoliciesAsync(GetEffectivePoliciesRequest getEffectivePoliciesRequest, AsyncHandler<GetEffectivePoliciesRequest,GetEffectivePoliciesResult> asyncHandler)
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
getEffectivePoliciesRequest - 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<GetIndexingConfigurationResult> getIndexingConfigurationAsync(GetIndexingConfigurationRequest getIndexingConfigurationRequest)
Gets the indexing configuration.
getIndexingConfigurationRequest - Future<GetIndexingConfigurationResult> getIndexingConfigurationAsync(GetIndexingConfigurationRequest getIndexingConfigurationRequest, AsyncHandler<GetIndexingConfigurationRequest,GetIndexingConfigurationResult> asyncHandler)
Gets the indexing configuration.
getIndexingConfigurationRequest - 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<GetJobDocumentResult> getJobDocumentAsync(GetJobDocumentRequest getJobDocumentRequest)
Gets a job document.
getJobDocumentRequest - Future<GetJobDocumentResult> getJobDocumentAsync(GetJobDocumentRequest getJobDocumentRequest, AsyncHandler<GetJobDocumentRequest,GetJobDocumentResult> asyncHandler)
Gets a job document.
getJobDocumentRequest - 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<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
getLoggingOptionsRequest - The input for the GetLoggingOptions operation.Future<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest getLoggingOptionsRequest, AsyncHandler<GetLoggingOptionsRequest,GetLoggingOptionsResult> asyncHandler)
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
getLoggingOptionsRequest - The input for the GetLoggingOptions 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<GetOTAUpdateResult> getOTAUpdateAsync(GetOTAUpdateRequest getOTAUpdateRequest)
Gets an OTA update.
getOTAUpdateRequest - Future<GetOTAUpdateResult> getOTAUpdateAsync(GetOTAUpdateRequest getOTAUpdateRequest, AsyncHandler<GetOTAUpdateRequest,GetOTAUpdateResult> asyncHandler)
Gets an OTA update.
getOTAUpdateRequest - 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<GetPercentilesResult> getPercentilesAsync(GetPercentilesRequest getPercentilesRequest)
Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This
function returns a value for each percentile group specified (or the default percentile groupings). The
percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation, the more values that
match the query, the more accurate the percentile values.
getPercentilesRequest - Future<GetPercentilesResult> getPercentilesAsync(GetPercentilesRequest getPercentilesRequest, AsyncHandler<GetPercentilesRequest,GetPercentilesResult> asyncHandler)
Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This
function returns a value for each percentile group specified (or the default percentile groupings). The
percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation, the more values that
match the query, the more accurate the percentile values.
getPercentilesRequest - 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<GetPolicyResult> getPolicyAsync(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest - The input for the GetPolicy operation.Future<GetPolicyResult> getPolicyAsync(GetPolicyRequest getPolicyRequest, AsyncHandler<GetPolicyRequest,GetPolicyResult> asyncHandler)
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest - The input for the GetPolicy 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<GetPolicyVersionResult> getPolicyVersionAsync(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
getPolicyVersionRequest - The input for the GetPolicyVersion operation.Future<GetPolicyVersionResult> getPolicyVersionAsync(GetPolicyVersionRequest getPolicyVersionRequest, AsyncHandler<GetPolicyVersionRequest,GetPolicyVersionResult> asyncHandler)
Gets information about the specified policy version.
getPolicyVersionRequest - The input for the GetPolicyVersion 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<GetRegistrationCodeResult> getRegistrationCodeAsync(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest - The input to the GetRegistrationCode operation.Future<GetRegistrationCodeResult> getRegistrationCodeAsync(GetRegistrationCodeRequest getRegistrationCodeRequest, AsyncHandler<GetRegistrationCodeRequest,GetRegistrationCodeResult> asyncHandler)
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest - The input to the GetRegistrationCode 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<GetStatisticsResult> getStatisticsAsync(GetStatisticsRequest getStatisticsRequest)
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the
specified aggregated field. If the aggregation field is of type String, only the count statistic is
returned.
getStatisticsRequest - Future<GetStatisticsResult> getStatisticsAsync(GetStatisticsRequest getStatisticsRequest, AsyncHandler<GetStatisticsRequest,GetStatisticsResult> asyncHandler)
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the
specified aggregated field. If the aggregation field is of type String, only the count statistic is
returned.
getStatisticsRequest - 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<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the rule.
getTopicRuleRequest - The input for the GetTopicRule operation.Future<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest getTopicRuleRequest, AsyncHandler<GetTopicRuleRequest,GetTopicRuleResult> asyncHandler)
Gets information about the rule.
getTopicRuleRequest - The input for the GetTopicRule 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<GetTopicRuleDestinationResult> getTopicRuleDestinationAsync(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest)
Gets information about a topic rule destination.
getTopicRuleDestinationRequest - Future<GetTopicRuleDestinationResult> getTopicRuleDestinationAsync(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest, AsyncHandler<GetTopicRuleDestinationRequest,GetTopicRuleDestinationResult> asyncHandler)
Gets information about a topic rule destination.
getTopicRuleDestinationRequest - 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<GetV2LoggingOptionsResult> getV2LoggingOptionsAsync(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest)
Gets the fine grained logging options.
getV2LoggingOptionsRequest - Future<GetV2LoggingOptionsResult> getV2LoggingOptionsAsync(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest, AsyncHandler<GetV2LoggingOptionsRequest,GetV2LoggingOptionsResult> asyncHandler)
Gets the fine grained logging options.
getV2LoggingOptionsRequest - 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<ListActiveViolationsResult> listActiveViolationsAsync(ListActiveViolationsRequest listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.
listActiveViolationsRequest - Future<ListActiveViolationsResult> listActiveViolationsAsync(ListActiveViolationsRequest listActiveViolationsRequest, AsyncHandler<ListActiveViolationsRequest,ListActiveViolationsResult> asyncHandler)
Lists the active violations for a given Device Defender security profile.
listActiveViolationsRequest - 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<ListAttachedPoliciesResult> listAttachedPoliciesAsync(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.
listAttachedPoliciesRequest - Future<ListAttachedPoliciesResult> listAttachedPoliciesAsync(ListAttachedPoliciesRequest listAttachedPoliciesRequest, AsyncHandler<ListAttachedPoliciesRequest,ListAttachedPoliciesResult> asyncHandler)
Lists the policies attached to the specified thing group.
listAttachedPoliciesRequest - 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<ListAuditFindingsResult> listAuditFindingsAsync(ListAuditFindingsRequest listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
listAuditFindingsRequest - Future<ListAuditFindingsResult> listAuditFindingsAsync(ListAuditFindingsRequest listAuditFindingsRequest, AsyncHandler<ListAuditFindingsRequest,ListAuditFindingsResult> asyncHandler)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
listAuditFindingsRequest - 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<ListAuditMitigationActionsExecutionsResult> listAuditMitigationActionsExecutionsAsync(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.
listAuditMitigationActionsExecutionsRequest - Future<ListAuditMitigationActionsExecutionsResult> listAuditMitigationActionsExecutionsAsync(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest, AsyncHandler<ListAuditMitigationActionsExecutionsRequest,ListAuditMitigationActionsExecutionsResult> asyncHandler)
Gets the status of audit mitigation action tasks that were executed.
listAuditMitigationActionsExecutionsRequest - 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<ListAuditMitigationActionsTasksResult> listAuditMitigationActionsTasksAsync(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.
listAuditMitigationActionsTasksRequest - Future<ListAuditMitigationActionsTasksResult> listAuditMitigationActionsTasksAsync(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest, AsyncHandler<ListAuditMitigationActionsTasksRequest,ListAuditMitigationActionsTasksResult> asyncHandler)
Gets a list of audit mitigation action tasks that match the specified filters.
listAuditMitigationActionsTasksRequest - 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<ListAuditSuppressionsResult> listAuditSuppressionsAsync(ListAuditSuppressionsRequest listAuditSuppressionsRequest)
Lists your Device Defender audit listings.
listAuditSuppressionsRequest - Future<ListAuditSuppressionsResult> listAuditSuppressionsAsync(ListAuditSuppressionsRequest listAuditSuppressionsRequest, AsyncHandler<ListAuditSuppressionsRequest,ListAuditSuppressionsResult> asyncHandler)
Lists your Device Defender audit listings.
listAuditSuppressionsRequest - 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<ListAuditTasksResult> listAuditTasksAsync(ListAuditTasksRequest listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.
listAuditTasksRequest - Future<ListAuditTasksResult> listAuditTasksAsync(ListAuditTasksRequest listAuditTasksRequest, AsyncHandler<ListAuditTasksRequest,ListAuditTasksResult> asyncHandler)
Lists the Device Defender audits that have been performed during a given time period.
listAuditTasksRequest - 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<ListAuthorizersResult> listAuthorizersAsync(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.
listAuthorizersRequest - Future<ListAuthorizersResult> listAuthorizersAsync(ListAuthorizersRequest listAuthorizersRequest, AsyncHandler<ListAuthorizersRequest,ListAuthorizersResult> asyncHandler)
Lists the authorizers registered in your account.
listAuthorizersRequest - 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<ListBillingGroupsResult> listBillingGroupsAsync(ListBillingGroupsRequest listBillingGroupsRequest)
Lists the billing groups you have created.
listBillingGroupsRequest - Future<ListBillingGroupsResult> listBillingGroupsAsync(ListBillingGroupsRequest listBillingGroupsRequest, AsyncHandler<ListBillingGroupsRequest,ListBillingGroupsResult> asyncHandler)
Lists the billing groups you have created.
l