AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface IoTClient 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 | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AcceptCertificateTransferResponse |
acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) |
Accepts a pending certificate transfer.
|
default AttachPrincipalPolicyResponse |
attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) |
Attaches the specified policy to the specified principal (certificate or other credential).
|
default AttachThingPrincipalResponse |
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) |
Attaches the specified principal to the specified thing.
|
static IoTClientBuilder |
builder() |
Create a builder that can be used to configure and create a
IoTClient. |
default CancelCertificateTransferResponse |
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) |
Cancels a pending transfer for the specified certificate.
|
static IoTClient |
create() |
Create a
IoTClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCertificateFromCsrResponse |
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) |
Creates an X.509 certificate using the specified certificate signing request.
|
default CreateKeysAndCertificateResponse |
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) |
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
|
default CreatePolicyResponse |
createPolicy(CreatePolicyRequest createPolicyRequest) |
Creates an AWS IoT policy.
|
default CreatePolicyVersionResponse |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) |
Creates a new version of the specified AWS IoT policy.
|
default CreateThingResponse |
createThing(CreateThingRequest createThingRequest) |
Creates a thing record in the thing registry.
|
default CreateThingTypeResponse |
createThingType(CreateThingTypeRequest createThingTypeRequest) |
Creates a new thing type.
|
default CreateTopicRuleResponse |
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) |
Creates a rule.
|
default DeleteCACertificateResponse |
deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) |
Deletes a registered CA certificate.
|
default DeleteCertificateResponse |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) |
Deletes the specified certificate.
|
default DeletePolicyResponse |
deletePolicy(DeletePolicyRequest deletePolicyRequest) |
Deletes the specified policy.
|
default DeletePolicyVersionResponse |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) |
Deletes the specified version of the specified policy.
|
default DeleteRegistrationCodeResponse |
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) |
Deletes a CA certificate registration code.
|
default DeleteThingResponse |
deleteThing(DeleteThingRequest deleteThingRequest) |
Deletes the specified thing.
|
default DeleteThingTypeResponse |
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) |
Deletes the specified thing type .
|
default DeleteTopicRuleResponse |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) |
Deletes the specified rule.
|
default DeprecateThingTypeResponse |
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) |
Deprecates a thing type.
|
default DescribeCACertificateResponse |
describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) |
Describes a registered CA certificate.
|
default DescribeCertificateResponse |
describeCertificate(DescribeCertificateRequest describeCertificateRequest) |
Gets information about the specified certificate.
|
default DescribeEndpointResponse |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest) |
Returns a unique endpoint specific to the AWS account making the call.
|
default DescribeThingResponse |
describeThing(DescribeThingRequest describeThingRequest) |
Gets information about the specified thing.
|
default DescribeThingTypeResponse |
describeThingType(DescribeThingTypeRequest describeThingTypeRequest) |
Gets information about the specified thing type.
|
default DetachPrincipalPolicyResponse |
detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) |
Removes the specified policy from the specified certificate.
|
default DetachThingPrincipalResponse |
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) |
Detaches the specified principal from the specified thing.
|
default DisableTopicRuleResponse |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) |
Disables the specified rule.
|
default EnableTopicRuleResponse |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) |
Enables the specified rule.
|
default GetLoggingOptionsResponse |
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) |
Gets the logging options.
|
default GetPolicyResponse |
getPolicy(GetPolicyRequest getPolicyRequest) |
Gets information about the specified policy with the policy document of the default version.
|
default GetPolicyVersionResponse |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) |
Gets information about the specified policy version.
|
default GetRegistrationCodeResponse |
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) |
Gets a registration code used to register a CA certificate with AWS IoT.
|
default GetTopicRuleResponse |
getTopicRule(GetTopicRuleRequest getTopicRuleRequest) |
Gets information about the specified rule.
|
default ListCACertificatesResponse |
listCACertificates(ListCACertificatesRequest listCACertificatesRequest) |
Lists the CA certificates registered for your AWS account.
|
default ListCertificatesResponse |
listCertificates(ListCertificatesRequest listCertificatesRequest) |
Lists the certificates registered in your AWS account.
|
default ListCertificatesByCAResponse |
listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) |
List the device certificates signed by the specified CA certificate.
|
default ListOutgoingCertificatesResponse |
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) |
Lists certificates that are being transfered but not yet accepted.
|
default ListPoliciesResponse |
listPolicies(ListPoliciesRequest listPoliciesRequest) |
Lists your policies.
|
default ListPolicyPrincipalsResponse |
listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) |
Lists the principals associated with the specified policy.
|
default ListPolicyVersionsResponse |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) |
Lists the versions of the specified policy and identifies the default version.
|
default ListPrincipalPoliciesResponse |
listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) |
Lists the policies attached to the specified principal.
|
default ListPrincipalThingsResponse |
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) |
Lists the things associated with the specified principal.
|
default ListThingPrincipalsResponse |
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) |
Lists the principals associated with the specified thing.
|
default ListThingsResponse |
listThings(ListThingsRequest listThingsRequest) |
Lists your things.
|
default ListThingTypesResponse |
listThingTypes(ListThingTypesRequest listThingTypesRequest) |
Lists the existing thing types.
|
default ListTopicRulesResponse |
listTopicRules(ListTopicRulesRequest listTopicRulesRequest) |
Lists the rules for the specific topic.
|
default RegisterCACertificateResponse |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) |
Registers a CA certificate with AWS IoT.
|
default RegisterCertificateResponse |
registerCertificate(RegisterCertificateRequest registerCertificateRequest) |
Registers a device certificate with AWS IoT.
|
default RejectCertificateTransferResponse |
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) |
Rejects a pending certificate transfer.
|
default ReplaceTopicRuleResponse |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) |
Replaces the specified rule.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetDefaultPolicyVersionResponse |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) |
Sets the specified version of the specified policy as the policy's default (operative) version.
|
default SetLoggingOptionsResponse |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) |
Sets the logging options.
|
default TransferCertificateResponse |
transferCertificate(TransferCertificateRequest transferCertificateRequest) |
Transfers the specified certificate to the specified AWS account.
|
default UpdateCACertificateResponse |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) |
Updates a registered CA certificate.
|
default UpdateCertificateResponse |
updateCertificate(UpdateCertificateRequest updateCertificateRequest) |
Updates the status of the specified certificate.
|
default UpdateThingResponse |
updateThing(UpdateThingRequest updateThingRequest) |
Updates the data for a thing.
|
closestatic final String SERVICE_NAME
static IoTClient create()
IoTClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IoTClientBuilder builder()
IoTClient.default AcceptCertificateTransferResponse acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.TransferAlreadyCompletedException - You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AttachPrincipalPolicyResponse attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, SdkBaseException, SdkClientException, IoTException
Attaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyRequest - The input for the AttachPrincipalPolicy operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.LimitExceededException - The number of attached entities exceeds the limit.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AttachThingPrincipalResponse attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Attaches the specified principal to the specified thing.
attachThingPrincipalRequest - The input for the AttachThingPrincipal operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CancelCertificateTransferResponse cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.TransferAlreadyCompletedException - You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateCertificateFromCsrResponse createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateKeysAndCertificateResponse createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePolicyResponse createPolicy(CreatePolicyRequest createPolicyRequest) throws ResourceAlreadyExistsException, MalformedPolicyException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceAlreadyExistsException - The resource already exists.MalformedPolicyException - The policy documentation is not valid.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePolicyVersionResponse createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws ResourceNotFoundException, MalformedPolicyException, VersionsLimitExceededException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.MalformedPolicyException - The policy documentation is not valid.VersionsLimitExceededException - The number of policy versions exceeds the limit.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateThingResponse createThing(CreateThingRequest createThingRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Creates a thing record in the thing registry.
createThingRequest - The input for the CreateThing operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceAlreadyExistsException - The resource already exists.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateThingTypeResponse createThingType(CreateThingTypeRequest createThingTypeRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, SdkBaseException, SdkClientException, IoTException
Creates a new thing type.
createThingTypeRequest - The input for the CreateThingType operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceAlreadyExistsException - The resource already exists.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateTopicRuleResponse createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ResourceAlreadyExistsException, ServiceUnavailableException, SdkBaseException, SdkClientException, IoTException
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.SqlParseException - The Rule-SQL expression can't be parsed correctly.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ResourceAlreadyExistsException - The resource already exists.ServiceUnavailableException - The service is temporarily unavailable.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCACertificateResponse deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) throws InvalidRequestException, CertificateStateException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Deletes a registered CA certificate.
deleteCACertificateRequest - Input for the DeleteCACertificate operation.InvalidRequestException - The request is not valid.CertificateStateException - The certificate operation is not allowed.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws CertificateStateException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
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.CertificateStateException - The certificate operation is not allowed.DeleteConflictException - You can't delete the resource because it is attached to one or more resources.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.DeleteConflictException - You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePolicyVersionResponse deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.DeleteConflictException - You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteRegistrationCodeResponse deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws ThrottlingException, ResourceNotFoundException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Deletes a CA certificate registration code.
deleteRegistrationCodeRequest - The input for the DeleteRegistrationCode operation.ThrottlingException - The rate exceeds the limit.ResourceNotFoundException - The specified resource does not exist.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteThingResponse deleteThing(DeleteThingRequest deleteThingRequest) throws ResourceNotFoundException, VersionConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Deletes the specified thing.
deleteThingRequest - The input for the DeleteThing operation.ResourceNotFoundException - The specified resource does not exist.VersionConflictException - An exception thrown when the version of a thing passed to a command is different than the version
specified with the --version parameter.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteThingTypeResponse deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteTopicRuleResponse deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, SdkBaseException, SdkClientException, IoTException
Deletes the specified rule.
deleteTopicRuleRequest - The input for the DeleteTopicRule operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.UnauthorizedException - You are not authorized to perform this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeprecateThingTypeResponse deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingTypeRequest - The input for the DeprecateThingType operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCACertificateResponse describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Describes a registered CA certificate.
describeCACertificateRequest - The input for the DescribeCACertificate operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified certificate.
describeCertificateRequest - The input for the DescribeCertificate operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws InternalFailureException, UnauthorizedException, ThrottlingException, SdkBaseException, SdkClientException, IoTException
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest - The input for the DescribeEndpoint operation.InternalFailureException - An unexpected error has occurred.UnauthorizedException - You are not authorized to perform this operation.ThrottlingException - The rate exceeds the limit.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeThingResponse describeThing(DescribeThingRequest describeThingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified thing.
describeThingRequest - The input for the DescribeThing operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeThingTypeResponse describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified thing type.
describeThingTypeRequest - The input for the DescribeThingType operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DetachPrincipalPolicyResponse detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Removes the specified policy from the specified certificate.
detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DetachThingPrincipalResponse detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Detaches the specified principal from the specified thing.
detachThingPrincipalRequest - The input for the DetachThingPrincipal operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisableTopicRuleResponse disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, SdkBaseException, SdkClientException, IoTException
Disables the specified rule.
disableTopicRuleRequest - The input for the DisableTopicRuleRequest operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.UnauthorizedException - You are not authorized to perform this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EnableTopicRuleResponse enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, SdkBaseException, SdkClientException, IoTException
Enables the specified rule.
enableTopicRuleRequest - The input for the EnableTopicRuleRequest operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.UnauthorizedException - You are not authorized to perform this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetLoggingOptionsResponse getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, SdkBaseException, SdkClientException, IoTException
Gets the logging options.
getLoggingOptionsRequest - The input for the GetLoggingOptions operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest - The input for the GetPolicy operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPolicyVersionResponse getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified policy version.
getPolicyVersionRequest - The input for the GetPolicyVersion operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetRegistrationCodeResponse getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, SdkBaseException, SdkClientException, IoTException
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest - The input to the GetRegistrationCode operation.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.InvalidRequestException - The request is not valid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetTopicRuleResponse getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, SdkBaseException, SdkClientException, IoTException
Gets information about the specified rule.
getTopicRuleRequest - The input for the GetTopicRule operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.UnauthorizedException - You are not authorized to perform this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCACertificatesResponse listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCertificatesByCAResponse listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
List the device certificates signed by the specified CA certificate.
listCertificatesByCARequest - The input to the ListCertificatesByCA operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListOutgoingCertificatesResponse listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Lists certificates that are being transfered but not yet accepted.
listOutgoingCertificatesRequest - The input to the ListOutgoingCertificates operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Lists your policies.
listPoliciesRequest - The input for the ListPolicies operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPolicyPrincipalsResponse listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Lists the principals associated with the specified policy.
listPolicyPrincipalsRequest - The input for the ListPolicyPrincipals operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPolicyVersionsResponse listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Lists the versions of the specified policy and identifies the default version.
listPolicyVersionsRequest - The input for the ListPolicyVersions operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPrincipalPoliciesResponse listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPrincipalThingsResponse listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Lists the things associated with the specified principal.
listPrincipalThingsRequest - The input for the ListPrincipalThings operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListThingPrincipalsResponse listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Lists the principals associated with the specified thing.
listThingPrincipalsRequest - The input for the ListThingPrincipal operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListThingTypesResponse listThingTypes(ListThingTypesRequest listThingTypesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Lists the existing thing types.
listThingTypesRequest - The input for the ListThingTypes operation.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListThingsResponse listThings(ListThingsRequest listThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTopicRulesResponse listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, SdkBaseException, SdkClientException, IoTException
Lists the rules for the specific topic.
listTopicRulesRequest - The input for the ListTopicRules operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterCACertificateResponse registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) throws ResourceAlreadyExistsException, RegistrationCodeValidationException, InvalidRequestException, CertificateValidationException, ThrottlingException, LimitExceededException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceAlreadyExistsException - The resource already exists.RegistrationCodeValidationException - The registration code is invalid.InvalidRequestException - The request is not valid.CertificateValidationException - The certificate is invalid.ThrottlingException - The rate exceeds the limit.LimitExceededException - The number of attached entities exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterCertificateResponse registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws ResourceAlreadyExistsException, InvalidRequestException, CertificateValidationException, CertificateStateException, CertificateConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceAlreadyExistsException - The resource already exists.InvalidRequestException - The request is not valid.CertificateValidationException - The certificate is invalid.CertificateStateException - The certificate operation is not allowed.CertificateConflictException - Unable to verify the CA certificate used to sign the device certificate you are attempting to register.
This is happens when you have registered more than one CA certificate that has the same subject field and
public key.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RejectCertificateTransferResponse rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.TransferAlreadyCompletedException - You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReplaceTopicRuleResponse replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, SdkBaseException, SdkClientException, IoTException
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.SqlParseException - The Rule-SQL expression can't be parsed correctly.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.UnauthorizedException - You are not authorized to perform this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetDefaultPolicyVersionResponse setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetLoggingOptionsResponse setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, SdkBaseException, SdkClientException, IoTException
Sets the logging options.
setLoggingOptionsRequest - The input for the SetLoggingOptions operation.InternalException - An unexpected error has occurred.InvalidRequestException - The request is not valid.ServiceUnavailableException - The service is temporarily unavailable.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TransferCertificateResponse transferCertificate(TransferCertificateRequest transferCertificateRequest) throws InvalidRequestException, ResourceNotFoundException, CertificateStateException, TransferConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.InvalidRequestException - The request is not valid.ResourceNotFoundException - The specified resource does not exist.CertificateStateException - The certificate operation is not allowed.TransferConflictException - You can't transfer the certificate because authorization policies are still attached.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateCACertificateResponse updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
Updates a registered CA certificate.
updateCACertificateRequest - The input to the UpdateCACertificate operation.ResourceNotFoundException - The specified resource does not exist.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateCertificateResponse updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws ResourceNotFoundException, CertificateStateException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, SdkBaseException, SdkClientException, IoTException
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.ResourceNotFoundException - The specified resource does not exist.CertificateStateException - The certificate operation is not allowed.InvalidRequestException - The request is not valid.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateThingResponse updateThing(UpdateThingRequest updateThingRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, SdkBaseException, SdkClientException, IoTException
Updates the data for a thing.
updateThingRequest - The input for the UpdateThing operation.InvalidRequestException - The request is not valid.VersionConflictException - An exception thrown when the version of a thing passed to a command is different than the version
specified with the --version parameter.ThrottlingException - The rate exceeds the limit.UnauthorizedException - You are not authorized to perform this operation.ServiceUnavailableException - The service is temporarily unavailable.InternalFailureException - An unexpected error has occurred.ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)IoTException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.