com.amazonaws.services.iot

Interface AWSIot

All Known Subinterfaces:

AWSIotAsync

All Known Implementing Classes:

AbstractAWSIot, AbstractAWSIotAsync, AWSIotAsyncClient, AWSIotClient

public interface AWSIot

Interface for accessing AWS IoT.

AWS IoT (Beta)

AWS IoT is in beta and is subject to change

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.

Method Summary

Methods

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 in the thing registry.
void	createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) Creates a rule.
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.
DeleteThingResult	deleteThing(DeleteThingRequest deleteThingRequest) Deletes the specified thing from the Thing Registry.
void	deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) Deletes the specified rule.
DescribeCertificateResult	describeCertificate(DescribeCertificateRequest describeCertificateRequest) Gets information about the specified certificate.
DescribeEndpointResult	describeEndpoint(DescribeEndpointRequest describeEndpointRequest) Returns a unique URL specific to the AWS account making the call.
DescribeThingResult	describeThing(DescribeThingRequest describeThingRequest) Gets information about the specified thing.
void	detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) Removes the specified policy from the specified certificate.
DetachThingPrincipalResult	detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) Detaches the specified principal from the specified thing.
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 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.
GetTopicRuleResult	getTopicRule(GetTopicRuleRequest getTopicRuleRequest) Gets information about the specified rule.
ListCertificatesResult	listCertificates(ListCertificatesRequest listCertificatesRequest) Lists your certificates.
ListPoliciesResult	listPolicies(ListPoliciesRequest listPoliciesRequest) Lists your policies.
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.
ListTopicRulesResult	listTopicRules(ListTopicRulesRequest listTopicRulesRequest) Lists the rules for the specific topic.
void	rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) Rejects a pending certificate transfer.
void	replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) Replaces the specified rule.
void	setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) Sets the specified policy version as the default for the specified policy.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://iot.us-east-1.amazonaws.com").
void	setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) Sets the logging options.
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TransferCertificateResult	transferCertificate(TransferCertificateRequest transferCertificateRequest) Transfers the specified certificate to the specified AWS account.
void	updateCertificate(UpdateCertificateRequest updateCertificateRequest) Updates the status of the specified certificate.
UpdateThingResult	updateThing(UpdateThingRequest updateThingRequest) Updates the data for a thing.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://iot.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://iot.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

acceptCertificateTransfer

void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

Parameters:

acceptCertificateTransferRequest - The input for the AcceptCertificateTransfer operation.

Throws:

ResourceNotFoundException - The specified resource does not exist.

TransferAlreadyCompletedException - You can't revert the certificate transfer because it has already completed.

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

void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)

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

Parameters:

attachPrincipalPolicyRequest - The input for the AttachPrincipalPolicy operation.

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

AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)

Attaches the specified principal to the specified thing.

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

void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer (transfer destinations can use RejectCertificateTransfer instead). After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. Once the destination account has accepted the transfer, the transfer may no longer be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Parameters:

cancelCertificateTransferRequest - The input for the CancelCertificateTransfer operation.

Throws:

ResourceNotFoundException - The specified resource does not exist.

TransferAlreadyCompletedException - You can't revert the certificate transfer because it has already completed.

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

CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)

Creates an X.509 certificate using the specified certificate signing request.

Note Reusing the same certificate signing request (CSR) results in a distinct certificate.

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

CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)

Creates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key.

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

CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest)

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

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

CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)

Creates a new version of the specified AWS IoT policy.

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

CreateThingResult createThing(CreateThingRequest createThingRequest)

Creates a thing in the thing registry.

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.

createTopicRule

void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)

Creates a rule.

Parameters:

createTopicRuleRequest - The input for the CreateTopicRule operation.

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.

deleteCertificate

void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it. To delete a certificate, first detach all policies using the DetachPrincipalPolicy operation.

In addition, a certificate cannot be deleted if it is in ACTIVE status. To delete a certificate, first change the status to INACTIVE using the UpdateCertificate operation.

