com.amazonaws.services.iot

Class AWSIotClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iot.AWSIotClient

All Implemented Interfaces:

AWSIot

Direct Known Subclasses:

AWSIotAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIotClient
extends AmazonWebServiceClient
implements AWSIot

Client for accessing AWS IoT. All service calls made using this client are blocking, and will not return until the service call completes.

AWS IoT

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.iot.AWSIot

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSIotClient() Deprecated. use AWSIotClientBuilder.defaultClient()
AWSIotClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSIotClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSIotClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSIotClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AcceptCertificateTransferResult	acceptCertificateTransfer(AcceptCertificateTransferRequest request) Accepts a pending certificate transfer.
AttachPrincipalPolicyResult	attachPrincipalPolicy(AttachPrincipalPolicyRequest request) Attaches the specified policy to the specified principal (certificate or other credential).
AttachThingPrincipalResult	attachThingPrincipal(AttachThingPrincipalRequest request) Attaches the specified principal to the specified thing.
static AWSIotClientBuilder	builder()
CancelCertificateTransferResult	cancelCertificateTransfer(CancelCertificateTransferRequest request) Cancels a pending transfer for the specified certificate.
CreateCertificateFromCsrResult	createCertificateFromCsr(CreateCertificateFromCsrRequest request) Creates an X.509 certificate using the specified certificate signing request.
CreateKeysAndCertificateResult	createKeysAndCertificate(CreateKeysAndCertificateRequest request) Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
CreatePolicyResult	createPolicy(CreatePolicyRequest request) Creates an AWS IoT policy.
CreatePolicyVersionResult	createPolicyVersion(CreatePolicyVersionRequest request) Creates a new version of the specified AWS IoT policy.
CreateThingResult	createThing(CreateThingRequest request) Creates a thing record in the thing registry.
CreateThingTypeResult	createThingType(CreateThingTypeRequest request) Creates a new thing type.
CreateTopicRuleResult	createTopicRule(CreateTopicRuleRequest request) Creates a rule.
DeleteCACertificateResult	deleteCACertificate(DeleteCACertificateRequest request) Deletes a registered CA certificate.
DeleteCertificateResult	deleteCertificate(DeleteCertificateRequest request) Deletes the specified certificate.
DeletePolicyResult	deletePolicy(DeletePolicyRequest request) Deletes the specified policy.
DeletePolicyVersionResult	deletePolicyVersion(DeletePolicyVersionRequest request) Deletes the specified version of the specified policy.
DeleteRegistrationCodeResult	deleteRegistrationCode(DeleteRegistrationCodeRequest request) Deletes a CA certificate registration code.
DeleteThingResult	deleteThing(DeleteThingRequest request) Deletes the specified thing.
DeleteThingTypeResult	deleteThingType(DeleteThingTypeRequest request) Deletes the specified thing type .
DeleteTopicRuleResult	deleteTopicRule(DeleteTopicRuleRequest request) Deletes the specified rule.
DeprecateThingTypeResult	deprecateThingType(DeprecateThingTypeRequest request) Deprecates a thing type.
DescribeCACertificateResult	describeCACertificate(DescribeCACertificateRequest request) Describes a registered CA certificate.
DescribeCertificateResult	describeCertificate(DescribeCertificateRequest request) Gets information about the specified certificate.
DescribeEndpointResult	describeEndpoint(DescribeEndpointRequest request) Returns a unique endpoint specific to the AWS account making the call.
DescribeThingResult	describeThing(DescribeThingRequest request) Gets information about the specified thing.
DescribeThingTypeResult	describeThingType(DescribeThingTypeRequest request) Gets information about the specified thing type.
DetachPrincipalPolicyResult	detachPrincipalPolicy(DetachPrincipalPolicyRequest request) Removes the specified policy from the specified certificate.
DetachThingPrincipalResult	detachThingPrincipal(DetachThingPrincipalRequest request) Detaches the specified principal from the specified thing.
DisableTopicRuleResult	disableTopicRule(DisableTopicRuleRequest request) Disables the specified rule.
EnableTopicRuleResult	enableTopicRule(EnableTopicRuleRequest request) Enables the specified rule.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetLoggingOptionsResult	getLoggingOptions(GetLoggingOptionsRequest request) Gets the logging options.
GetPolicyResult	getPolicy(GetPolicyRequest request) Gets information about the specified policy with the policy document of the default version.
GetPolicyVersionResult	getPolicyVersion(GetPolicyVersionRequest request) Gets information about the specified policy version.
GetRegistrationCodeResult	getRegistrationCode(GetRegistrationCodeRequest request) Gets a registration code used to register a CA certificate with AWS IoT.
GetTopicRuleResult	getTopicRule(GetTopicRuleRequest request) Gets information about the specified rule.
ListCACertificatesResult	listCACertificates(ListCACertificatesRequest request) Lists the CA certificates registered for your AWS account.
ListCertificatesResult	listCertificates(ListCertificatesRequest request) Lists the certificates registered in your AWS account.
ListCertificatesByCAResult	listCertificatesByCA(ListCertificatesByCARequest request) List the device certificates signed by the specified CA certificate.
ListOutgoingCertificatesResult	listOutgoingCertificates(ListOutgoingCertificatesRequest request) Lists certificates that are being transfered but not yet accepted.
ListPoliciesResult	listPolicies(ListPoliciesRequest request) Lists your policies.
ListPolicyPrincipalsResult	listPolicyPrincipals(ListPolicyPrincipalsRequest request) Lists the principals associated with the specified policy.
ListPolicyVersionsResult	listPolicyVersions(ListPolicyVersionsRequest request) Lists the versions of the specified policy and identifies the default version.
ListPrincipalPoliciesResult	listPrincipalPolicies(ListPrincipalPoliciesRequest request) Lists the policies attached to the specified principal.
ListPrincipalThingsResult	listPrincipalThings(ListPrincipalThingsRequest request) Lists the things associated with the specified principal.
ListThingPrincipalsResult	listThingPrincipals(ListThingPrincipalsRequest request) Lists the principals associated with the specified thing.
ListThingsResult	listThings(ListThingsRequest request) Lists your things.
ListThingTypesResult	listThingTypes(ListThingTypesRequest request) Lists the existing thing types.
ListTopicRulesResult	listTopicRules(ListTopicRulesRequest request) Lists the rules for the specific topic.
RegisterCACertificateResult	registerCACertificate(RegisterCACertificateRequest request) Registers a CA certificate with AWS IoT.
RegisterCertificateResult	registerCertificate(RegisterCertificateRequest request) Registers a device certificate with AWS IoT.
RejectCertificateTransferResult	rejectCertificateTransfer(RejectCertificateTransferRequest request) Rejects a pending certificate transfer.
ReplaceTopicRuleResult	replaceTopicRule(ReplaceTopicRuleRequest request) Replaces the specified rule.
SetDefaultPolicyVersionResult	setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request) Sets the specified version of the specified policy as the policy's default (operative) version.
SetLoggingOptionsResult	setLoggingOptions(SetLoggingOptionsRequest request) Sets the logging options.
TransferCertificateResult	transferCertificate(TransferCertificateRequest request) Transfers the specified certificate to the specified AWS account.
UpdateCACertificateResult	updateCACertificate(UpdateCACertificateRequest request) Updates a registered CA certificate.
UpdateCertificateResult	updateCertificate(UpdateCertificateRequest request) Updates the status of the specified certificate.
UpdateThingResult	updateThing(UpdateThingRequest request) Updates the data for a thing.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.iot.AWSIot

