public class AWSIotAsyncClient extends AWSIotClient implements AWSIotAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
AWS IoT provides secure, bi-directional communication between Internet-connected things (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 thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.
For more information about how AWS IoT works, see the Developer Guide.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AWSIotAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS
IoT.
|
AWSIotAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials.
|
AWSIotAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials, executor service, and client
configuration options.
|
AWSIotAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials and executor service.
|
AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials provider.
|
AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the provided AWS account credentials provider and client
configuration options.
|
AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials provider, executor service,
and client configuration options.
|
AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS IoT
using the specified AWS account credentials provider and executor
service.
|
AWSIotAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS
IoT.
|
acceptCertificateTransfer, attachPrincipalPolicy, attachThingPrincipal, cancelCertificateTransfer, createCertificateFromCsr, createKeysAndCertificate, createPolicy, createPolicyVersion, createThing, createTopicRule, deleteCertificate, deletePolicy, deletePolicyVersion, deleteThing, deleteTopicRule, describeCertificate, describeEndpoint, describeThing, detachPrincipalPolicy, detachThingPrincipal, getCachedResponseMetadata, getLoggingOptions, getPolicy, getPolicyVersion, getTopicRule, listCertificates, listPolicies, listPolicyVersions, listPrincipalPolicies, listPrincipalThings, listThingPrincipals, listThings, listTopicRules, rejectCertificateTransfer, replaceTopicRule, setDefaultPolicyVersion, setLoggingOptions, transferCertificate, updateCertificate, updateThingaddRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitacceptCertificateTransfer, attachPrincipalPolicy, attachThingPrincipal, cancelCertificateTransfer, createCertificateFromCsr, createKeysAndCertificate, createPolicy, createPolicyVersion, createThing, createTopicRule, deleteCertificate, deletePolicy, deletePolicyVersion, deleteThing, deleteTopicRule, describeCertificate, describeEndpoint, describeThing, detachPrincipalPolicy, detachThingPrincipal, getCachedResponseMetadata, getLoggingOptions, getPolicy, getPolicyVersion, getTopicRule, listCertificates, listPolicies, listPolicyVersions, listPrincipalPolicies, listPrincipalThings, listThingPrincipals, listThings, listTopicRules, rejectCertificateTransfer, replaceTopicRule, setDefaultPolicyVersion, setEndpoint, setLoggingOptions, setRegion, transferCertificate, updateCertificate, updateThingpublic AWSIotAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSIotAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client
connects to AWS IoT (ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSIotAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSIotAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSIotAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSIotAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public ExecutorService getExecutorService()
public Future<Void> acceptCertificateTransferAsync(AcceptCertificateTransferRequest request)
AWSIotAsyncAccepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
acceptCertificateTransferAsync in interface AWSIotAsyncrequest - The input for the AcceptCertificateTransfer operation.public Future<Void> acceptCertificateTransferAsync(AcceptCertificateTransferRequest request, AsyncHandler<AcceptCertificateTransferRequest,Void> asyncHandler)
AWSIotAsyncAccepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
acceptCertificateTransferAsync in interface AWSIotAsyncrequest - 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.public Future<Void> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest request)
AWSIotAsyncAttaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyAsync in interface AWSIotAsyncrequest - The input for the AttachPrincipalPolicy operation.public Future<Void> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest request, AsyncHandler<AttachPrincipalPolicyRequest,Void> asyncHandler)
AWSIotAsyncAttaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyAsync in interface AWSIotAsyncrequest - 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.public Future<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest request)
AWSIotAsyncAttaches the specified principal to the specified thing.
attachThingPrincipalAsync in interface AWSIotAsyncrequest - The input for the AttachThingPrincipal operation.public Future<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest request, AsyncHandler<AttachThingPrincipalRequest,AttachThingPrincipalResult> asyncHandler)
AWSIotAsyncAttaches the specified principal to the specified thing.
attachThingPrincipalAsync in interface AWSIotAsyncrequest - 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.public Future<Void> cancelCertificateTransferAsync(CancelCertificateTransferRequest request)
AWSIotAsyncCancels 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. Once the destination account has accepted the transfer, the transfer may no longer be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferAsync in interface AWSIotAsyncrequest - The input for the CancelCertificateTransfer operation.public Future<Void> cancelCertificateTransferAsync(CancelCertificateTransferRequest request, AsyncHandler<CancelCertificateTransferRequest,Void> asyncHandler)
AWSIotAsyncCancels 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. Once the destination account has accepted the transfer, the transfer may no longer be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferAsync in interface AWSIotAsyncrequest - 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.public Future<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest request)
AWSIotAsyncCreates an X.509 certificate using the specified certificate signing request.
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 and copying multiple .csr files into that directory and 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 OSX, 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 filename 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 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"
createCertificateFromCsrAsync in interface AWSIotAsyncrequest - The input for the CreateCertificateFromCsr operation.public Future<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest request, AsyncHandler<CreateCertificateFromCsrRequest,CreateCertificateFromCsrResult> asyncHandler)
AWSIotAsyncCreates an X.509 certificate using the specified certificate signing request.
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 and copying multiple .csr files into that directory and 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 OSX, 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 filename 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 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"
createCertificateFromCsrAsync in interface AWSIotAsyncrequest - 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.public Future<CreateKeysAndCertificateResult> createKeysAndCertificateAsync(CreateKeysAndCertificateRequest request)
AWSIotAsyncCreates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key.
createKeysAndCertificateAsync in interface AWSIotAsyncrequest - The input for the CreateKeysAndCertificate operation.public Future<CreateKeysAndCertificateResult> createKeysAndCertificateAsync(CreateKeysAndCertificateRequest request, AsyncHandler<CreateKeysAndCertificateRequest,CreateKeysAndCertificateResult> asyncHandler)
AWSIotAsyncCreates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key.
createKeysAndCertificateAsync in interface AWSIotAsyncrequest - 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.public Future<CreatePolicyResult> createPolicyAsync(CreatePolicyRequest request)
AWSIotAsyncCreates 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.
createPolicyAsync in interface AWSIotAsyncrequest - The input for the CreatePolicy operation.public Future<CreatePolicyResult> createPolicyAsync(CreatePolicyRequest request, AsyncHandler<CreatePolicyRequest,CreatePolicyResult> asyncHandler)
AWSIotAsyncCreates 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.
createPolicyAsync in interface AWSIotAsyncrequest - 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.public Future<CreatePolicyVersionResult> createPolicyVersionAsync(CreatePolicyVersionRequest request)
AWSIotAsyncCreates 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 delete an existing version using DeletePolicyVersion before you create a new version.
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 that the policy is attached to.
createPolicyVersionAsync in interface AWSIotAsyncrequest - The input for the CreatePolicyVersion operation.public Future<CreatePolicyVersionResult> createPolicyVersionAsync(CreatePolicyVersionRequest request, AsyncHandler<CreatePolicyVersionRequest,CreatePolicyVersionResult> asyncHandler)
AWSIotAsyncCreates 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 delete an existing version using DeletePolicyVersion before you create a new version.
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 that the policy is attached to.
createPolicyVersionAsync in interface AWSIotAsyncrequest - 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.public Future<CreateThingResult> createThingAsync(CreateThingRequest request)
AWSIotAsyncCreates a thing in the thing registry.
createThingAsync in interface AWSIotAsyncrequest - The input for the CreateThing operation.public Future<CreateThingResult> createThingAsync(CreateThingRequest request, AsyncHandler<CreateThingRequest,CreateThingResult> asyncHandler)
AWSIotAsyncCreates a thing in the thing registry.
createThingAsync in interface AWSIotAsyncrequest - 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.public Future<Void> createTopicRuleAsync(CreateTopicRuleRequest request)
AWSIotAsyncCreates a rule.
createTopicRuleAsync in interface AWSIotAsyncrequest - The input for the CreateTopicRule operation.public Future<Void> createTopicRuleAsync(CreateTopicRuleRequest request, AsyncHandler<CreateTopicRuleRequest,Void> asyncHandler)
AWSIotAsyncCreates a rule.
createTopicRuleAsync in interface AWSIotAsyncrequest - 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.public Future<Void> deleteCertificateAsync(DeleteCertificateRequest request)
AWSIotAsyncDeletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first detach all policies using the DetachPrincipalPolicy API. Next use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateAsync in interface AWSIotAsyncrequest - The input for the DeleteCertificate operation.public Future<Void> deleteCertificateAsync(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,Void> asyncHandler)
AWSIotAsyncDeletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first detach all policies using the DetachPrincipalPolicy API. Next use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateAsync in interface AWSIotAsyncrequest - 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.public Future<Void> deletePolicyAsync(DeletePolicyRequest request)
AWSIotAsyncDeletes the specified policy.
A policy cannot be deleted if it has non-default versions and/or it is attached to any certificate.
To delete a policy, delete all non-default versions of the policy using the DeletePolicyVersion API, detach the policy from any certificate using the DetachPrincipalPolicy API, and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyAsync in interface AWSIotAsyncrequest - The input for the DeletePolicy operation.public Future<Void> deletePolicyAsync(DeletePolicyRequest request, AsyncHandler<DeletePolicyRequest,Void> asyncHandler)
AWSIotAsyncDeletes the specified policy.
A policy cannot be deleted if it has non-default versions and/or it is attached to any certificate.
To delete a policy, delete all non-default versions of the policy using the DeletePolicyVersion API, detach the policy from any certificate using the DetachPrincipalPolicy API, and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyAsync in interface AWSIotAsyncrequest - 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.public Future<Void> deletePolicyVersionAsync(DeletePolicyVersionRequest request)
AWSIotAsyncDeletes 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.
deletePolicyVersionAsync in interface AWSIotAsyncrequest - The input for the DeletePolicyVersion operation.public Future<Void> deletePolicyVersionAsync(DeletePolicyVersionRequest request, AsyncHandler<DeletePolicyVersionRequest,Void> asyncHandler)
AWSIotAsyncDeletes 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.
deletePolicyVersionAsync in interface AWSIotAsyncrequest - 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.public Future<DeleteThingResult> deleteThingAsync(DeleteThingRequest request)
AWSIotAsyncDeletes the specified thing from the Thing Registry.
deleteThingAsync in interface AWSIotAsyncrequest - The input for the DeleteThing operation.public Future<DeleteThingResult> deleteThingAsync(DeleteThingRequest request, AsyncHandler<DeleteThingRequest,DeleteThingResult> asyncHandler)
AWSIotAsyncDeletes the specified thing from the Thing Registry.
deleteThingAsync in interface AWSIotAsyncrequest - 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.public Future<Void> deleteTopicRuleAsync(DeleteTopicRuleRequest request)
AWSIotAsyncDeletes the specified rule.
deleteTopicRuleAsync in interface AWSIotAsyncrequest - The input for the DeleteTopicRule operation.public Future<Void> deleteTopicRuleAsync(DeleteTopicRuleRequest request, AsyncHandler<DeleteTopicRuleRequest,Void> asyncHandler)
AWSIotAsyncDeletes the specified rule.
deleteTopicRuleAsync in interface AWSIotAsyncrequest - 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.public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request)
AWSIotAsyncGets information about the specified certificate.
describeCertificateAsync in interface AWSIotAsyncrequest - The input for the DescribeCertificate operation.public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
AWSIotAsyncGets information about the specified certificate.
describeCertificateAsync in interface AWSIotAsyncrequest - 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.public Future<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest request)
AWSIotAsyncReturns a unique endpoint specific to the AWS account making the call. You specify the following URI when updating state information for your thing: https://endpoint/things/thingName/shadow.
describeEndpointAsync in interface AWSIotAsyncrequest - The input for the DescribeEndpoint operation.public Future<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest request, AsyncHandler<DescribeEndpointRequest,DescribeEndpointResult> asyncHandler)
AWSIotAsyncReturns a unique endpoint specific to the AWS account making the call. You specify the following URI when updating state information for your thing: https://endpoint/things/thingName/shadow.
describeEndpointAsync in interface AWSIotAsyncrequest - 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.public Future<DescribeThingResult> describeThingAsync(DescribeThingRequest request)
AWSIotAsyncGets information about the specified thing.
describeThingAsync in interface AWSIotAsyncrequest - The input for the DescribeThing operation.public Future<DescribeThingResult> describeThingAsync(DescribeThingRequest request, AsyncHandler<DescribeThingRequest,DescribeThingResult> asyncHandler)
AWSIotAsyncGets information about the specified thing.
describeThingAsync in interface AWSIotAsyncrequest - 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.public Future<Void> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest request)
AWSIotAsyncRemoves the specified policy from the specified certificate.
detachPrincipalPolicyAsync in interface AWSIotAsyncrequest - The input for the DetachPrincipalPolicy operation.public Future<Void> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest request, AsyncHandler<DetachPrincipalPolicyRequest,Void> asyncHandler)
AWSIotAsyncRemoves the specified policy from the specified certificate.
detachPrincipalPolicyAsync in interface AWSIotAsyncrequest - 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.public Future<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest request)
AWSIotAsyncDetaches the specified principal from the specified thing.
detachThingPrincipalAsync in interface AWSIotAsyncrequest - The input for the DetachThingPrincipal operation.public Future<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest request, AsyncHandler<DetachThingPrincipalRequest,DetachThingPrincipalResult> asyncHandler)
AWSIotAsyncDetaches the specified principal from the specified thing.
detachThingPrincipalAsync in interface AWSIotAsyncrequest - 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.public Future<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest request)
AWSIotAsyncGets the logging options.
getLoggingOptionsAsync in interface AWSIotAsyncrequest - The input for the GetLoggingOptions operation.public Future<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest request, AsyncHandler<GetLoggingOptionsRequest,GetLoggingOptionsResult> asyncHandler)
AWSIotAsyncGets the logging options.
getLoggingOptionsAsync in interface AWSIotAsyncrequest - 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.public Future<GetPolicyResult> getPolicyAsync(GetPolicyRequest request)
AWSIotAsyncGets information about the specified policy with the policy document of the default version.
getPolicyAsync in interface AWSIotAsyncrequest - The input for the GetPolicy operation.public Future<GetPolicyResult> getPolicyAsync(GetPolicyRequest request, AsyncHandler<GetPolicyRequest,GetPolicyResult> asyncHandler)
AWSIotAsyncGets information about the specified policy with the policy document of the default version.
getPolicyAsync in interface AWSIotAsyncrequest - 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.public Future<GetPolicyVersionResult> getPolicyVersionAsync(GetPolicyVersionRequest request)
AWSIotAsyncGets information about the specified policy version.
getPolicyVersionAsync in interface AWSIotAsyncrequest - The input for the GetPolicyVersion operation.public Future<GetPolicyVersionResult> getPolicyVersionAsync(GetPolicyVersionRequest request, AsyncHandler<GetPolicyVersionRequest,GetPolicyVersionResult> asyncHandler)
AWSIotAsyncGets information about the specified policy version.
getPolicyVersionAsync in interface AWSIotAsyncrequest - 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.public Future<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest request)
AWSIotAsyncGets information about the specified rule.
getTopicRuleAsync in interface AWSIotAsyncrequest - The input for the GetTopicRule operation.public Future<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest request, AsyncHandler<GetTopicRuleRequest,GetTopicRuleResult> asyncHandler)
AWSIotAsyncGets information about the specified rule.
getTopicRuleAsync in interface AWSIotAsyncrequest - 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.public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request)
AWSIotAsyncLists your certificates.
The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.
listCertificatesAsync in interface AWSIotAsyncrequest - The input for the ListCertificates operation.public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
AWSIotAsyncLists your certificates.
The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.
listCertificatesAsync in interface AWSIotAsyncrequest - The input for the ListCertificates 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.public Future<ListPoliciesResult> listPoliciesAsync(ListPoliciesRequest request)
AWSIotAsyncLists your policies.
listPoliciesAsync in interface AWSIotAsyncrequest - The input for the ListPolicies operation.public Future<ListPoliciesResult> listPoliciesAsync(ListPoliciesRequest request, AsyncHandler<ListPoliciesRequest,ListPoliciesResult> asyncHandler)
AWSIotAsyncLists your policies.
listPoliciesAsync in interface AWSIotAsyncrequest - The input for the ListPolicies 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.public Future<ListPolicyVersionsResult> listPolicyVersionsAsync(ListPolicyVersionsRequest request)
AWSIotAsyncLists the versions of the specified policy, and identifies the default version.
listPolicyVersionsAsync in interface AWSIotAsyncrequest - The input for the ListPolicyVersions operation.public Future<ListPolicyVersionsResult> listPolicyVersionsAsync(ListPolicyVersionsRequest request, AsyncHandler<ListPolicyVersionsRequest,ListPolicyVersionsResult> asyncHandler)
AWSIotAsyncLists the versions of the specified policy, and identifies the default version.
listPolicyVersionsAsync in interface AWSIotAsyncrequest - The input for the ListPolicyVersions 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.public Future<ListPrincipalPoliciesResult> listPrincipalPoliciesAsync(ListPrincipalPoliciesRequest request)
AWSIotAsyncLists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.
listPrincipalPoliciesAsync in interface AWSIotAsyncrequest - The input for the ListPrincipalPolicies operation.public Future<ListPrincipalPoliciesResult> listPrincipalPoliciesAsync(ListPrincipalPoliciesRequest request, AsyncHandler<ListPrincipalPoliciesRequest,ListPrincipalPoliciesResult> asyncHandler)
AWSIotAsyncLists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.
listPrincipalPoliciesAsync in interface AWSIotAsyncrequest - The input for the ListPrincipalPolicies 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.public Future<ListPrincipalThingsResult> listPrincipalThingsAsync(ListPrincipalThingsRequest request)
AWSIotAsyncLists the things associated with the specified principal.
listPrincipalThingsAsync in interface AWSIotAsyncrequest - The input for the ListPrincipalThings operation.public Future<ListPrincipalThingsResult> listPrincipalThingsAsync(ListPrincipalThingsRequest request, AsyncHandler<ListPrincipalThingsRequest,ListPrincipalThingsResult> asyncHandler)
AWSIotAsyncLists the things associated with the specified principal.
listPrincipalThingsAsync in interface AWSIotAsyncrequest - The input for the ListPrincipalThings 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.public Future<ListThingPrincipalsResult> listThingPrincipalsAsync(ListThingPrincipalsRequest request)
AWSIotAsyncLists the principals associated with the specified thing.
listThingPrincipalsAsync in interface AWSIotAsyncrequest - The input for the ListThingPrincipal operation.public Future<ListThingPrincipalsResult> listThingPrincipalsAsync(ListThingPrincipalsRequest request, AsyncHandler<ListThingPrincipalsRequest,ListThingPrincipalsResult> asyncHandler)
AWSIotAsyncLists the principals associated with the specified thing.
listThingPrincipalsAsync in interface AWSIotAsyncrequest - The input for the ListThingPrincipal 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.public Future<ListThingsResult> listThingsAsync(ListThingsRequest request)
AWSIotAsyncLists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"
listThingsAsync in interface AWSIotAsyncrequest - The input for the ListThings operation.public Future<ListThingsResult> listThingsAsync(ListThingsRequest request, AsyncHandler<ListThingsRequest,ListThingsResult> asyncHandler)
AWSIotAsyncLists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"
listThingsAsync in interface AWSIotAsyncrequest - The input for the ListThings 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.public Future<ListTopicRulesResult> listTopicRulesAsync(ListTopicRulesRequest request)
AWSIotAsyncLists the rules for the specific topic.
listTopicRulesAsync in interface AWSIotAsyncrequest - The input for the ListTopicRules operation.public Future<ListTopicRulesResult> listTopicRulesAsync(ListTopicRulesRequest request, AsyncHandler<ListTopicRulesRequest,ListTopicRulesResult> asyncHandler)
AWSIotAsyncLists the rules for the specific topic.
listTopicRulesAsync in interface AWSIotAsyncrequest - The input for the ListTopicRules 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.public Future<Void> rejectCertificateTransferAsync(RejectCertificateTransferRequest request)
AWSIotAsyncRejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source's account in the INACTIVE state.
rejectCertificateTransferAsync in interface AWSIotAsyncrequest - The input for the RejectCertificateTransfer operation.public Future<Void> rejectCertificateTransferAsync(RejectCertificateTransferRequest request, AsyncHandler<RejectCertificateTransferRequest,Void> asyncHandler)
AWSIotAsyncRejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source's account in the INACTIVE state.
rejectCertificateTransferAsync in interface AWSIotAsyncrequest - The input for the RejectCertificateTransfer 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.public Future<Void> replaceTopicRuleAsync(ReplaceTopicRuleRequest request)
AWSIotAsyncReplaces the specified rule. You must specify all parameters for the new rule.
replaceTopicRuleAsync in interface AWSIotAsyncrequest - The input for the ReplaceTopicRule operation.public Future<Void> replaceTopicRuleAsync(ReplaceTopicRuleRequest request, AsyncHandler<ReplaceTopicRuleRequest,Void> asyncHandler)
AWSIotAsyncReplaces the specified rule. You must specify all parameters for the new rule.
replaceTopicRuleAsync in interface AWSIotAsyncrequest - The input for the ReplaceTopicRule 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.public Future<Void> setDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest request)
AWSIotAsyncSets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates that the policy is attached to. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
setDefaultPolicyVersionAsync in interface AWSIotAsyncrequest - The input for the SetDefaultPolicyVersion operation.public Future<Void> setDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest request, AsyncHandler<SetDefaultPolicyVersionRequest,Void> asyncHandler)
AWSIotAsyncSets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates that the policy is attached to. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
setDefaultPolicyVersionAsync in interface AWSIotAsyncrequest - The input for the SetDefaultPolicyVersion 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.public Future<Void> setLoggingOptionsAsync(SetLoggingOptionsRequest request)
AWSIotAsyncSets the logging options.
setLoggingOptionsAsync in interface AWSIotAsyncrequest - The input for the SetLoggingOptions operation.public Future<Void> setLoggingOptionsAsync(SetLoggingOptionsRequest request, AsyncHandler<SetLoggingOptionsRequest,Void> asyncHandler)
AWSIotAsyncSets the logging options.
setLoggingOptionsAsync in interface AWSIotAsyncrequest - The input for the SetLoggingOptions 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.public Future<TransferCertificateResult> transferCertificateAsync(TransferCertificateRequest request)
AWSIotAsyncTransfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account, it is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API.
The certificate must not have any policies attached to it. These can be detached using the DetachPrincipalPolicy API.
transferCertificateAsync in interface AWSIotAsyncrequest - The input for the TransferCertificate operation.public Future<TransferCertificateResult> transferCertificateAsync(TransferCertificateRequest request, AsyncHandler<TransferCertificateRequest,TransferCertificateResult> asyncHandler)
AWSIotAsyncTransfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account, it is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API.
The certificate must not have any policies attached to it. These can be detached using the DetachPrincipalPolicy API.
transferCertificateAsync in interface AWSIotAsyncrequest - The input for the TransferCertificate 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.public Future<Void> updateCertificateAsync(UpdateCertificateRequest request)
AWSIotAsyncUpdates the status of the specified certificate. This operation is idempotent.
Moving a cert from the ACTIVE state (including REVOKED) will NOT disconnect currently-connected devices, although these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
updateCertificateAsync in interface AWSIotAsyncrequest - The input for the UpdateCertificate operation.public Future<Void> updateCertificateAsync(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,Void> asyncHandler)
AWSIotAsyncUpdates the status of the specified certificate. This operation is idempotent.
Moving a cert from the ACTIVE state (including REVOKED) will NOT disconnect currently-connected devices, although these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
updateCertificateAsync in interface AWSIotAsyncrequest - The input for the UpdateCertificate 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.public Future<UpdateThingResult> updateThingAsync(UpdateThingRequest request)
AWSIotAsyncUpdates the data for a thing.
updateThingAsync in interface AWSIotAsyncrequest - The input for the UpdateThing operation.public Future<UpdateThingResult> updateThingAsync(UpdateThingRequest request, AsyncHandler<UpdateThingRequest,UpdateThingResult> asyncHandler)
AWSIotAsyncUpdates the data for a thing.
updateThingAsync in interface AWSIotAsyncrequest - The input for the UpdateThing 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.public void shutdown()
getExecutorService().shutdown() followed by
getExecutorService().awaitTermination() prior to calling this
method.shutdown in interface AWSIotshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.