public interface AWSIotAsync extends AWSIot
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.
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, setEndpoint, setLoggingOptions, setRegion, shutdown, transferCertificate, updateCertificate, updateThingFuture<Void> 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<Void> acceptCertificateTransferAsync(AcceptCertificateTransferRequest acceptCertificateTransferRequest, AsyncHandler<AcceptCertificateTransferRequest,Void> 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<Void> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyRequest - The input for the AttachPrincipalPolicy operation.Future<Void> attachPrincipalPolicyAsync(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest, AsyncHandler<AttachPrincipalPolicyRequest,Void> asyncHandler)
Attaches the specified policy to the specified principal (certificate or other credential).
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<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.
attachThingPrincipalRequest - The input for the AttachThingPrincipal operation.Future<AttachThingPrincipalResult> attachThingPrincipalAsync(AttachThingPrincipalRequest attachThingPrincipalRequest, AsyncHandler<AttachThingPrincipalRequest,AttachThingPrincipalResult> asyncHandler)
Attaches the specified principal to the specified thing.
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<Void> 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. 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.
cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.Future<Void> cancelCertificateTransferAsync(CancelCertificateTransferRequest cancelCertificateTransferRequest, AsyncHandler<CancelCertificateTransferRequest,Void> 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. 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.
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<CreateCertificateFromCsrResult> createCertificateFromCsrAsync(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates 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"
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 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"
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<CreateKeysAndCertificateResult> createKeysAndCertificateAsync(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates 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.
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.
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.
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<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 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.
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 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.
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<CreateThingResult> createThingAsync(CreateThingRequest createThingRequest)
Creates a thing in the thing registry.
createThingRequest - The input for the CreateThing operation.Future<CreateThingResult> createThingAsync(CreateThingRequest createThingRequest, AsyncHandler<CreateThingRequest,CreateThingResult> asyncHandler)
Creates a thing in the thing registry.
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<Void> createTopicRuleAsync(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule.
createTopicRuleRequest - The input for the CreateTopicRule operation.Future<Void> createTopicRuleAsync(CreateTopicRuleRequest createTopicRuleRequest, AsyncHandler<CreateTopicRuleRequest,Void> asyncHandler)
Creates a 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<Void> deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest)
Deletes 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.
deleteCertificateRequest - The input for the DeleteCertificate operation.Future<Void> deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest, AsyncHandler<DeleteCertificateRequest,Void> asyncHandler)
Deletes 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.
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<Void> deletePolicyAsync(DeletePolicyRequest deletePolicyRequest)
Deletes 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.
deletePolicyRequest - The input for the DeletePolicy operation.Future<Void> deletePolicyAsync(DeletePolicyRequest deletePolicyRequest, AsyncHandler<DeletePolicyRequest,Void> asyncHandler)
Deletes 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.
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<Void> 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<Void> deletePolicyVersionAsync(DeletePolicyVersionRequest deletePolicyVersionRequest, AsyncHandler<DeletePolicyVersionRequest,Void> 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<DeleteThingResult> deleteThingAsync(DeleteThingRequest deleteThingRequest)
Deletes the specified thing from the Thing Registry.
deleteThingRequest - The input for the DeleteThing operation.Future<DeleteThingResult> deleteThingAsync(DeleteThingRequest deleteThingRequest, AsyncHandler<DeleteThingRequest,DeleteThingResult> asyncHandler)
Deletes the specified thing from the Thing Registry.
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<Void> deleteTopicRuleAsync(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the specified rule.
deleteTopicRuleRequest - The input for the DeleteTopicRule operation.Future<Void> deleteTopicRuleAsync(DeleteTopicRuleRequest deleteTopicRuleRequest, AsyncHandler<DeleteTopicRuleRequest,Void> asyncHandler)
Deletes the specified 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<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<DescribeEndpointResult> describeEndpointAsync(DescribeEndpointRequest describeEndpointRequest)
Returns 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.
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. You specify the following URI when updating state information for your thing: https://endpoint/things/thingName/shadow.
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<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<Void> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Removes the specified policy from the specified certificate.
detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.Future<Void> detachPrincipalPolicyAsync(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest, AsyncHandler<DetachPrincipalPolicyRequest,Void> asyncHandler)
Removes the specified policy from the specified certificate.
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<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.
detachThingPrincipalRequest - The input for the DetachThingPrincipal operation.Future<DetachThingPrincipalResult> detachThingPrincipalAsync(DetachThingPrincipalRequest detachThingPrincipalRequest, AsyncHandler<DetachThingPrincipalRequest,DetachThingPrincipalResult> asyncHandler)
Detaches the specified principal from the specified thing.
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<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
getLoggingOptionsRequest - The input for the GetLoggingOptions operation.Future<GetLoggingOptionsResult> getLoggingOptionsAsync(GetLoggingOptionsRequest getLoggingOptionsRequest, AsyncHandler<GetLoggingOptionsRequest,GetLoggingOptionsResult> asyncHandler)
Gets the logging options.
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<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<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the specified rule.
getTopicRuleRequest - The input for the GetTopicRule operation.Future<GetTopicRuleResult> getTopicRuleAsync(GetTopicRuleRequest getTopicRuleRequest, AsyncHandler<GetTopicRuleRequest,GetTopicRuleResult> asyncHandler)
Gets information about the specified 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<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest listCertificatesRequest)
Lists your certificates.
The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.
listCertificatesRequest - The input for the ListCertificates operation.Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest listCertificatesRequest, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
Lists your certificates.
The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.
listCertificatesRequest - 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.Future<ListPoliciesResult> listPoliciesAsync(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
listPoliciesRequest - The input for the ListPolicies operation.Future<ListPoliciesResult> listPoliciesAsync(ListPoliciesRequest listPoliciesRequest, AsyncHandler<ListPoliciesRequest,ListPoliciesResult> asyncHandler)
Lists your policies.
listPoliciesRequest - 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.Future<ListPolicyVersionsResult> listPolicyVersionsAsync(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy, and identifies the default version.
listPolicyVersionsRequest - The input for the ListPolicyVersions operation.Future<ListPolicyVersionsResult> listPolicyVersionsAsync(ListPolicyVersionsRequest listPolicyVersionsRequest, AsyncHandler<ListPolicyVersionsRequest,ListPolicyVersionsResult> asyncHandler)
Lists the versions of the specified policy, and identifies the default version.
listPolicyVersionsRequest - 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.Future<ListPrincipalPoliciesResult> listPrincipalPoliciesAsync(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Lists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.
listPrincipalPoliciesRequest - The input for the ListPrincipalPolicies operation.Future<ListPrincipalPoliciesResult> listPrincipalPoliciesAsync(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest, AsyncHandler<ListPrincipalPoliciesRequest,ListPrincipalPoliciesResult> asyncHandler)
Lists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.
listPrincipalPoliciesRequest - 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.Future<ListPrincipalThingsResult> listPrincipalThingsAsync(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.
listPrincipalThingsRequest - The input for the ListPrincipalThings operation.Future<ListPrincipalThingsResult> listPrincipalThingsAsync(ListPrincipalThingsRequest listPrincipalThingsRequest, AsyncHandler<ListPrincipalThingsRequest,ListPrincipalThingsResult> asyncHandler)
Lists the things associated with the specified principal.
listPrincipalThingsRequest - 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.Future<ListThingPrincipalsResult> listThingPrincipalsAsync(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.
listThingPrincipalsRequest - The input for the ListThingPrincipal operation.Future<ListThingPrincipalsResult> listThingPrincipalsAsync(ListThingPrincipalsRequest listThingPrincipalsRequest, AsyncHandler<ListThingPrincipalsRequest,ListThingPrincipalsResult> asyncHandler)
Lists the principals associated with the specified thing.
listThingPrincipalsRequest - 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.Future<ListThingsResult> listThingsAsync(ListThingsRequest listThingsRequest)
Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"
listThingsRequest - The input for the ListThings operation.Future<ListThingsResult> listThingsAsync(ListThingsRequest listThingsRequest, AsyncHandler<ListThingsRequest,ListThingsResult> asyncHandler)
Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"
listThingsRequest - 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.Future<ListTopicRulesResult> listTopicRulesAsync(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
listTopicRulesRequest - The input for the ListTopicRules operation.Future<ListTopicRulesResult> listTopicRulesAsync(ListTopicRulesRequest listTopicRulesRequest, AsyncHandler<ListTopicRulesRequest,ListTopicRulesResult> asyncHandler)
Lists the rules for the specific topic.
listTopicRulesRequest - 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.Future<Void> rejectCertificateTransferAsync(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects 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.
rejectCertificateTransferRequest - The input for the RejectCertificateTransfer operation.Future<Void> rejectCertificateTransferAsync(RejectCertificateTransferRequest rejectCertificateTransferRequest, AsyncHandler<RejectCertificateTransferRequest,Void> asyncHandler)
Rejects 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.
rejectCertificateTransferRequest - 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.Future<Void> replaceTopicRuleAsync(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the specified rule. You must specify all parameters for the new rule.
replaceTopicRuleRequest - The input for the ReplaceTopicRule operation.Future<Void> replaceTopicRuleAsync(ReplaceTopicRuleRequest replaceTopicRuleRequest, AsyncHandler<ReplaceTopicRuleRequest,Void> asyncHandler)
Replaces the specified rule. You must specify all parameters for the new rule.
replaceTopicRuleRequest - 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.Future<Void> setDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets 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.
setDefaultPolicyVersionRequest - The input for the SetDefaultPolicyVersion operation.Future<Void> setDefaultPolicyVersionAsync(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest, AsyncHandler<SetDefaultPolicyVersionRequest,Void> asyncHandler)
Sets 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.
setDefaultPolicyVersionRequest - 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.Future<Void> setLoggingOptionsAsync(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
setLoggingOptionsRequest - The input for the SetLoggingOptions operation.Future<Void> setLoggingOptionsAsync(SetLoggingOptionsRequest setLoggingOptionsRequest, AsyncHandler<SetLoggingOptionsRequest,Void> asyncHandler)
Sets the logging options.
setLoggingOptionsRequest - 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.Future<TransferCertificateResult> transferCertificateAsync(TransferCertificateRequest transferCertificateRequest)
Transfers 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.
transferCertificateRequest - The input for the TransferCertificate operation.Future<TransferCertificateResult> transferCertificateAsync(TransferCertificateRequest transferCertificateRequest, AsyncHandler<TransferCertificateRequest,TransferCertificateResult> asyncHandler)
Transfers 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.
transferCertificateRequest - 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.Future<Void> updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest)
Updates 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.
updateCertificateRequest - The input for the UpdateCertificate operation.Future<Void> updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest, AsyncHandler<UpdateCertificateRequest,Void> asyncHandler)
Updates 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.
updateCertificateRequest - 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.Future<UpdateThingResult> updateThingAsync(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
updateThingRequest - The input for the UpdateThing operation.Future<UpdateThingResult> updateThingAsync(UpdateThingRequest updateThingRequest, AsyncHandler<UpdateThingRequest,UpdateThingResult> asyncHandler)
Updates the data for a thing.
updateThingRequest - 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.