setEndpoint, setRegion, shutdown

Constructor Detail

AWSIotClient

@Deprecated
public AWSIotClient()

Deprecated. use AWSIotClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWS IoT. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSIotClient

@Deprecated
public AWSIotClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS IoT. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS IoT (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSIotClient

@Deprecated
public AWSIotClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSIotClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS IoT using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSIotClient

@Deprecated
public AWSIotClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS IoT using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AWS IoT (ex: proxy settings, retry counts, etc.).

AWSIotClient

@Deprecated
public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS IoT using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSIotClient

@Deprecated
public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS IoT using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AWS IoT (ex: proxy settings, retry counts, etc.).

AWSIotClient

@Deprecated
public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWS IoT using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AWS IoT (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSIotClientBuilder builder()

acceptCertificateTransfer

public AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest request)

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.

Specified by:

acceptCertificateTransfer in interface AWSIot

Parameters:

acceptCertificateTransferRequest - The input for the AcceptCertificateTransfer operation.

Returns:

Result of the AcceptCertificateTransfer operation returned by the service.

Throws:

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.

attachPrincipalPolicy

public AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest request)

Attaches the specified policy to the specified principal (certificate or other credential).

Specified by:

attachPrincipalPolicy in interface AWSIot

Parameters:

attachPrincipalPolicyRequest - The input for the AttachPrincipalPolicy operation.