Parameters:

deleteCertificateRequest - The input for the DeleteCertificate operation.

Throws:

DeleteConflictException - You can't delete the resource because it is attached to one or more resources.

ResourceNotFoundException - The specified resource does not exist.

CertificateStateException - The certificate operation is not allowed.

deletePolicy

void deletePolicy(DeletePolicyRequest deletePolicyRequest)

Deletes the specified policy.

A policy cannot be deleted if:

- it has non-default versions

- it is attached to any certificate

To delete a policy:

- First delete all the non-default versions of the policy using the DeletePolicyVersion API.

- Detach it from any certificate using the DetachPrincipalPolicy API.

When a policy is deleted, its default version is deleted with it.

Parameters:

deletePolicyRequest - The input for the DeletePolicy operation.

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

void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)

Deletes the specified version of the specified policy. The default version of the policy cannot be deleted.

To delete the default version use the DeletePolicy API or mark the policy as non-default and then delete it.

Parameters:

deletePolicyVersionRequest - The input for the DeletePolicyVersion operation.

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.

deleteThing

DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest)

Deletes the specified thing from the Thing Registry.

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.

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

void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)

Deletes the specified rule.

Parameters:

deleteTopicRuleRequest - The input for the DeleteTopicRule operation.

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.

describeCertificate

DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest)

Gets information about the specified certificate.

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

DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)

Returns a unique URL specific to the AWS account making the call. The URL points to the AWS IoT data plane endpoint. The customer-specific endpoint should be provided to all data plane operations.

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.

describeThing

DescribeThingResult describeThing(DescribeThingRequest describeThingRequest)

Gets information about the specified thing.

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.

detachPrincipalPolicy

void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)

Removes the specified policy from the specified certificate.

Parameters:

detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.

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

DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)

Detaches the specified principal from the specified thing.

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.

getLoggingOptions

GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)

Gets the logging options.

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

GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)

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

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

GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)

Gets information about the specified policy version.

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.

getTopicRule

GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest)

Gets information about the specified rule.

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.

listCertificates

ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest)

Lists your certificates.

The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.

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.

listPolicies

ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)

Lists your policies.

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.

listPolicyVersions

ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)

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

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

ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)

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

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

ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)

Lists the things associated with the specified principal.

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.

listThingPrincipals

ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)

Lists the principals associated with the specified thing.

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.

listThings

ListThingsResult listThings(ListThingsRequest listThingsRequest)

Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"

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

ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest)

Lists the rules for the specific topic.

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.

rejectCertificateTransfer

void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source's account in the INACTIVE state.

Parameters:

rejectCertificateTransferRequest - The input for the RejectCertificateTransfer operation.

Throws:

ResourceNotFoundException - The specified resource does not exist.

TransferAlreadyCompletedException - You can't revert the certificate transfer because it has already completed.

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

void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)

Replaces the specified rule. You must specify all parameters for the new rule.

Parameters:

replaceTopicRuleRequest - The input for the ReplaceTopicRule operation.

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

void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)

Sets the specified policy version as the default for the specified policy.

Parameters:

setDefaultPolicyVersionRequest - The input for the SetDefaultPolicyVersion operation.

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

void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)

Sets the logging options.

Parameters:

setLoggingOptionsRequest - The input for the SetLoggingOptions operation.

Throws:

InternalException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

ServiceUnavailableException - The service is temporarily unavailable.

transferCertificate

TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest)

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account, it is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API.

The certificate must not have any policies attached to it. These can be detached using the DetachPrincipalPolicy API.

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

updateCertificate

void updateCertificate(UpdateCertificateRequest updateCertificateRequest)

Updates the status of the specified certificate. This operation is idempotent.

Moving a cert from the ACTIVE state (including REVOKED) will NOT disconnect currently-connected devices, although these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Parameters:

updateCertificateRequest - The input for the UpdateCertificate operation.

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

UpdateThingResult updateThing(UpdateThingRequest updateThingRequest)

Updates the data for a thing.

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.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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