public class AWSIotClient extends AmazonWebServiceClient implements AWSIot
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 and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWS IoT exceptions.
|
client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AWSIotClient()
Deprecated.
|
AWSIotClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials.
|
AWSIotClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials and client configuration options.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider and client configuration
options.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider, client configuration options
and request metric collector.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
|
AWSIotClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)
Accepts a pending certificate transfer.
|
void |
attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Attaches the specified policy to the specified principal (certificate or
other credential).
|
AttachThingPrincipalResult |
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.
|
void |
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.
|
CreateCertificateFromCsrResult |
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing
request.
|
CreateKeysAndCertificateResult |
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the
issued public key.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an AWS IoT policy.
|
CreatePolicyVersionResult |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified AWS IoT policy.
|
CreateThingResult |
createThing(CreateThingRequest createThingRequest)
Creates a thing record in the thing registry.
|
CreateThingTypeResult |
createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
|
void |
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule.
|
DeleteCACertificateResult |
deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
|
void |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
|
void |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy.
|
DeleteRegistrationCodeResult |
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
|
DeleteThingResult |
deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing.
|
DeleteThingTypeResult |
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type .
|
void |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the specified rule.
|
DeprecateThingTypeResult |
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type.
|
DescribeCACertificateResult |
describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the AWS account making the call.
|
DescribeThingResult |
describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
|
DescribeThingTypeResult |
describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
|
void |
detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Removes the specified policy from the specified certificate.
|
DetachThingPrincipalResult |
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.
|
void |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the specified rule.
|
void |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the specified rule.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
GetLoggingOptionsResult |
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of
the default version.
|
GetPolicyVersionResult |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
|
GetRegistrationCodeResult |
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with AWS IoT.
|
GetTopicRuleResult |
getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the specified rule.
|
ListCACertificatesResult |
listCACertificates(ListCACertificatesRequest listCACertificatesRequest)
Lists the CA certificates registered for your AWS account.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your AWS account.
|
ListCertificatesByCAResult |
listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest)
List the device certificates signed by the specified CA certificate.
|
ListOutgoingCertificatesResult |
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transfered but not yet accepted.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
|
ListPolicyPrincipalsResult |
listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest)
Lists the principals associated with the specified policy.
|
ListPolicyVersionsResult |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default
version.
|
ListPrincipalPoliciesResult |
listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Lists the policies attached to the specified principal.
|
ListPrincipalThingsResult |
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.
|
ListThingPrincipalsResult |
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.
|
ListThingsResult |
listThings(ListThingsRequest listThingsRequest)
Lists your things.
|
ListThingTypesResult |
listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.
|
ListTopicRulesResult |
listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
|
RegisterCACertificateResult |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with AWS IoT.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with AWS IoT.
|
void |
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer.
|
void |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the specified rule.
|
void |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's
default (operative) version.
|
void |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
|
TransferCertificateResult |
transferCertificate(TransferCertificateRequest transferCertificateRequest)
Transfers the specified certificate to the specified AWS account.
|
void |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
|
void |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate.
|
UpdateThingResult |
updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
@Deprecated public AWSIotClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSIotClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).DefaultAWSCredentialsProviderChainpublic AWSIotClient(AWSCredentials awsCredentials)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AWSIotClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).requestMetricCollector - optional request metric collectorpublic AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).httpClient - A http clientpublic void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
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.
acceptCertificateTransfer in interface AWSIotacceptCertificateTransferRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicy in interface AWSIotattachPrincipalPolicyRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified principal to the specified thing.
attachThingPrincipal in interface AWSIotattachThingPrincipalRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
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.
cancelCertificateTransfer in interface AWSIotcancelCertificateTransferRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonServiceException, AmazonClientException
Creates an X.509 certificate using the specified certificate signing request.
Note Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, 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"
createCertificateFromCsr in interface AWSIotcreateCertificateFromCsrRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
createKeysAndCertificate in interface AWSIotcreateKeysAndCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonServiceException, AmazonClientException
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.
createPolicy in interface AWSIotcreatePolicyRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
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).
createPolicyVersion in interface AWSIotcreatePolicyVersionRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonServiceException, AmazonClientException
Creates a thing record in the thing registry.
createThing in interface AWSIotcreateThingRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest) throws AmazonServiceException, AmazonClientException
Creates a new thing type.
createThingType in interface AWSIotcreateThingTypeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonServiceException, AmazonClientException
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.
createTopicRule in interface AWSIotcreateTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) throws AmazonServiceException, AmazonClientException
Deletes a registered CA certificate.
deleteCACertificate in interface AWSIotdeleteCACertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
deleteCertificate in interface AWSIotdeleteCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonServiceException, AmazonClientException
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.
deletePolicy in interface AWSIotdeletePolicyRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonServiceException, AmazonClientException
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.
deletePolicyVersion in interface AWSIotdeletePolicyVersionRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws AmazonServiceException, AmazonClientException
Deletes a CA certificate registration code.
deleteRegistrationCode in interface AWSIotdeleteRegistrationCodeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified thing.
deleteThing in interface AWSIotdeleteThingRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws AmazonServiceException, AmazonClientException
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.
deleteThingType in interface AWSIotdeleteThingTypeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified rule.
deleteTopicRule in interface AWSIotdeleteTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws AmazonServiceException, AmazonClientException
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingType in interface AWSIotdeprecateThingTypeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) throws AmazonServiceException, AmazonClientException
Describes a registered CA certificate.
describeCACertificate in interface AWSIotdescribeCACertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified certificate.
describeCertificate in interface AWSIotdescribeCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonServiceException, AmazonClientException
Returns a unique endpoint specific to the AWS account making the call.
describeEndpoint in interface AWSIotdescribeEndpointRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified thing.
describeThing in interface AWSIotdescribeThingRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified thing type.
describeThingType in interface AWSIotdescribeThingTypeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Removes the specified policy from the specified certificate.
detachPrincipalPolicy in interface AWSIotdetachPrincipalPolicyRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Detaches the specified principal from the specified thing.
detachThingPrincipal in interface AWSIotdetachThingPrincipalRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Disables the specified rule.
disableTopicRule in interface AWSIotdisableTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Enables the specified rule.
enableTopicRule in interface AWSIotenableTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Gets the logging options.
getLoggingOptions in interface AWSIotgetLoggingOptionsRequest - The input for the GetLoggingOptions operation.
InternalException - An unexpected error has occurred.
InvalidRequestException - The request is not valid.
ServiceUnavailableException - The service is temporarily unavailable.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy with the policy document of the default version.
getPolicy in interface AWSIotgetPolicyRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy version.
getPolicyVersion in interface AWSIotgetPolicyVersionRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws AmazonServiceException, AmazonClientException
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCode in interface AWSIotgetRegistrationCodeRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified rule.
getTopicRule in interface AWSIotgetTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws AmazonServiceException, AmazonClientException
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.
listCACertificates in interface AWSIotlistCACertificatesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonServiceException, AmazonClientException
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.
listCertificates in interface AWSIotlistCertificatesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) throws AmazonServiceException, AmazonClientException
List the device certificates signed by the specified CA certificate.
listCertificatesByCA in interface AWSIotlistCertificatesByCARequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws AmazonServiceException, AmazonClientException
Lists certificates that are being transfered but not yet accepted.
listOutgoingCertificates in interface AWSIotlistOutgoingCertificatesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists your policies.
listPolicies in interface AWSIotlistPoliciesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws AmazonServiceException, AmazonClientException
Lists the principals associated with the specified policy.
listPolicyPrincipals in interface AWSIotlistPolicyPrincipalsRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonServiceException, AmazonClientException
Lists the versions of the specified policy and identifies the default version.
listPolicyVersions in interface AWSIotlistPolicyVersionsRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
listPrincipalPolicies in interface AWSIotlistPrincipalPoliciesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonServiceException, AmazonClientException
Lists the things associated with the specified principal.
listPrincipalThings in interface AWSIotlistPrincipalThingsRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonServiceException, AmazonClientException
Lists the principals associated with the specified thing.
listThingPrincipals in interface AWSIotlistThingPrincipalsRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest) throws AmazonServiceException, AmazonClientException
Lists the existing thing types.
listThingTypes in interface AWSIotlistThingTypesRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonServiceException, AmazonClientException
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.
listThings in interface AWSIotlistThingsRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonServiceException, AmazonClientException
Lists the rules for the specific topic.
listTopicRules in interface AWSIotlistTopicRulesRequest - The input for the ListTopicRules operation.
InternalException - An unexpected error has occurred.
InvalidRequestException - The request is not valid.
ServiceUnavailableException - The service is temporarily unavailable.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) throws AmazonServiceException, AmazonClientException
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 and public key. 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.
registerCACertificate in interface AWSIotregisterCACertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
registerCertificate in interface AWSIotregisterCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
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.
rejectCertificateTransfer in interface AWSIotrejectCertificateTransferRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonServiceException, AmazonClientException
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.
replaceTopicRule in interface AWSIotreplaceTopicRuleRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
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.
setDefaultPolicyVersion in interface AWSIotsetDefaultPolicyVersionRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Sets the logging options.
setLoggingOptions in interface AWSIotsetLoggingOptionsRequest - The input for the SetLoggingOptions operation.
InternalException - An unexpected error has occurred.
InvalidRequestException - The request is not valid.
ServiceUnavailableException - The service is temporarily unavailable.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
transferCertificate in interface AWSIottransferCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws AmazonServiceException, AmazonClientException
Updates a registered CA certificate.
updateCACertificate in interface AWSIotupdateCACertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
updateCertificate in interface AWSIotupdateCertificateRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.public UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonServiceException, AmazonClientException
Updates the data for a thing.
updateThing in interface AWSIotupdateThingRequest - 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.
AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSIotrequest - The originally executed requestCopyright © 2017. All rights reserved.