Returns:

Result of the AttachPrincipalPolicy operation returned by the service.

Throws:

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.

attachThingPrincipal

public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest request)

Attaches the specified principal to the specified thing.

Specified by:

attachThingPrincipal in interface AWSIot

Parameters:

attachThingPrincipalRequest - The input for the AttachThingPrincipal operation.

Returns:

Result of the AttachThingPrincipal operation returned by the service.

Throws:

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.

cancelCertificateTransfer

public CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest request)

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.

Specified by:

cancelCertificateTransfer in interface AWSIot

Parameters:

cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.

Returns:

Result of the CancelCertificateTransfer operation returned by the service.

Throws:

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.

createCertificateFromCsr

public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest request)

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"

Specified by:

createCertificateFromCsr in interface AWSIot

Parameters:

createCertificateFromCsrRequest - The input for the CreateCertificateFromCsr operation.

Returns:

Result of the CreateCertificateFromCsr operation returned by the service.

Throws:

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.

createKeysAndCertificate

public CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest request)

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.

Specified by:

createKeysAndCertificate in interface AWSIot

Parameters:

createKeysAndCertificateRequest - The input for the CreateKeysAndCertificate operation.

Returns:

Result of the CreateKeysAndCertificate operation returned by the service.

Throws:

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.

createPolicy

public CreatePolicyResult createPolicy(CreatePolicyRequest request)

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.

Specified by:

createPolicy in interface AWSIot

Parameters:

createPolicyRequest - The input for the CreatePolicy operation.

Returns:

Result of the CreatePolicy operation returned by the service.

Throws:

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.

createPolicyVersion

public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)

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).

Specified by:

createPolicyVersion in interface AWSIot

Parameters:

createPolicyVersionRequest - The input for the CreatePolicyVersion operation.

Returns:

Result of the CreatePolicyVersion operation returned by the service.

Throws:

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.

createThing

public CreateThingResult createThing(CreateThingRequest request)

Creates a thing record in the thing registry.

Specified by:

createThing in interface AWSIot

Parameters:

createThingRequest - The input for the CreateThing operation.

Returns:

Result of the CreateThing operation returned by the service.

Throws:

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.

createThingType

public CreateThingTypeResult createThingType(CreateThingTypeRequest request)

Creates a new thing type.

Specified by:

createThingType in interface AWSIot

Parameters:

createThingTypeRequest - The input for the CreateThingType operation.

Returns:

Result of the CreateThingType operation returned by the service.

Throws:

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.

createTopicRule

public CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest request)

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.

Specified by:

createTopicRule in interface AWSIot

Parameters:

createTopicRuleRequest - The input for the CreateTopicRule operation.

Returns:

Result of the CreateTopicRule operation returned by the service.

Throws:

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.

deleteCACertificate

public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest request)

Deletes a registered CA certificate.

Specified by:

deleteCACertificate in interface AWSIot

Parameters:

deleteCACertificateRequest - Input for the DeleteCACertificate operation.

Returns:

Result of the DeleteCACertificate operation returned by the service.

Throws:

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.

deleteCertificate

public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)

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.

Specified by:

deleteCertificate in interface AWSIot

Parameters:

deleteCertificateRequest - The input for the DeleteCertificate operation.

Returns:

Result of the DeleteCertificate operation returned by the service.

Throws:

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.

deletePolicy

public DeletePolicyResult deletePolicy(DeletePolicyRequest request)

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.

Specified by:

deletePolicy in interface AWSIot

Parameters:

deletePolicyRequest - The input for the DeletePolicy operation.

Returns:

Result of the DeletePolicy operation returned by the service.

Throws:

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.

deletePolicyVersion

public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)

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.

Specified by:

deletePolicyVersion in interface AWSIot

Parameters:

deletePolicyVersionRequest - The input for the DeletePolicyVersion operation.

Returns:

Result of the DeletePolicyVersion operation returned by the service.

Throws:

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.

deleteRegistrationCode

public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest request)

Deletes a CA certificate registration code.

Specified by:

deleteRegistrationCode in interface AWSIot

Parameters:

