com.amazonaws.services.iot

Class AWSIotClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iot.AWSIotClient

All Implemented Interfaces:

AWSIot

public class AWSIotClient
extends AmazonWebServiceClient
implements AWSIot

Client for accessing AWSIot. 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

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSIot exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSIotClient() Deprecated.
AWSIotClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSIot using the specified AWS account credentials.
AWSIotClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSIot using the specified AWS account credentials and client configuration options.
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSIot using the specified AWS account credentials provider.
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSIot using the specified AWS account credentials provider and client configuration options.
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AWSIot using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AWSIotClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

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 endpoint 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.
void	disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) Disables the specified rule.
void	enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) Enables the specified rule.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetLoggingOptionsResult	getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) Gets the logging options.
GetPolicyResult	getPolicy(GetPolicyRequest getPolicyRequest) Gets information about the specified policy with the policy document of the default version.
GetPolicyVersionResult	getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) Gets information about the specified policy version.
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 version of the specified policy as the policy's default (operative) version.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://iot.us-east-1.amazonaws.com").
void	setEndpoint(String endpoint, String serviceName, String regionId)
void	setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) Sets the logging options.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSIot exceptions.

Constructor Detail

AWSIotClient

@Deprecated
public AWSIotClient()

Deprecated.

Constructs a new client to invoke service methods on AWSIot. 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.

Constructs a new client to invoke service methods on AWSIot. 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 AWSIot (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSIotClient

public AWSIotClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSIot 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

public AWSIotClient(AWSCredentials awsCredentials,
                    ClientConfiguration clientConfiguration)

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

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

AWSIotClient

public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSIot 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

public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
                    ClientConfiguration clientConfiguration)

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

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

AWSIotClient

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

Deprecated.

Constructs a new client to invoke service methods on AWSIot 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 AWSIot (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AWSIotClient

public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
                    ClientConfiguration clientConfiguration,
                    HttpClient httpClient)

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

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

httpClient - A http client

Method Detail

deleteTopicRule

public void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)

Deletes the specified rule.

Specified by:

deleteTopicRule in interface AWSIot

Parameters:

deleteTopicRuleRequest - Container for the necessary parameters to execute the DeleteTopicRule service method on AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

acceptCertificateTransfer

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

Specified by:

acceptCertificateTransfer in interface AWSIot

Parameters:

acceptCertificateTransferRequest - Container for the necessary parameters to execute the AcceptCertificateTransfer service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

TransferAlreadyCompletedException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

deletePolicyVersion

public void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Specified by:

deletePolicyVersion in interface AWSIot

Parameters:

deletePolicyVersionRequest - Container for the necessary parameters to execute the DeletePolicyVersion service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

DeleteConflictException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

attachThingPrincipal

public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)

Attaches the specified principal to the specified thing.

Specified by:

attachThingPrincipal in interface AWSIot

Parameters:

attachThingPrincipalRequest - Container for the necessary parameters to execute the AttachThingPrincipal service method on AWSIot.

Returns:

The response from the AttachThingPrincipal service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

deleteThing

public DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest)

Deletes the specified thing from the Thing Registry.

Specified by:

deleteThing in interface AWSIot

Parameters:

deleteThingRequest - Container for the necessary parameters to execute the DeleteThing service method on AWSIot.

Returns:

The response from the DeleteThing service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listPolicyVersions

public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)

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

Specified by:

listPolicyVersions in interface AWSIot

Parameters:

listPolicyVersionsRequest - Container for the necessary parameters to execute the ListPolicyVersions service method on AWSIot.

Returns:

The response from the ListPolicyVersions service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

deleteCertificate

public void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

Specified by:

deleteCertificate in interface AWSIot

Parameters:

deleteCertificateRequest - Container for the necessary parameters to execute the DeleteCertificate service method on AWSIot.

Throws:

CertificateStateException

ResourceNotFoundException

DeleteConflictException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

replaceTopicRule

public void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)

Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Specified by:

replaceTopicRule in interface AWSIot

Parameters:

replaceTopicRuleRequest - Container for the necessary parameters to execute the ReplaceTopicRule service method on AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

UnauthorizedException

SqlParseException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listThings

public ListThingsResult listThings(ListThingsRequest listThingsRequest)

Lists your things. You can pass an AttributeName or AttributeValue to filter your things (for example, "ListThings where AttributeName=Color and AttributeValue=Red").

Specified by:

listThings in interface AWSIot

Parameters:

listThingsRequest - Container for the necessary parameters to execute the ListThings service method on AWSIot.

Returns:

The response from the ListThings service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

rejectCertificateTransfer

public 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. 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 - Container for the necessary parameters to execute the RejectCertificateTransfer service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

TransferAlreadyCompletedException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

disableTopicRule

public void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)

