AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface IoTAsyncClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<AcceptCertificateTransferResponse> |
acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) |
Accepts a pending certificate transfer.
|
default CompletableFuture<AttachPrincipalPolicyResponse> |
attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) |
Attaches the specified policy to the specified principal (certificate or other credential).
|
default CompletableFuture<AttachThingPrincipalResponse> |
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) |
Attaches the specified principal to the specified thing.
|
static IoTAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
IoTAsyncClient . |
default CompletableFuture<CancelCertificateTransferResponse> |
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) |
Cancels a pending transfer for the specified certificate.
|
static IoTAsyncClient |
create() |
Create a
IoTAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateCertificateFromCsrResponse> |
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) |
Creates an X.509 certificate using the specified certificate signing request.
|
default CompletableFuture<CreateKeysAndCertificateResponse> |
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) |
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
|
default CompletableFuture<CreatePolicyResponse> |
createPolicy(CreatePolicyRequest createPolicyRequest) |
Creates an AWS IoT policy.
|
default CompletableFuture<CreatePolicyVersionResponse> |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) |
Creates a new version of the specified AWS IoT policy.
|
default CompletableFuture<CreateThingResponse> |
createThing(CreateThingRequest createThingRequest) |
Creates a thing record in the thing registry.
|
default CompletableFuture<CreateThingTypeResponse> |
createThingType(CreateThingTypeRequest createThingTypeRequest) |
Creates a new thing type.
|
default CompletableFuture<CreateTopicRuleResponse> |
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) |
Creates a rule.
|
default CompletableFuture<DeleteCACertificateResponse> |
deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) |
Deletes a registered CA certificate.
|
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) |
Deletes the specified certificate.
|
default CompletableFuture<DeletePolicyResponse> |
deletePolicy(DeletePolicyRequest deletePolicyRequest) |
Deletes the specified policy.
|
default CompletableFuture<DeletePolicyVersionResponse> |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) |
Deletes the specified version of the specified policy.
|
default CompletableFuture<DeleteRegistrationCodeResponse> |
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) |
Deletes a CA certificate registration code.
|
default CompletableFuture<DeleteThingResponse> |
deleteThing(DeleteThingRequest deleteThingRequest) |
Deletes the specified thing.
|
default CompletableFuture<DeleteThingTypeResponse> |
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) |
Deletes the specified thing type .
|
default CompletableFuture<DeleteTopicRuleResponse> |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) |
Deletes the specified rule.
|
default CompletableFuture<DeprecateThingTypeResponse> |
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) |
Deprecates a thing type.
|
default CompletableFuture<DescribeCACertificateResponse> |
describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) |
Describes a registered CA certificate.
|
default CompletableFuture<DescribeCertificateResponse> |
describeCertificate(DescribeCertificateRequest describeCertificateRequest) |
Gets information about the specified certificate.
|
default CompletableFuture<DescribeEndpointResponse> |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest) |
Returns a unique endpoint specific to the AWS account making the call.
|
default CompletableFuture<DescribeThingResponse> |
describeThing(DescribeThingRequest describeThingRequest) |
Gets information about the specified thing.
|
default CompletableFuture<DescribeThingTypeResponse> |
describeThingType(DescribeThingTypeRequest describeThingTypeRequest) |
Gets information about the specified thing type.
|
default CompletableFuture<DetachPrincipalPolicyResponse> |
detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) |
Removes the specified policy from the specified certificate.
|
default CompletableFuture<DetachThingPrincipalResponse> |
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) |
Detaches the specified principal from the specified thing.
|
default CompletableFuture<DisableTopicRuleResponse> |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) |
Disables the specified rule.
|
default CompletableFuture<EnableTopicRuleResponse> |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) |
Enables the specified rule.
|
default CompletableFuture<GetLoggingOptionsResponse> |
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) |
Gets the logging options.
|
default CompletableFuture<GetPolicyResponse> |
getPolicy(GetPolicyRequest getPolicyRequest) |
Gets information about the specified policy with the policy document of the default version.
|
default CompletableFuture<GetPolicyVersionResponse> |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) |
Gets information about the specified policy version.
|
default CompletableFuture<GetRegistrationCodeResponse> |
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) |
Gets a registration code used to register a CA certificate with AWS IoT.
|
default CompletableFuture<GetTopicRuleResponse> |
getTopicRule(GetTopicRuleRequest getTopicRuleRequest) |
Gets information about the specified rule.
|
default CompletableFuture<ListCACertificatesResponse> |
listCACertificates(ListCACertificatesRequest listCACertificatesRequest) |
Lists the CA certificates registered for your AWS account.
|
default CompletableFuture<ListCertificatesResponse> |
listCertificates(ListCertificatesRequest listCertificatesRequest) |
Lists the certificates registered in your AWS account.
|
default CompletableFuture<ListCertificatesByCAResponse> |
listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) |
List the device certificates signed by the specified CA certificate.
|
default CompletableFuture<ListOutgoingCertificatesResponse> |
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) |
Lists certificates that are being transfered but not yet accepted.
|
default CompletableFuture<ListPoliciesResponse> |
listPolicies(ListPoliciesRequest listPoliciesRequest) |
Lists your policies.
|
default CompletableFuture<ListPolicyPrincipalsResponse> |
listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) |
Lists the principals associated with the specified policy.
|
default CompletableFuture<ListPolicyVersionsResponse> |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) |
Lists the versions of the specified policy and identifies the default version.
|
default CompletableFuture<ListPrincipalPoliciesResponse> |
listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) |
Lists the policies attached to the specified principal.
|
default CompletableFuture<ListPrincipalThingsResponse> |
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) |
Lists the things associated with the specified principal.
|
default CompletableFuture<ListThingPrincipalsResponse> |
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) |
Lists the principals associated with the specified thing.
|
default CompletableFuture<ListThingsResponse> |
listThings(ListThingsRequest listThingsRequest) |
Lists your things.
|
default CompletableFuture<ListThingTypesResponse> |
listThingTypes(ListThingTypesRequest listThingTypesRequest) |
Lists the existing thing types.
|
default CompletableFuture<ListTopicRulesResponse> |
listTopicRules(ListTopicRulesRequest listTopicRulesRequest) |
Lists the rules for the specific topic.
|
default CompletableFuture<RegisterCACertificateResponse> |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) |
Registers a CA certificate with AWS IoT.
|
default CompletableFuture<RegisterCertificateResponse> |
registerCertificate(RegisterCertificateRequest registerCertificateRequest) |
Registers a device certificate with AWS IoT.
|
default CompletableFuture<RejectCertificateTransferResponse> |
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) |
Rejects a pending certificate transfer.
|
default CompletableFuture<ReplaceTopicRuleResponse> |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) |
Replaces the specified rule.
|
default CompletableFuture<SetDefaultPolicyVersionResponse> |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) |
Sets the specified version of the specified policy as the policy's default (operative) version.
|
default CompletableFuture<SetLoggingOptionsResponse> |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) |
Sets the logging options.
|
default CompletableFuture<TransferCertificateResponse> |
transferCertificate(TransferCertificateRequest transferCertificateRequest) |
Transfers the specified certificate to the specified AWS account.
|
default CompletableFuture<UpdateCACertificateResponse> |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) |
Updates a registered CA certificate.
|
default CompletableFuture<UpdateCertificateResponse> |
updateCertificate(UpdateCertificateRequest updateCertificateRequest) |
Updates the status of the specified certificate.
|
default CompletableFuture<UpdateThingResponse> |
updateThing(UpdateThingRequest updateThingRequest) |
Updates the data for a thing.
|
close
static IoTAsyncClient create()
IoTAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static IoTAsyncClientBuilder builder()
IoTAsyncClient
.default CompletableFuture<AcceptCertificateTransferResponse> acceptCertificateTransfer(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.default CompletableFuture<AttachPrincipalPolicyResponse> attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.default CompletableFuture<AttachThingPrincipalResponse> attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.default CompletableFuture<CancelCertificateTransferResponse> cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferRequest
- The input for the CancelCertificateTransfer operation.default CompletableFuture<CreateCertificateFromCsrResponse> createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.default CompletableFuture<CreateKeysAndCertificateResponse> createKeysAndCertificate(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, so it is important to keep it in a secure location.
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.default CompletableFuture<CreatePolicyResponse> createPolicy(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.default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
createPolicyVersionRequest
- The input for the CreatePolicyVersion operation.default CompletableFuture<CreateThingResponse> createThing(CreateThingRequest createThingRequest)
Creates a thing record in the thing registry.
createThingRequest
- The input for the CreateThing operation.default CompletableFuture<CreateThingTypeResponse> createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
createThingTypeRequest
- The input for the CreateThingType operation.default CompletableFuture<CreateTopicRuleResponse> createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
createTopicRuleRequest
- The input for the CreateTopicRule operation.default CompletableFuture<DeleteCACertificateResponse> deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.default CompletableFuture<DeleteCertificateResponse> deleteCertificate(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 use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest
- The input for the DeleteCertificate operation.default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest
- The input for the DeletePolicy operation.default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(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.default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.default CompletableFuture<DeleteThingResponse> deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing.
deleteThingRequest
- The input for the DeleteThing operation.default CompletableFuture<DeleteThingTypeResponse> deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
deleteThingTypeRequest
- The input for the DeleteThingType operation.default CompletableFuture<DeleteTopicRuleResponse> deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the specified rule.
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.default CompletableFuture<DeprecateThingTypeResponse> deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.default CompletableFuture<DescribeCACertificateResponse> describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
describeCACertificateRequest
- The input for the DescribeCACertificate operation.default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
describeCertificateRequest
- The input for the DescribeCertificate operation.default CompletableFuture<DescribeEndpointResponse> describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest
- The input for the DescribeEndpoint operation.default CompletableFuture<DescribeThingResponse> describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
describeThingRequest
- The input for the DescribeThing operation.default CompletableFuture<DescribeThingTypeResponse> describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
describeThingTypeRequest
- The input for the DescribeThingType operation.default CompletableFuture<DetachPrincipalPolicyResponse> detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Removes the specified policy from the specified certificate.
detachPrincipalPolicyRequest
- The input for the DetachPrincipalPolicy operation.default CompletableFuture<DetachThingPrincipalResponse> detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.
detachThingPrincipalRequest
- The input for the DetachThingPrincipal operation.default CompletableFuture<DisableTopicRuleResponse> disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the specified rule.
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.default CompletableFuture<EnableTopicRuleResponse> enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the specified rule.
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.default CompletableFuture<GetLoggingOptionsResponse> getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
getLoggingOptionsRequest
- The input for the GetLoggingOptions operation.default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest
- The input for the GetPolicy operation.default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.default CompletableFuture<GetRegistrationCodeResponse> getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.default CompletableFuture<GetTopicRuleResponse> getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the specified rule.
getTopicRuleRequest
- The input for the GetTopicRule operation.default CompletableFuture<ListCACertificatesResponse> listCACertificates(ListCACertificatesRequest listCACertificatesRequest)
Lists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCACertificatesRequest
- Input for the ListCACertificates operation.default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCertificatesRequest
- The input for the ListCertificates operation.default CompletableFuture<ListCertificatesByCAResponse> listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest)
List the device certificates signed by the specified CA certificate.
listCertificatesByCARequest
- The input to the ListCertificatesByCA operation.default CompletableFuture<ListOutgoingCertificatesResponse> listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transfered but not yet accepted.
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
listPoliciesRequest
- The input for the ListPolicies operation.default CompletableFuture<ListPolicyPrincipalsResponse> listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest)
Lists the principals associated with the specified policy.
listPolicyPrincipalsRequest
- The input for the ListPolicyPrincipals operation.default CompletableFuture<ListPolicyVersionsResponse> listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default version.
listPolicyVersionsRequest
- The input for the ListPolicyVersions operation.default CompletableFuture<ListPrincipalPoliciesResponse> listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
listPrincipalPoliciesRequest
- The input for the ListPrincipalPolicies operation.default CompletableFuture<ListPrincipalThingsResponse> listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.default CompletableFuture<ListThingPrincipalsResponse> listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.default CompletableFuture<ListThingTypesResponse> listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.
listThingTypesRequest
- The input for the ListThingTypes operation.default CompletableFuture<ListThingsResponse> listThings(ListThingsRequest listThingsRequest)
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For
example, calling ListThings
with attributeName=Color and attributeValue=Red retrieves all things in
the registry that contain an attribute Color with the value Red.
listThingsRequest
- The input for the ListThings operation.default CompletableFuture<ListTopicRulesResponse> listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
listTopicRulesRequest
- The input for the ListTopicRules operation.default CompletableFuture<RegisterCACertificateResponse> registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
registerCACertificateRequest
- The input to the RegisterCACertificate operation.default CompletableFuture<RegisterCertificateResponse> registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
registerCertificateRequest
- The input to the RegisterCertificate operation.default CompletableFuture<RejectCertificateTransferResponse> rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
rejectCertificateTransferRequest
- The input for the RejectCertificateTransfer operation.default CompletableFuture<ReplaceTopicRuleResponse> replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
replaceTopicRuleRequest
- The input for the ReplaceTopicRule operation.default CompletableFuture<SetDefaultPolicyVersionResponse> setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
setDefaultPolicyVersionRequest
- The input for the SetDefaultPolicyVersion operation.default CompletableFuture<SetLoggingOptionsResponse> setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
setLoggingOptionsRequest
- The input for the SetLoggingOptions operation.default CompletableFuture<TransferCertificateResponse> transferCertificate(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. You can use the UpdateCertificate API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
transferCertificateRequest
- The input for the TransferCertificate operation.default CompletableFuture<UpdateCACertificateResponse> updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
updateCACertificateRequest
- The input to the UpdateCACertificate operation.default CompletableFuture<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but 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.default CompletableFuture<UpdateThingResponse> updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
updateThingRequest
- The input for the UpdateThing operation.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.