deleteRegistrationCodeRequest - The input for the DeleteRegistrationCode operation.

Returns:

Result of the DeleteRegistrationCode operation returned by the service.

Throws:

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.

deleteThing

public DeleteThingResult deleteThing(DeleteThingRequest request)

Deletes the specified thing.

Specified by:

deleteThing in interface AWSIot

Parameters:

deleteThingRequest - The input for the DeleteThing operation.

Returns:

Result of the DeleteThing operation returned by the service.

Throws:

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.

deleteThingType

public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest request)

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.

Specified by:

deleteThingType in interface AWSIot

Parameters:

deleteThingTypeRequest - The input for the DeleteThingType operation.

Returns:

Result of the DeleteThingType operation returned by the service.

Throws:

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.

deleteTopicRule

public DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest request)

Deletes the specified rule.

Specified by:

deleteTopicRule in interface AWSIot

Parameters:

deleteTopicRuleRequest - The input for the DeleteTopicRule operation.

Returns:

Result of the DeleteTopicRule operation returned by the service.

Throws:

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.

deprecateThingType

public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest request)

Deprecates a thing type. You can not associate new things with deprecated thing type.

Specified by:

deprecateThingType in interface AWSIot

Parameters:

deprecateThingTypeRequest - The input for the DeprecateThingType operation.

Returns:

Result of the DeprecateThingType operation returned by the service.

Throws:

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.

describeCACertificate

public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest request)

Describes a registered CA certificate.

Specified by:

describeCACertificate in interface AWSIot

Parameters:

describeCACertificateRequest - The input for the DescribeCACertificate operation.

Returns:

Result of the DescribeCACertificate operation returned by the service.

Throws:

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.

describeCertificate

public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)

Gets information about the specified certificate.

Specified by:

describeCertificate in interface AWSIot

Parameters:

describeCertificateRequest - The input for the DescribeCertificate operation.

Returns:

Result of the DescribeCertificate operation returned by the service.

Throws:

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.

describeEndpoint

public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)

Returns a unique endpoint specific to the AWS account making the call.

Specified by:

describeEndpoint in interface AWSIot

Parameters:

describeEndpointRequest - The input for the DescribeEndpoint operation.

Returns:

Result of the DescribeEndpoint operation returned by the service.

Throws:

InternalFailureException - An unexpected error has occurred.

UnauthorizedException - You are not authorized to perform this operation.

ThrottlingException - The rate exceeds the limit.

describeThing

public DescribeThingResult describeThing(DescribeThingRequest request)

Gets information about the specified thing.

Specified by:

describeThing in interface AWSIot

Parameters:

describeThingRequest - The input for the DescribeThing operation.

Returns:

Result of the DescribeThing operation returned by the service.

Throws:

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.

describeThingType

public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest request)

Gets information about the specified thing type.

Specified by:

describeThingType in interface AWSIot

Parameters:

describeThingTypeRequest - The input for the DescribeThingType operation.

Returns:

Result of the DescribeThingType operation returned by the service.

Throws:

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.

detachPrincipalPolicy

public DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest request)

Removes the specified policy from the specified certificate.

Specified by:

detachPrincipalPolicy in interface AWSIot

Parameters:

detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.

Returns:

Result of the DetachPrincipalPolicy operation returned by the service.

Throws:

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.

detachThingPrincipal

public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest request)

Detaches the specified principal from the specified thing.

Specified by:

detachThingPrincipal in interface AWSIot

Parameters:

detachThingPrincipalRequest - The input for the DetachThingPrincipal operation.

Returns:

Result of the DetachThingPrincipal operation returned by the service.

Throws:

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.

disableTopicRule

public DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest request)

Disables the specified rule.

Specified by:

disableTopicRule in interface AWSIot

Parameters:

disableTopicRuleRequest - The input for the DisableTopicRuleRequest operation.

Returns:

Result of the DisableTopicRule operation returned by the service.

Throws:

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.

enableTopicRule

public EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest request)

Enables the specified rule.

Specified by:

enableTopicRule in interface AWSIot

Parameters:

enableTopicRuleRequest - The input for the EnableTopicRuleRequest operation.

Returns:

Result of the EnableTopicRule operation returned by the service.

Throws:

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.

getLoggingOptions

public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)

Gets the logging options.

Specified by:

getLoggingOptions in interface AWSIot

Parameters:

getLoggingOptionsRequest - The input for the GetLoggingOptions operation.