Disables the specified rule.

Specified by:

disableTopicRule in interface AWSIot

Parameters:

disableTopicRuleRequest - Container for the necessary parameters to execute the DisableTopicRule service method on AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

deletePolicy

public void deletePolicy(DeletePolicyRequest deletePolicyRequest)

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

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

Specified by:

deletePolicy in interface AWSIot

Parameters:

deletePolicyRequest - Container for the necessary parameters to execute the DeletePolicy service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

DeleteConflictException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listCertificates

public ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest)

Lists your certificates.

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 - Container for the necessary parameters to execute the ListCertificates service method on AWSIot.

Returns:

The response from the ListCertificates service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

detachPrincipalPolicy

public void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)

Removes the specified policy from the specified certificate.

Specified by:

detachPrincipalPolicy in interface AWSIot

Parameters:

detachPrincipalPolicyRequest - Container for the necessary parameters to execute the DetachPrincipalPolicy service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

getLoggingOptions

public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)

Gets the logging options.

Specified by:

getLoggingOptions in interface AWSIot

Parameters:

getLoggingOptionsRequest - Container for the necessary parameters to execute the GetLoggingOptions service method on AWSIot.

Returns:

The response from the GetLoggingOptions service method, as returned by AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

getPolicyVersion

public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)

Gets information about the specified policy version.

Specified by:

getPolicyVersion in interface AWSIot

Parameters:

getPolicyVersionRequest - Container for the necessary parameters to execute the GetPolicyVersion service method on AWSIot.

Returns:

The response from the GetPolicyVersion service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

describeCertificate

public DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest)

Gets information about the specified certificate.

Specified by:

describeCertificate in interface AWSIot

Parameters:

describeCertificateRequest - Container for the necessary parameters to execute the DescribeCertificate service method on AWSIot.

Returns:

The response from the DescribeCertificate service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listPrincipalThings

public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)

Lists the things associated with the specified principal.

Specified by:

listPrincipalThings in interface AWSIot

Parameters:

listPrincipalThingsRequest - Container for the necessary parameters to execute the ListPrincipalThings service method on AWSIot.

Returns:

The response from the ListPrincipalThings service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

updateCertificate

public void updateCertificate(UpdateCertificateRequest updateCertificateRequest)

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

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

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

Specified by:

updateCertificate in interface AWSIot

Parameters:

updateCertificateRequest - Container for the necessary parameters to execute the UpdateCertificate service method on AWSIot.

Throws:

CertificateStateException

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

setDefaultPolicyVersion

public void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

Specified by:

setDefaultPolicyVersion in interface AWSIot

Parameters:

setDefaultPolicyVersionRequest - Container for the necessary parameters to execute the SetDefaultPolicyVersion service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

getTopicRule

public GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest)

Gets information about the specified rule.

Specified by:

getTopicRule in interface AWSIot

Parameters:

getTopicRuleRequest - Container for the necessary parameters to execute the GetTopicRule service method on AWSIot.

Returns:

The response from the GetTopicRule service method, as returned by AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

updateThing

public UpdateThingResult updateThing(UpdateThingRequest updateThingRequest)

Updates the data for a thing.

Specified by:

updateThing in interface AWSIot

Parameters:

updateThingRequest - Container for the necessary parameters to execute the UpdateThing service method on AWSIot.

Returns:

The response from the UpdateThing service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createPolicyVersion

public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Specified by:

createPolicyVersion in interface AWSIot

Parameters:

createPolicyVersionRequest - Container for the necessary parameters to execute the CreatePolicyVersion service method on AWSIot.

Returns:

The response from the CreatePolicyVersion service method, as returned by AWSIot.

Throws:

MalformedPolicyException

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

VersionsLimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createKeysAndCertificate

public 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, so it is important to keep it in a secure location.

Specified by:

createKeysAndCertificate in interface AWSIot

Parameters:

createKeysAndCertificateRequest - Container for the necessary parameters to execute the CreateKeysAndCertificate service method on AWSIot.

Returns:

The response from the CreateKeysAndCertificate service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createTopicRule

public void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Specified by:

createTopicRule in interface AWSIot

Parameters:

createTopicRuleRequest - Container for the necessary parameters to execute the CreateTopicRule service method on AWSIot.

Throws:

InternalException

ResourceAlreadyExistsException

ServiceUnavailableException

InvalidRequestException

SqlParseException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

getPolicy

public GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)

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

Specified by:

getPolicy in interface AWSIot

Parameters:

getPolicyRequest - Container for the necessary parameters to execute the GetPolicy service method on AWSIot.

Returns:

The response from the GetPolicy service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

describeThing

public DescribeThingResult describeThing(DescribeThingRequest describeThingRequest)

Gets information about the specified thing.

Specified by:

describeThing in interface AWSIot

Parameters:

describeThingRequest - Container for the necessary parameters to execute the DescribeThing service method on AWSIot.

Returns:

The response from the DescribeThing service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

detachThingPrincipal

public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)

Detaches the specified principal from the specified thing.

Specified by:

detachThingPrincipal in interface AWSIot

Parameters:

detachThingPrincipalRequest - Container for the necessary parameters to execute the DetachThingPrincipal service method on AWSIot.

Returns:

The response from the DetachThingPrincipal service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listPrincipalPolicies

public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)

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

Specified by:

listPrincipalPolicies in interface AWSIot

Parameters:

listPrincipalPoliciesRequest - Container for the necessary parameters to execute the ListPrincipalPolicies service method on AWSIot.

Returns:

The response from the ListPrincipalPolicies service method, as returned by AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

setLoggingOptions

public void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)

Sets the logging options.

Specified by:

setLoggingOptions in interface AWSIot

Parameters:

setLoggingOptionsRequest - Container for the necessary parameters to execute the SetLoggingOptions service method on AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

transferCertificate

public 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. 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 - Container for the necessary parameters to execute the TransferCertificate service method on AWSIot.

Returns:

The response from the TransferCertificate service method, as returned by AWSIot.

Throws:

CertificateStateException

ResourceNotFoundException

ServiceUnavailableException

TransferConflictException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listTopicRules

public ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest)

Lists the rules for the specific topic.

Specified by:

listTopicRules in interface AWSIot

Parameters:

listTopicRulesRequest - Container for the necessary parameters to execute the ListTopicRules service method on AWSIot.

Returns:

The response from the ListTopicRules service method, as returned by AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

enableTopicRule

public void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)

Enables the specified rule.

Specified by:

enableTopicRule in interface AWSIot

Parameters:

enableTopicRuleRequest - Container for the necessary parameters to execute the EnableTopicRule service method on AWSIot.

Throws:

InternalException

ServiceUnavailableException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listPolicies

public ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)

Lists your policies.

Specified by:

listPolicies in interface AWSIot

Parameters:

listPoliciesRequest - Container for the necessary parameters to execute the ListPolicies service method on AWSIot.

Returns:

The response from the ListPolicies service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

describeEndpoint

public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)

Returns a unique endpoint specific to the AWS account making the call. You specify the following URI when updating state information for your thing: https:// endpoint /things/ thingName /shadow.

Specified by:

describeEndpoint in interface AWSIot

Parameters:

describeEndpointRequest - Container for the necessary parameters to execute the DescribeEndpoint service method on AWSIot.

Returns:

The response from the DescribeEndpoint service method, as returned by AWSIot.

Throws:

InternalFailureException

ThrottlingException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

attachPrincipalPolicy

public void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)

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

Specified by:

attachPrincipalPolicy in interface AWSIot

Parameters:

attachPrincipalPolicyRequest - Container for the necessary parameters to execute the AttachPrincipalPolicy service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

LimitExceededException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

cancelCertificateTransfer

public 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. 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 - Container for the necessary parameters to execute the CancelCertificateTransfer service method on AWSIot.

Throws:

ResourceNotFoundException

ServiceUnavailableException

TransferAlreadyCompletedException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createThing

public CreateThingResult createThing(CreateThingRequest createThingRequest)

Creates a thing in the Thing Registry.

Specified by:

createThing in interface AWSIot

Parameters:

createThingRequest - Container for the necessary parameters to execute the CreateThing service method on AWSIot.

Returns:

The response from the CreateThing service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ResourceAlreadyExistsException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createPolicy

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

Specified by:

createPolicy in interface AWSIot

Parameters:

createPolicyRequest - Container for the necessary parameters to execute the CreatePolicy service method on AWSIot.

Returns:

The response from the CreatePolicy service method, as returned by AWSIot.

Throws:

MalformedPolicyException

ResourceAlreadyExistsException

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

createCertificateFromCsr

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

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 - Container for the necessary parameters to execute the CreateCertificateFromCsr service method on AWSIot.

Returns:

The response from the CreateCertificateFromCsr service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

listThingPrincipals

public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)

Lists the principals associated with the specified thing.

Specified by:

listThingPrincipals in interface AWSIot

Parameters:

listThingPrincipalsRequest - Container for the necessary parameters to execute the ListThingPrincipals service method on AWSIot.

Returns:

The response from the ListThingPrincipals service method, as returned by AWSIot.

Throws:

ServiceUnavailableException

ThrottlingException

InternalFailureException

InvalidRequestException

UnauthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSIot indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSIot

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.

Specified by:

setEndpoint in interface AWSIot

Overrides:

setEndpoint in class AmazonWebServiceClient

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.

setEndpoint

public void setEndpoint(String endpoint,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.