public interface AWSIot
AWS IoT provides secure, bi-directional communication between Internet-connected devices (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 device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
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.
|
AddThingToThingGroupResult |
addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.
|
AssociateTargetsWithJobResult |
associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest)
Associates a group with a continuous job.
|
void |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy to the specified target.
|
void |
attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Deprecated.
|
AttachThingPrincipalResult |
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.
|
void |
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.
|
CancelJobResult |
cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job.
|
void |
cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
|
ClearDefaultAuthorizerResult |
clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.
|
CreateCertificateFromCsrResult |
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing
request.
|
CreateJobResult |
createJob(CreateJobRequest createJobRequest)
Creates a job.
|
CreateKeysAndCertificateResult |
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the
issued public key.
|
CreateOTAUpdateResult |
createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an AWS IoT policy.
|
CreatePolicyVersionResult |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified AWS IoT policy.
|
CreateRoleAliasResult |
createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.
|
CreateStreamResult |
createStream(CreateStreamRequest createStreamRequest)
Creates a stream for delivering one or more large files in chunks over
MQTT.
|
CreateThingResult |
createThing(CreateThingRequest createThingRequest)
Creates a thing record in the registry.
|
CreateThingGroupResult |
createThingGroup(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.
|
CreateThingTypeResult |
createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
|
void |
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.
|
DeleteCACertificateResult |
deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
|
void |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
void |
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job and its related job executions.
|
void |
deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
|
DeleteOTAUpdateResult |
deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest)
Delete an OTA update.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
|
void |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy.
|
DeleteRegistrationCodeResult |
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
|
DeleteRoleAliasResult |
deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role alias
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.
|
DeleteThingResult |
deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing.
|
DeleteThingGroupResult |
deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.
|
DeleteThingTypeResult |
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type .
|
void |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
|
void |
deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.
|
DeprecateThingTypeResult |
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type.
|
DescribeAuthorizerResult |
describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest)
Describes an authorizer.
|
DescribeCACertificateResult |
describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
|
DescribeDefaultAuthorizerResult |
describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest)
Describes the default authorizer.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the AWS account making the call.
|
DescribeEventConfigurationsResult |
describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes a search index.
|
DescribeJobResult |
describeJob(DescribeJobRequest describeJobRequest)
Describes a job.
|
DescribeJobExecutionResult |
describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.
|
DescribeRoleAliasResult |
describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest)
Describes a role alias.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest describeStreamRequest)
Gets information about a stream.
|
DescribeThingResult |
describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
|
DescribeThingGroupResult |
describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest)
Describe a thing group.
|
DescribeThingRegistrationTaskResult |
describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.
|
DescribeThingTypeResult |
describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
|
void |
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.
|
void |
detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Deprecated.
|
DetachThingPrincipalResult |
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.
|
void |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.
|
void |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the 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.
|
GetEffectivePoliciesResult |
getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest)
Gets a list of the policies that have an effect on the authorization
behavior of the specified device when it connects to the AWS IoT device
gateway.
|
GetIndexingConfigurationResult |
getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest)
Gets the search configuration.
|
GetJobDocumentResult |
getJobDocument(GetJobDocumentRequest getJobDocumentRequest)
Gets a job document.
|
GetLoggingOptionsResult |
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
|
GetOTAUpdateResult |
getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest)
Gets an OTA update.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of
the default version.
|
GetPolicyVersionResult |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
|
GetRegistrationCodeResult |
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with AWS IoT.
|
GetTopicRuleResult |
getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the rule.
|
GetV2LoggingOptionsResult |
getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest)
Gets the fine grained logging options.
|
ListAttachedPoliciesResult |
listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.
|
ListAuthorizersResult |
listAuthorizers(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.
|
ListCACertificatesResult |
listCACertificates(ListCACertificatesRequest listCACertificatesRequest)
Lists the CA certificates registered for your AWS account.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your AWS account.
|
ListCertificatesByCAResult |
listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest)
List the device certificates signed by the specified CA certificate.
|
ListIndicesResult |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the search indices.
|
ListJobExecutionsForJobResult |
listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest)
Lists the job executions for a job.
|
ListJobExecutionsForThingResult |
listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Lists jobs.
|
ListOTAUpdatesResult |
listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest)
Lists OTA updates.
|
ListOutgoingCertificatesResult |
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
|
ListPolicyPrincipalsResult |
listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest)
Deprecated.
|
ListPolicyVersionsResult |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default
version.
|
ListPrincipalPoliciesResult |
listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Deprecated.
|
ListPrincipalThingsResult |
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.
|
ListRoleAliasesResult |
listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest)
Lists the role aliases registered in your account.
|
ListStreamsResult |
listStreams(ListStreamsRequest listStreamsRequest)
Lists all of the streams in your AWS account.
|
ListTargetsForPolicyResult |
listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest)
List targets for the specified policy.
|
ListThingGroupsResult |
listThingGroups(ListThingGroupsRequest listThingGroupsRequest)
List the thing groups in your account.
|
ListThingGroupsForThingResult |
listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.
|
ListThingPrincipalsResult |
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.
|
ListThingRegistrationTaskReportsResult |
listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.
|
ListThingRegistrationTasksResult |
listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.
|
ListThingsResult |
listThings(ListThingsRequest listThingsRequest)
Lists your things.
|
ListThingsInThingGroupResult |
listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest)
Lists the things in the specified group.
|
ListThingTypesResult |
listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.
|
ListTopicRulesResult |
listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
|
ListV2LoggingLevelsResult |
listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest)
Lists logging levels.
|
RegisterCACertificateResult |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with AWS IoT.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with AWS IoT.
|
RegisterThingResult |
registerThing(RegisterThingRequest registerThingRequest)
Provisions a thing.
|
void |
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer.
|
RemoveThingFromThingGroupResult |
removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest)
Remove the specified thing from the specified group.
|
void |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the rule.
|
SearchIndexResult |
searchIndex(SearchIndexRequest searchIndexRequest)
The query search index.
|
SetDefaultAuthorizerResult |
setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest)
Sets the default authorizer.
|
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 |
setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.
|
void |
setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartThingRegistrationTaskResult |
startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.
|
StopThingRegistrationTaskResult |
stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.
|
TestAuthorizationResult |
testAuthorization(TestAuthorizationRequest testAuthorizationRequest)
Tests if a specified principal is authorized to perform an AWS IoT action
on a specified resource.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Tests a custom authorization behavior by invoking a specified custom
authorizer.
|
TransferCertificateResult |
transferCertificate(TransferCertificateRequest transferCertificateRequest)
Transfers the specified certificate to the specified AWS account.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an authorizer.
|
void |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
|
void |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate.
|
UpdateEventConfigurationsResult |
updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest)
Updates the event configurations.
|
UpdateIndexingConfigurationResult |
updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest)
Updates the search configuration.
|
UpdateRoleAliasResult |
updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest)
Updates a role alias.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest updateStreamRequest)
Updates an existing stream.
|
UpdateThingResult |
updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
|
UpdateThingGroupResult |
updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest)
Update a thing group.
|
UpdateThingGroupsForThingResult |
updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest)
Updates the groups to which the thing belongs.
|
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 acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the AcceptCertificateTransfer operation.
ResourceNotFoundExceptionTransferAlreadyCompletedExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest) throws AmazonClientException, AmazonServiceException
Adds a thing to a thing group.
addThingToThingGroupRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest) throws AmazonClientException, AmazonServiceException
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection
field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
associateTargetsWithJobRequest - InvalidRequestExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void attachPolicy(AttachPolicyRequest attachPolicyRequest) throws AmazonClientException, AmazonServiceException
Attaches a policy to the specified target.
attachPolicyRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
attachPrincipalPolicyRequest - The input for the AttachPrincipalPolicy operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException
Attaches the specified principal to the specified thing.
attachThingPrincipalRequest - The input for the AttachThingPrincipal operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the CancelCertificateTransfer operation.
ResourceNotFoundExceptionTransferAlreadyCompletedExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CancelJobResult cancelJob(CancelJobRequest cancelJobRequest) throws AmazonClientException, AmazonServiceException
Cancels a job.
cancelJobRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Cancels the execution of a job for a given thing.
cancelJobExecutionRequest - InvalidRequestExceptionInvalidStateTransitionExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionVersionConflictExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Clears the default authorizer.
clearDefaultAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Creates an authorizer.
createAuthorizerRequest - ResourceAlreadyExistsExceptionInvalidRequestExceptionLimitExceededExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonClientException, AmazonServiceException
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest - The input for the CreateCertificateFromCsr operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateJobResult createJob(CreateJobRequest createJobRequest) throws AmazonClientException, AmazonServiceException
Creates a job.
createJobRequest - InvalidRequestExceptionResourceNotFoundExceptionResourceAlreadyExistsExceptionLimitExceededExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the CreateKeysAndCertificate operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdateRequest - InvalidRequestExceptionResourceNotFoundExceptionResourceAlreadyExistsExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the CreatePolicy operation.
ResourceAlreadyExistsExceptionMalformedPolicyExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the CreatePolicyVersion operation.
ResourceNotFoundExceptionMalformedPolicyExceptionVersionsLimitExceededExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Creates a role alias.
createRoleAliasRequest - ResourceAlreadyExistsExceptionInvalidRequestExceptionLimitExceededExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateStreamResult createStream(CreateStreamRequest createStreamRequest) throws AmazonClientException, AmazonServiceException
Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.
createStreamRequest - InvalidRequestExceptionResourceNotFoundExceptionResourceAlreadyExistsExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonClientException, AmazonServiceException
Creates a thing record in the registry.
createThingRequest - The input for the CreateThing operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceAlreadyExistsExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest) throws AmazonClientException, AmazonServiceException
Create a thing group.
createThingGroupRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest) throws AmazonClientException, AmazonServiceException
Creates a new thing type.
createThingTypeRequest - The input for the CreateThingType operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the CreateTopicRule operation.
SqlParseExceptionInternalExceptionInvalidRequestExceptionResourceAlreadyExistsExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Deletes an authorizer.
deleteAuthorizerRequest - DeleteConflictExceptionResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) throws AmazonClientException, AmazonServiceException
Deletes a registered CA certificate.
deleteCACertificateRequest - Input for the DeleteCACertificate operation.
InvalidRequestExceptionCertificateStateExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the DeleteCertificate operation.
CertificateStateExceptionDeleteConflictExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteJob(DeleteJobRequest deleteJobRequest) throws AmazonClientException, AmazonServiceException
Deletes a job and its related job executions.
Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.
Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
deleteJobRequest - InvalidRequestExceptionInvalidStateTransitionExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Deletes a job execution.
deleteJobExecutionRequest - InvalidRequestExceptionInvalidStateTransitionExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Delete an OTA update.
deleteOTAUpdateRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the DeletePolicy operation.
DeleteConflictExceptionResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the DeletePolicyVersion operation.
DeleteConflictExceptionResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException
Deletes a CA certificate registration code.
deleteRegistrationCodeRequest - The input for the DeleteRegistrationCode operation.
ThrottlingExceptionResourceNotFoundExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Deletes a role alias
deleteRoleAliasRequest - DeleteConflictExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest) throws AmazonClientException, AmazonServiceException
Deletes a stream.
deleteStreamRequest - ResourceNotFoundExceptionDeleteConflictExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified thing.
deleteThingRequest - The input for the DeleteThing operation.
ResourceNotFoundExceptionVersionConflictExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes a thing group.
deleteThingGroupRequest - InvalidRequestExceptionVersionConflictExceptionThrottlingExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
deleteThingTypeRequest - The input for the DeleteThingType operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Deletes the rule.
deleteTopicRuleRequest - The input for the DeleteTopicRule operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionUnauthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException
Deletes a logging level.
deleteV2LoggingLevelRequest - InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws AmazonClientException, AmazonServiceException
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingTypeRequest - The input for the DeprecateThingType operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Describes an authorizer.
describeAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) throws AmazonClientException, AmazonServiceException
Describes a registered CA certificate.
describeCACertificateRequest - The input for the DescribeCACertificate operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified certificate.
describeCertificateRequest - The input for the DescribeCertificate operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Describes the default authorizer.
describeDefaultAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonClientException, AmazonServiceException
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest - The input for the DescribeEndpoint operation.
InternalFailureExceptionInvalidRequestExceptionUnauthorizedExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Describes event configurations.
describeEventConfigurationsRequest - InternalFailureExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest) throws AmazonClientException, AmazonServiceException
Describes a search index.
describeIndexRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeJobResult describeJob(DescribeJobRequest describeJobRequest) throws AmazonClientException, AmazonServiceException
Describes a job.
describeJobRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Describes a job execution.
describeJobExecutionRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Describes a role alias.
describeRoleAliasRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest) throws AmazonClientException, AmazonServiceException
Gets information about a stream.
describeStreamRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified thing.
describeThingRequest - The input for the DescribeThing operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) throws AmazonClientException, AmazonServiceException
Describe a thing group.
describeThingGroupRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Describes a bulk thing provisioning task.
describeThingRegistrationTaskRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified thing type.
describeThingTypeRequest - The input for the DescribeThingType operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void detachPolicy(DetachPolicyRequest detachPolicyRequest) throws AmazonClientException, AmazonServiceException
Detaches a policy from the specified target.
detachPolicyRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicyRequest - The input for the DetachPrincipalPolicy operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException
Detaches the specified principal from the specified thing.
detachThingPrincipalRequest - The input for the DetachThingPrincipal operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Disables the rule.
disableTopicRuleRequest - The input for the DisableTopicRuleRequest operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionUnauthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Enables the rule.
enableTopicRuleRequest - The input for the EnableTopicRuleRequest operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionUnauthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest) throws AmazonClientException, AmazonServiceException
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
getEffectivePoliciesRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException
Gets the search configuration.
getIndexingConfigurationRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest) throws AmazonClientException, AmazonServiceException
Gets a job document.
getJobDocumentRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Gets the logging options.
getLoggingOptionsRequest - The input for the GetLoggingOptions operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Gets an OTA update.
getOTAUpdateRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionServiceUnavailableExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest - The input for the GetPolicy operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified policy version.
getPolicyVersionRequest - The input for the GetPolicyVersion operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest - The input to the GetRegistrationCode operation.
ThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Gets information about the rule.
getTopicRuleRequest - The input for the GetTopicRule operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionUnauthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Gets the fine grained logging options.
getV2LoggingOptionsRequest - InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists the policies attached to the specified thing group.
listAttachedPoliciesRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) throws AmazonClientException, AmazonServiceException
Lists the authorizers registered in your account.
listAuthorizersRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCACertificatesRequest - Input for the ListCACertificates operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCertificatesRequest - The input for the ListCertificates operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) throws AmazonClientException, AmazonServiceException
List the device certificates signed by the specified CA certificate.
listCertificatesByCARequest - The input to the ListCertificatesByCA operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest) throws AmazonClientException, AmazonServiceException
Lists the search indices.
listIndicesRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws AmazonClientException, AmazonServiceException
Lists the job executions for a job.
listJobExecutionsForJobRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws AmazonClientException, AmazonServiceException
Lists the job executions for the specified thing.
listJobExecutionsForThingRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobsResult listJobs(ListJobsRequest listJobsRequest) throws AmazonClientException, AmazonServiceException
Lists jobs.
listJobsRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest) throws AmazonClientException, AmazonServiceException
Lists OTA updates.
listOTAUpdatesRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists certificates that are being transferred but not yet accepted.
listOutgoingCertificatesRequest - The input to the ListOutgoingCertificates operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists your policies.
listPoliciesRequest - The input for the ListPolicies operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws AmazonClientException, AmazonServiceException
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
listPolicyPrincipalsRequest - The input for the ListPolicyPrincipals operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonClientException, AmazonServiceException
Lists the versions of the specified policy and identifies the default version.
listPolicyVersionsRequest - The input for the ListPolicyVersions operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This API is deprecated. Please use ListAttachedPolicies instead.
listPrincipalPoliciesRequest - The input for the ListPrincipalPolicies operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonClientException, AmazonServiceException
Lists the things associated with the specified principal.
listPrincipalThingsRequest - The input for the ListPrincipalThings operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) throws AmazonClientException, AmazonServiceException
Lists the role aliases registered in your account.
listRoleAliasesRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest) throws AmazonClientException, AmazonServiceException
Lists all of the streams in your AWS account.
listStreamsRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws AmazonClientException, AmazonServiceException
List targets for the specified policy.
listTargetsForPolicyRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest) throws AmazonClientException, AmazonServiceException
List the thing groups in your account.
listThingGroupsRequest - InvalidRequestExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException
List the thing groups to which the specified thing belongs.
listThingGroupsForThingRequest - InvalidRequestExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonClientException, AmazonServiceException
Lists the principals associated with the specified thing.
listThingPrincipalsRequest - The input for the ListThingPrincipal operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws AmazonClientException, AmazonServiceException
Information about the thing registration tasks.
listThingRegistrationTaskReportsRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws AmazonClientException, AmazonServiceException
List bulk thing provisioning tasks.
listThingRegistrationTasksRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest) throws AmazonClientException, AmazonServiceException
Lists the existing thing types.
listThingTypesRequest - The input for the ListThingTypes operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonClientException, AmazonServiceException
Lists your things. Use the attributeName and attributeValue
parameters to filter your things. For example, calling
ListThings with attributeName=Color and attributeValue=Red
retrieves all things in the registry that contain an attribute
Color with the value Red.
listThingsRequest - The input for the ListThings operation.
InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws AmazonClientException, AmazonServiceException
Lists the things in the specified group.
listThingsInThingGroupRequest - InvalidRequestExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonClientException, AmazonServiceException
Lists the rules for the specific topic.
listTopicRulesRequest - The input for the ListTopicRules operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws AmazonClientException, AmazonServiceException
Lists logging levels.
listV2LoggingLevelsRequest - InternalExceptionNotConfiguredExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) throws AmazonClientException, AmazonServiceException
Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
registerCACertificateRequest - The input to the RegisterCACertificate operation.
ResourceAlreadyExistsExceptionRegistrationCodeValidationExceptionInvalidRequestExceptionCertificateValidationExceptionThrottlingExceptionLimitExceededExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws AmazonClientException, AmazonServiceException
Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
registerCertificateRequest - The input to the RegisterCertificate operation.
ResourceAlreadyExistsExceptionInvalidRequestExceptionCertificateValidationExceptionCertificateStateExceptionCertificateConflictExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterThingResult registerThing(RegisterThingRequest registerThingRequest) throws AmazonClientException, AmazonServiceException
Provisions a thing.
registerThingRequest - InternalFailureExceptionServiceUnavailableExceptionInvalidRequestExceptionUnauthorizedExceptionThrottlingExceptionConflictingResourceUpdateExceptionResourceRegistrationFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
rejectCertificateTransferRequest - The input for the RejectCertificateTransfer operation.
ResourceNotFoundExceptionTransferAlreadyCompletedExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) throws AmazonClientException, AmazonServiceException
Remove the specified thing from the specified group.
removeThingFromThingGroupRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Replaces the 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 - The input for the ReplaceTopicRule operation.
SqlParseExceptionInternalExceptionInvalidRequestExceptionServiceUnavailableExceptionUnauthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest) throws AmazonClientException, AmazonServiceException
The query search index.
searchIndexRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionInvalidQueryExceptionIndexNotReadyExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
setDefaultAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the SetDefaultPolicyVersion operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Sets the logging options.
setLoggingOptionsRequest - The input for the SetLoggingOptions operation.
InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException
Sets the logging level.
setV2LoggingLevelRequest - InternalExceptionNotConfiguredExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Sets the logging options for the V2 logging service.
setV2LoggingOptionsRequest - InternalExceptionInvalidRequestExceptionServiceUnavailableExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Creates a bulk thing provisioning task.
startThingRegistrationTaskRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Cancels a bulk thing provisioning task.
stopThingRegistrationTaskRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest) throws AmazonClientException, AmazonServiceException
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
testAuthorizationRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
testInvokeAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionInvalidResponseExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the TransferCertificate operation.
InvalidRequestExceptionResourceNotFoundExceptionCertificateStateExceptionTransferConflictExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Updates an authorizer.
updateAuthorizerRequest - ResourceNotFoundExceptionInvalidRequestExceptionLimitExceededExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws AmazonClientException, AmazonServiceException
Updates a registered CA certificate.
updateCACertificateRequest - The input to the UpdateCACertificate operation.
ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonClientException, AmazonServiceException
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 - The input for the UpdateCertificate operation.
ResourceNotFoundExceptionCertificateStateExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Updates the event configurations.
updateEventConfigurationsRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException
Updates the search configuration.
updateIndexingConfigurationRequest - InvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Updates a role alias.
updateRoleAliasRequest - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest) throws AmazonClientException, AmazonServiceException
Updates an existing stream. The stream version will be incremented by one.
updateStreamRequest - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonClientException, AmazonServiceException
Updates the data for a thing.
updateThingRequest - The input for the UpdateThing operation.
InvalidRequestExceptionVersionConflictExceptionThrottlingExceptionUnauthorizedExceptionServiceUnavailableExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) throws AmazonClientException, AmazonServiceException
Update a thing group.
updateThingGroupRequest - InvalidRequestExceptionVersionConflictExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException
Updates the groups to which the thing belongs.
updateThingGroupsForThingRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.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 © 2018. All rights reserved.