Returns:

Result of the GetLoggingOptions operation returned by the service.

Throws:

InternalException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ServiceUnavailableException - The service is temporarily unavailable.

getPolicy

public GetPolicyResult getPolicy(GetPolicyRequest request)

Gets information about the specified policy with the policy document of the default version.

Specified by:

getPolicy in interface AWSIot

Parameters:

getPolicyRequest - The input for the GetPolicy operation.

Returns:

Result of the GetPolicy operation returned by the service.

Throws:

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.

getPolicyVersion

public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)

Gets information about the specified policy version.

Specified by:

getPolicyVersion in interface AWSIot

Parameters:

getPolicyVersionRequest - The input for the GetPolicyVersion operation.

Returns:

Result of the GetPolicyVersion operation returned by the service.

Throws:

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.

getRegistrationCode

public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest request)

Gets a registration code used to register a CA certificate with AWS IoT.

Specified by:

getRegistrationCode in interface AWSIot

Parameters:

getRegistrationCodeRequest - The input to the GetRegistrationCode operation.

Returns:

Result of the GetRegistrationCode operation returned by the service.

Throws:

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.

getTopicRule

public GetTopicRuleResult getTopicRule(GetTopicRuleRequest request)

Gets information about the specified rule.

Specified by:

getTopicRule in interface AWSIot

Parameters:

getTopicRuleRequest - The input for the GetTopicRule operation.

Returns:

Result of the GetTopicRule operation returned by the service.

Throws:

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.

listCACertificates

public ListCACertificatesResult listCACertificates(ListCACertificatesRequest request)

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.

Specified by:

listCACertificates in interface AWSIot

Parameters:

listCACertificatesRequest - Input for the ListCACertificates operation.

Returns:

Result of the ListCACertificates operation returned by the service.

Throws:

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.

listCertificates

public ListCertificatesResult listCertificates(ListCertificatesRequest request)

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.

Specified by:

listCertificates in interface AWSIot

Parameters:

listCertificatesRequest - The input for the ListCertificates operation.

Returns:

Result of the ListCertificates operation returned by the service.

Throws:

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.

listCertificatesByCA

public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest request)

List the device certificates signed by the specified CA certificate.

Specified by:

listCertificatesByCA in interface AWSIot

Parameters:

listCertificatesByCARequest - The input to the ListCertificatesByCA operation.

Returns:

Result of the ListCertificatesByCA operation returned by the service.

Throws:

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.

listOutgoingCertificates

public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest request)

Lists certificates that are being transfered but not yet accepted.

Specified by:

listOutgoingCertificates in interface AWSIot

Parameters:

listOutgoingCertificatesRequest - The input to the ListOutgoingCertificates operation.

Returns:

Result of the ListOutgoingCertificates operation returned by the service.

Throws:

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.

listPolicies

public ListPoliciesResult listPolicies(ListPoliciesRequest request)

Lists your policies.

Specified by:

listPolicies in interface AWSIot

Parameters:

listPoliciesRequest - The input for the ListPolicies operation.

Returns:

Result of the ListPolicies operation returned by the service.

Throws:

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.

listPolicyPrincipals

public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest request)

Lists the principals associated with the specified policy.

Specified by:

listPolicyPrincipals in interface AWSIot

Parameters:

listPolicyPrincipalsRequest - The input for the ListPolicyPrincipals operation.

Returns:

Result of the ListPolicyPrincipals operation returned by the service.

Throws:

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.

listPolicyVersions

public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)

Lists the versions of the specified policy and identifies the default version.

Specified by:

listPolicyVersions in interface AWSIot

Parameters:

listPolicyVersionsRequest - The input for the ListPolicyVersions operation.

Returns:

Result of the ListPolicyVersions operation returned by the service.

Throws:

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.

listPrincipalPolicies

public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest request)

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Specified by:

listPrincipalPolicies in interface AWSIot

Parameters:

listPrincipalPoliciesRequest - The input for the ListPrincipalPolicies operation.

Returns:

Result of the ListPrincipalPolicies operation returned by the service.

Throws:

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.

listPrincipalThings

public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest request)

Lists the things associated with the specified principal.

Specified by:

listPrincipalThings in interface AWSIot

Parameters:

listPrincipalThingsRequest - The input for the ListPrincipalThings operation.

Returns:

Result of the ListPrincipalThings operation returned by the service.

