public interface AWSIot
AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.
For more information about how AWS IoT works, see the Developer Guide .
| Modifier and Type | 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)
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 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 |
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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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.
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.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified rule.
deleteTopicRuleRequest - Container for the necessary parameters
to execute the DeleteTopicRule service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
acceptCertificateTransferRequest - Container for the necessary
parameters to execute the AcceptCertificateTransfer service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionTransferAlreadyCompletedExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
deletePolicyVersionRequest - Container for the necessary
parameters to execute the DeletePolicyVersion service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionDeleteConflictExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified principal to the specified thing.
attachThingPrincipalRequest - Container for the necessary
parameters to execute the AttachThingPrincipal service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified thing from the Thing Registry.
deleteThingRequest - Container for the necessary parameters to
execute the DeleteThing service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonServiceException, AmazonClientException
Lists the versions of the specified policy, and identifies the default version.
listPolicyVersionsRequest - Container for the necessary
parameters to execute the ListPolicyVersions service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest - Container for the necessary parameters
to execute the DeleteCertificate service method on AWSIot.CertificateStateExceptionResourceNotFoundExceptionDeleteConflictExceptionAmazonClientException - 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.void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
replaceTopicRuleRequest - Container for the necessary parameters
to execute the ReplaceTopicRule service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionSqlParseExceptionAmazonClientException - 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.ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonServiceException, AmazonClientException
Lists your things. You can pass an AttributeName or AttributeValue to filter your things (for example, "ListThings where AttributeName=Color and AttributeValue=Red").
listThingsRequest - Container for the necessary parameters to
execute the ListThings service method on AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_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.
rejectCertificateTransferRequest - Container for the necessary
parameters to execute the RejectCertificateTransfer service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionTransferAlreadyCompletedExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Disables the specified rule.
disableTopicRuleRequest - Container for the necessary parameters
to execute the DisableTopicRule service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest - Container for the necessary parameters to
execute the DeletePolicy service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionDeleteConflictExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonServiceException, AmazonClientException
Lists your certificates.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCertificatesRequest - Container for the necessary parameters
to execute the ListCertificates service method on AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Removes the specified policy from the specified certificate.
detachPrincipalPolicyRequest - Container for the necessary
parameters to execute the DetachPrincipalPolicy service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Gets the logging options.
getLoggingOptionsRequest - Container for the necessary parameters
to execute the GetLoggingOptions service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionAmazonClientException - 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.GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy version.
getPolicyVersionRequest - Container for the necessary parameters
to execute the GetPolicyVersion service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified certificate.
describeCertificateRequest - Container for the necessary
parameters to execute the DescribeCertificate service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonServiceException, AmazonClientException
Lists the things associated with the specified principal.
listPrincipalThingsRequest - Container for the necessary
parameters to execute the ListPrincipalThings service method on
AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonServiceException, AmazonClientException
Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
updateCertificateRequest - Container for the necessary parameters
to execute the UpdateCertificate service method on AWSIot.CertificateStateExceptionResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
setDefaultPolicyVersionRequest - Container for the necessary
parameters to execute the SetDefaultPolicyVersion service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified rule.
getTopicRuleRequest - Container for the necessary parameters to
execute the GetTopicRule service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonServiceException, AmazonClientException
Updates the data for a thing.
updateThingRequest - Container for the necessary parameters to
execute the UpdateThing service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
createPolicyVersionRequest - Container for the necessary
parameters to execute the CreatePolicyVersion service method on
AWSIot.MalformedPolicyExceptionResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionVersionsLimitExceededExceptionAmazonClientException - 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.CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonServiceException, AmazonClientException
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificateRequest - Container for the necessary
parameters to execute the CreateKeysAndCertificate service method on
AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
createTopicRuleRequest - Container for the necessary parameters
to execute the CreateTopicRule service method on AWSIot.InternalExceptionResourceAlreadyExistsExceptionServiceUnavailableExceptionInvalidRequestExceptionSqlParseExceptionAmazonClientException - 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.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest - Container for the necessary parameters to
execute the GetPolicy service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified thing.
describeThingRequest - Container for the necessary parameters to
execute the DescribeThing service method on AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Detaches the specified principal from the specified thing.
detachThingPrincipalRequest - Container for the necessary
parameters to execute the DetachThingPrincipal service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format .
listPrincipalPoliciesRequest - Container for the necessary
parameters to execute the ListPrincipalPolicies service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Sets the logging options.
setLoggingOptionsRequest - Container for the necessary parameters
to execute the SetLoggingOptions service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionAmazonClientException - 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.TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest) throws AmazonServiceException, AmazonClientException
Transfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
transferCertificateRequest - Container for the necessary
parameters to execute the TransferCertificate service method on
AWSIot.CertificateStateExceptionResourceNotFoundExceptionServiceUnavailableExceptionTransferConflictExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonServiceException, AmazonClientException
Lists the rules for the specific topic.
listTopicRulesRequest - Container for the necessary parameters to
execute the ListTopicRules service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionAmazonClientException - 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.void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Enables the specified rule.
enableTopicRuleRequest - Container for the necessary parameters
to execute the EnableTopicRule service method on AWSIot.InternalExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists your policies.
listPoliciesRequest - Container for the necessary parameters to
execute the ListPolicies service method on AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonServiceException, AmazonClientException
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.
describeEndpointRequest - Container for the necessary parameters
to execute the DescribeEndpoint service method on AWSIot.InternalFailureExceptionThrottlingExceptionUnauthorizedExceptionAmazonClientException - 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.void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified policy to the specified principal (certificate or other credential).
attachPrincipalPolicyRequest - Container for the necessary
parameters to execute the AttachPrincipalPolicy service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionLimitExceededExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransferRequest - Container for the necessary
parameters to execute the CancelCertificateTransfer service method on
AWSIot.ResourceNotFoundExceptionServiceUnavailableExceptionTransferAlreadyCompletedExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonServiceException, AmazonClientException
Creates a thing in the Thing Registry.
createThingRequest - Container for the necessary parameters to
execute the CreateThing service method on AWSIot.ServiceUnavailableExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonServiceException, AmazonClientException
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
createPolicyRequest - Container for the necessary parameters to
execute the CreatePolicy service method on AWSIot.MalformedPolicyExceptionResourceAlreadyExistsExceptionServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonServiceException, AmazonClientException
Creates an X.509 certificate using the specified certificate signing request.
Note Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
>
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest - Container for the necessary
parameters to execute the CreateCertificateFromCsr service method on
AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonServiceException, AmazonClientException
Lists the principals associated with the specified thing.
listThingPrincipalsRequest - Container for the necessary
parameters to execute the ListThingPrincipals service method on
AWSIot.ServiceUnavailableExceptionThrottlingExceptionInternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionAmazonClientException - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2016. All rights reserved.