Throws:

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.

listThingPrincipals

public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest request)

Lists the principals associated with the specified thing.

Specified by:

listThingPrincipals in interface AWSIot

Parameters:

listThingPrincipalsRequest - The input for the ListThingPrincipal operation.

Returns:

Result of the ListThingPrincipals operation returned by the service.

Throws:

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.

listThingTypes

public ListThingTypesResult listThingTypes(ListThingTypesRequest request)

Lists the existing thing types.

Specified by:

listThingTypes in interface AWSIot

Parameters:

listThingTypesRequest - The input for the ListThingTypes operation.

Returns:

Result of the ListThingTypes operation returned by the service.

Throws:

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.

listThings

public ListThingsResult listThings(ListThingsRequest request)

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.

Specified by:

listThings in interface AWSIot

Parameters:

listThingsRequest - The input for the ListThings operation.

Returns:

Result of the ListThings operation returned by the service.

Throws:

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.

listTopicRules

public ListTopicRulesResult listTopicRules(ListTopicRulesRequest request)

Lists the rules for the specific topic.

Specified by:

listTopicRules in interface AWSIot

Parameters:

listTopicRulesRequest - The input for the ListTopicRules operation.

Returns:

Result of the ListTopicRules operation returned by the service.

Throws:

InternalException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ServiceUnavailableException - The service is temporarily unavailable.

registerCACertificate

public RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest request)

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.

Specified by:

registerCACertificate in interface AWSIot

Parameters:

registerCACertificateRequest - The input to the RegisterCACertificate operation.

Returns:

Result of the RegisterCACertificate operation returned by the service.

Throws:

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.

registerCertificate

public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)

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.

Specified by:

registerCertificate in interface AWSIot

Parameters:

registerCertificateRequest - The input to the RegisterCertificate operation.

Returns:

Result of the RegisterCertificate operation returned by the service.

Throws:

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.

rejectCertificateTransfer

public RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest request)

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.

Specified by:

rejectCertificateTransfer in interface AWSIot

Parameters:

rejectCertificateTransferRequest - The input for the RejectCertificateTransfer operation.

Returns:

Result of the RejectCertificateTransfer operation returned by the service.

Throws:

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.

replaceTopicRule

public ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest request)

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.

Specified by:

replaceTopicRule in interface AWSIot

Parameters:

replaceTopicRuleRequest - The input for the ReplaceTopicRule operation.

Returns:

Result of the ReplaceTopicRule operation returned by the service.

Throws:

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.

setDefaultPolicyVersion

public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)

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.

Specified by:

setDefaultPolicyVersion in interface AWSIot

Parameters:

setDefaultPolicyVersionRequest - The input for the SetDefaultPolicyVersion operation.

Returns:

Result of the SetDefaultPolicyVersion operation returned by the service.

Throws:

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.

setLoggingOptions

public SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest request)

Sets the logging options.

Specified by:

setLoggingOptions in interface AWSIot

Parameters:

setLoggingOptionsRequest - The input for the SetLoggingOptions operation.

Returns:

Result of the SetLoggingOptions operation returned by the service.

Throws:

InternalException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ServiceUnavailableException - The service is temporarily unavailable.

transferCertificate

public TransferCertificateResult transferCertificate(TransferCertificateRequest request)

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.

Specified by:

transferCertificate in interface AWSIot

Parameters:

transferCertificateRequest - The input for the TransferCertificate operation.

Returns:

Result of the TransferCertificate operation returned by the service.

Throws:

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.

updateCACertificate

public UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest request)

Updates a registered CA certificate.

Specified by:

updateCACertificate in interface AWSIot

Parameters:

updateCACertificateRequest - The input to the UpdateCACertificate operation.

Returns:

Result of the UpdateCACertificate operation returned by the service.

Throws:

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.

updateCertificate

public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)

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.

Specified by:

updateCertificate in interface AWSIot

Parameters:

updateCertificateRequest - The input for the UpdateCertificate operation.

Returns:

Result of the UpdateCertificate operation returned by the service.

Throws:

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.

updateThing

public UpdateThingResult updateThing(UpdateThingRequest request)

Updates the data for a thing.

Specified by:

updateThing in interface AWSIot

Parameters:

updateThingRequest - The input for the UpdateThing operation.

Returns:

Result of the UpdateThing operation returned by the service.

Throws:

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.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSIot

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.