public class AWSIotClient extends AmazonWebServiceClient implements 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 | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWS IoT exceptions.
|
client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AWSIotClient()
Deprecated.
|
AWSIotClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials.
|
AWSIotClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials and client configuration options.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider and client configuration
options.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on AWSIot using the
specified AWS account credentials provider, client configuration options
and request metric collector.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
|
AWSIotClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| 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.
|
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)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
GetEffectivePoliciesResult |
getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest)
Gets effective policies.
|
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 |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
|
void |
setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.
|
void |
setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.
|
StartThingRegistrationTaskResult |
startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.
|
StopThingRegistrationTaskResult |
stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.
|
TestAuthorizationResult |
testAuthorization(TestAuthorizationRequest testAuthorizationRequest)
Test custom authorization.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Invoke the specified custom authorizer for testing purposes.
|
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.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
@Deprecated public AWSIotClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSIotClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).DefaultAWSCredentialsProviderChainpublic AWSIotClient(AWSCredentials awsCredentials)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AWSIotClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).requestMetricCollector - optional request metric collectorpublic AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AWSIot (ex: proxy settings, retry
counts, etc.).httpClient - A http clientpublic void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
acceptCertificateTransfer in interface AWSIotacceptCertificateTransferRequest - 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.public AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest) throws AmazonServiceException, AmazonClientException
Adds a thing to a thing group.
addThingToThingGroup in interface AWSIotaddThingToThingGroupRequest - 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.public AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest) throws AmazonServiceException, AmazonClientException
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.
associateTargetsWithJob in interface AWSIotassociateTargetsWithJobRequest - 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.public void attachPolicy(AttachPolicyRequest attachPolicyRequest) throws AmazonServiceException, AmazonClientException
Attaches a policy to the specified target.
attachPolicy in interface AWSIotattachPolicyRequest - 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 public void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
attachPrincipalPolicy in interface AWSIotattachPrincipalPolicyRequest - 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.public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Attaches the specified principal to the specified thing.
attachThingPrincipal in interface AWSIotattachThingPrincipalRequest - 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.public void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
cancelCertificateTransfer in interface AWSIotcancelCertificateTransferRequest - 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.public CancelJobResult cancelJob(CancelJobRequest cancelJobRequest) throws AmazonServiceException, AmazonClientException
Cancels a job.
cancelJob in interface AWSIotcancelJobRequest - 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.public ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Clears the default authorizer.
clearDefaultAuthorizer in interface AWSIotclearDefaultAuthorizerRequest - 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.public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Creates an authorizer.
createAuthorizer in interface AWSIotcreateAuthorizerRequest - 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.public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonServiceException, AmazonClientException
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"
createCertificateFromCsr in interface AWSIotcreateCertificateFromCsrRequest - 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.public CreateJobResult createJob(CreateJobRequest createJobRequest) throws AmazonServiceException, AmazonClientException
Creates a job.
createJob in interface AWSIotcreateJobRequest - 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.public CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonServiceException, AmazonClientException
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificate in interface AWSIotcreateKeysAndCertificateRequest - 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.public CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest) throws AmazonServiceException, AmazonClientException
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdate in interface AWSIotcreateOTAUpdateRequest - 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.public CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonServiceException, AmazonClientException
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
createPolicy in interface AWSIotcreatePolicyRequest - 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.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
createPolicyVersion in interface AWSIotcreatePolicyVersionRequest - 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.public CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) throws AmazonServiceException, AmazonClientException
Creates a role alias.
createRoleAlias in interface AWSIotcreateRoleAliasRequest - 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.public CreateStreamResult createStream(CreateStreamRequest createStreamRequest) throws AmazonServiceException, AmazonClientException
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.
createStream in interface AWSIotcreateStreamRequest - 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.public CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonServiceException, AmazonClientException
Creates a thing record in the registry.
createThing in interface AWSIotcreateThingRequest - 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.public CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest) throws AmazonServiceException, AmazonClientException
Create a thing group.
createThingGroup in interface AWSIotcreateThingGroupRequest - 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.public CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest) throws AmazonServiceException, AmazonClientException
Creates a new thing type.
createThingType in interface AWSIotcreateThingTypeRequest - 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.public void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
createTopicRule in interface AWSIotcreateTopicRuleRequest - 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.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Deletes an authorizer.
deleteAuthorizer in interface AWSIotdeleteAuthorizerRequest - 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.public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) throws AmazonServiceException, AmazonClientException
Deletes a registered CA certificate.
deleteCACertificate in interface AWSIotdeleteCACertificateRequest - 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.public void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificate in interface AWSIotdeleteCertificateRequest - 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.public void deleteJob(DeleteJobRequest deleteJobRequest) throws AmazonServiceException, AmazonClientException
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.
deleteJob in interface AWSIotdeleteJobRequest - 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.public void deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) throws AmazonServiceException, AmazonClientException
Deletes a job execution.
deleteJobExecution in interface AWSIotdeleteJobExecutionRequest - 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.public DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest) throws AmazonServiceException, AmazonClientException
Delete an OTA update.
deleteOTAUpdate in interface AWSIotdeleteOTAUpdateRequest - 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.public void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicy in interface AWSIotdeletePolicyRequest - 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.public void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
deletePolicyVersion in interface AWSIotdeletePolicyVersionRequest - 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.public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws AmazonServiceException, AmazonClientException
Deletes a CA certificate registration code.
deleteRegistrationCode in interface AWSIotdeleteRegistrationCodeRequest - 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.public DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) throws AmazonServiceException, AmazonClientException
Deletes a role alias
deleteRoleAlias in interface AWSIotdeleteRoleAliasRequest - 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.public DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest) throws AmazonServiceException, AmazonClientException
Deletes a stream.
deleteStream in interface AWSIotdeleteStreamRequest - 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.public DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified thing.
deleteThing in interface AWSIotdeleteThingRequest - 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.public DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a thing group.
deleteThingGroup in interface AWSIotdeleteThingGroupRequest - 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.public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws AmazonServiceException, AmazonClientException
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.
deleteThingType in interface AWSIotdeleteThingTypeRequest - 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.public void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Deletes the rule.
deleteTopicRule in interface AWSIotdeleteTopicRuleRequest - 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.public void deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) throws AmazonServiceException, AmazonClientException
Deletes a logging level.
deleteV2LoggingLevel in interface AWSIotdeleteV2LoggingLevelRequest - 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.public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws AmazonServiceException, AmazonClientException
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingType in interface AWSIotdeprecateThingTypeRequest - 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.public DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Describes an authorizer.
describeAuthorizer in interface AWSIotdescribeAuthorizerRequest - 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.public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) throws AmazonServiceException, AmazonClientException
Describes a registered CA certificate.
describeCACertificate in interface AWSIotdescribeCACertificateRequest - 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.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified certificate.
describeCertificate in interface AWSIotdescribeCertificateRequest - 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.public DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Describes the default authorizer.
describeDefaultAuthorizer in interface AWSIotdescribeDefaultAuthorizerRequest - 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.public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonServiceException, AmazonClientException
Returns a unique endpoint specific to the AWS account making the call.
describeEndpoint in interface AWSIotdescribeEndpointRequest - 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.public DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) throws AmazonServiceException, AmazonClientException
Describes event configurations.
describeEventConfigurations in interface AWSIotdescribeEventConfigurationsRequest - 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.public DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest) throws AmazonServiceException, AmazonClientException
Describes a search index.
describeIndex in interface AWSIotdescribeIndexRequest - 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.public DescribeJobResult describeJob(DescribeJobRequest describeJobRequest) throws AmazonServiceException, AmazonClientException
Describes a job.
describeJob in interface AWSIotdescribeJobRequest - 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.public DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) throws AmazonServiceException, AmazonClientException
Describes a job execution.
describeJobExecution in interface AWSIotdescribeJobExecutionRequest - 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.public DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) throws AmazonServiceException, AmazonClientException
Describes a role alias.
describeRoleAlias in interface AWSIotdescribeRoleAliasRequest - 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.public DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest) throws AmazonServiceException, AmazonClientException
Gets information about a stream.
describeStream in interface AWSIotdescribeStreamRequest - 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.public DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified thing.
describeThing in interface AWSIotdescribeThingRequest - 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.public DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) throws AmazonServiceException, AmazonClientException
Describe a thing group.
describeThingGroup in interface AWSIotdescribeThingGroupRequest - 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.public DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) throws AmazonServiceException, AmazonClientException
Describes a bulk thing provisioning task.
describeThingRegistrationTask in interface AWSIotdescribeThingRegistrationTaskRequest - 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.public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified thing type.
describeThingType in interface AWSIotdescribeThingTypeRequest - 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.public void detachPolicy(DetachPolicyRequest detachPolicyRequest) throws AmazonServiceException, AmazonClientException
Detaches a policy from the specified target.
detachPolicy in interface AWSIotdetachPolicyRequest - 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 public void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonServiceException, AmazonClientException
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicy in interface AWSIotdetachPrincipalPolicyRequest - 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.public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonServiceException, AmazonClientException
Detaches the specified principal from the specified thing.
detachThingPrincipal in interface AWSIotdetachThingPrincipalRequest - 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.public void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Disables the rule.
disableTopicRule in interface AWSIotdisableTopicRuleRequest - 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.public void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Enables the rule.
enableTopicRule in interface AWSIotenableTopicRuleRequest - 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.public GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest) throws AmazonServiceException, AmazonClientException
Gets effective policies.
getEffectivePolicies in interface AWSIotgetEffectivePoliciesRequest - 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.public GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest) throws AmazonServiceException, AmazonClientException
Gets the search configuration.
getIndexingConfiguration in interface AWSIotgetIndexingConfigurationRequest - 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.public GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest) throws AmazonServiceException, AmazonClientException
Gets a job document.
getJobDocument in interface AWSIotgetJobDocumentRequest - 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.public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Gets the logging options.
getLoggingOptions in interface AWSIotgetLoggingOptionsRequest - 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.public GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest) throws AmazonServiceException, AmazonClientException
Gets an OTA update.
getOTAUpdate in interface AWSIotgetOTAUpdateRequest - 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.public GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy with the policy document of the default version.
getPolicy in interface AWSIotgetPolicyRequest - 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.public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Gets information about the specified policy version.
getPolicyVersion in interface AWSIotgetPolicyVersionRequest - 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.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws AmazonServiceException, AmazonClientException
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCode in interface AWSIotgetRegistrationCodeRequest - 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.public GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonServiceException, AmazonClientException
Gets information about the rule.
getTopicRule in interface AWSIotgetTopicRuleRequest - 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.public GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Gets the fine grained logging options.
getV2LoggingOptions in interface AWSIotgetV2LoggingOptionsRequest - 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.public ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists the policies attached to the specified thing group.
listAttachedPolicies in interface AWSIotlistAttachedPoliciesRequest - 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.public ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) throws AmazonServiceException, AmazonClientException
Lists the authorizers registered in your account.
listAuthorizers in interface AWSIotlistAuthorizersRequest - 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.public ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws AmazonServiceException, AmazonClientException
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.
listCACertificates in interface AWSIotlistCACertificatesRequest - 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.public ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonServiceException, AmazonClientException
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.
listCertificates in interface AWSIotlistCertificatesRequest - 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.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) throws AmazonServiceException, AmazonClientException
List the device certificates signed by the specified CA certificate.
listCertificatesByCA in interface AWSIotlistCertificatesByCARequest - 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.public ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest) throws AmazonServiceException, AmazonClientException
Lists the search indices.
listIndices in interface AWSIotlistIndicesRequest - 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.public ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws AmazonServiceException, AmazonClientException
Lists the job executions for a job.
listJobExecutionsForJob in interface AWSIotlistJobExecutionsForJobRequest - 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.public ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws AmazonServiceException, AmazonClientException
Lists the job executions for the specified thing.
listJobExecutionsForThing in interface AWSIotlistJobExecutionsForThingRequest - 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.public ListJobsResult listJobs(ListJobsRequest listJobsRequest) throws AmazonServiceException, AmazonClientException
Lists jobs.
listJobs in interface AWSIotlistJobsRequest - 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.public ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest) throws AmazonServiceException, AmazonClientException
Lists OTA updates.
listOTAUpdates in interface AWSIotlistOTAUpdatesRequest - 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.public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws AmazonServiceException, AmazonClientException
Lists certificates that are being transferred but not yet accepted.
listOutgoingCertificates in interface AWSIotlistOutgoingCertificatesRequest - 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.public ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists your policies.
listPolicies in interface AWSIotlistPoliciesRequest - 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 public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws AmazonServiceException, AmazonClientException
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
listPolicyPrincipals in interface AWSIotlistPolicyPrincipalsRequest - 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.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonServiceException, AmazonClientException
Lists the versions of the specified policy and identifies the default version.
listPolicyVersions in interface AWSIotlistPolicyVersionsRequest - 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 public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This API is deprecated. Please use ListAttachedPolicies instead.
listPrincipalPolicies in interface AWSIotlistPrincipalPoliciesRequest - 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.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonServiceException, AmazonClientException
Lists the things associated with the specified principal.
listPrincipalThings in interface AWSIotlistPrincipalThingsRequest - 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.public ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) throws AmazonServiceException, AmazonClientException
Lists the role aliases registered in your account.
listRoleAliases in interface AWSIotlistRoleAliasesRequest - 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.public ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest) throws AmazonServiceException, AmazonClientException
Lists all of the streams in your AWS account.
listStreams in interface AWSIotlistStreamsRequest - 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.public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws AmazonServiceException, AmazonClientException
List targets for the specified policy.
listTargetsForPolicy in interface AWSIotlistTargetsForPolicyRequest - 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.public ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest) throws AmazonServiceException, AmazonClientException
List the thing groups in your account.
listThingGroups in interface AWSIotlistThingGroupsRequest - 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.public ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws AmazonServiceException, AmazonClientException
List the thing groups to which the specified thing belongs.
listThingGroupsForThing in interface AWSIotlistThingGroupsForThingRequest - 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.public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonServiceException, AmazonClientException
Lists the principals associated with the specified thing.
listThingPrincipals in interface AWSIotlistThingPrincipalsRequest - 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.public ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws AmazonServiceException, AmazonClientException
Information about the thing registration tasks.
listThingRegistrationTaskReports in interface AWSIotlistThingRegistrationTaskReportsRequest - 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.public ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws AmazonServiceException, AmazonClientException
List bulk thing provisioning tasks.
listThingRegistrationTasks in interface AWSIotlistThingRegistrationTasksRequest - 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.public ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest) throws AmazonServiceException, AmazonClientException
Lists the existing thing types.
listThingTypes in interface AWSIotlistThingTypesRequest - 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.public ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonServiceException, AmazonClientException
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.
listThings in interface AWSIotlistThingsRequest - 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.public ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws AmazonServiceException, AmazonClientException
Lists the things in the specified group.
listThingsInThingGroup in interface AWSIotlistThingsInThingGroupRequest - 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.public ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonServiceException, AmazonClientException
Lists the rules for the specific topic.
listTopicRules in interface AWSIotlistTopicRulesRequest - 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.public ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws AmazonServiceException, AmazonClientException
Lists logging levels.
listV2LoggingLevels in interface AWSIotlistV2LoggingLevelsRequest - 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.public RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) throws AmazonServiceException, AmazonClientException
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.
registerCACertificate in interface AWSIotregisterCACertificateRequest - 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.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws AmazonServiceException, AmazonClientException
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.
registerCertificate in interface AWSIotregisterCertificateRequest - 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.public RegisterThingResult registerThing(RegisterThingRequest registerThingRequest) throws AmazonServiceException, AmazonClientException
Provisions a thing.
registerThing in interface AWSIotregisterThingRequest - 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.public void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonServiceException, AmazonClientException
Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_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.
rejectCertificateTransfer in interface AWSIotrejectCertificateTransferRequest - 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.public RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) throws AmazonServiceException, AmazonClientException
Remove the specified thing from the specified group.
removeThingFromThingGroup in interface AWSIotremoveThingFromThingGroupRequest - 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.public void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonServiceException, AmazonClientException
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.
replaceTopicRule in interface AWSIotreplaceTopicRuleRequest - 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.public SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest) throws AmazonServiceException, AmazonClientException
The query search index.
searchIndex in interface AWSIotsearchIndexRequest - 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.public SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
setDefaultAuthorizer in interface AWSIotsetDefaultAuthorizerRequest - 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.public void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonServiceException, AmazonClientException
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
setDefaultPolicyVersion in interface AWSIotsetDefaultPolicyVersionRequest - 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.public void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Sets the logging options.
setLoggingOptions in interface AWSIotsetLoggingOptionsRequest - 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.public void setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) throws AmazonServiceException, AmazonClientException
Sets the logging level.
setV2LoggingLevel in interface AWSIotsetV2LoggingLevelRequest - 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.public void setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) throws AmazonServiceException, AmazonClientException
Sets the logging options for the V2 logging service.
setV2LoggingOptions in interface AWSIotsetV2LoggingOptionsRequest - 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.public StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) throws AmazonServiceException, AmazonClientException
Creates a bulk thing provisioning task.
startThingRegistrationTask in interface AWSIotstartThingRegistrationTaskRequest - 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.public StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) throws AmazonServiceException, AmazonClientException
Cancels a bulk thing provisioning task.
stopThingRegistrationTask in interface AWSIotstopThingRegistrationTaskRequest - 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.public TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest) throws AmazonServiceException, AmazonClientException
Test custom authorization.
testAuthorization in interface AWSIottestAuthorizationRequest - 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.public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Invoke the specified custom authorizer for testing purposes.
testInvokeAuthorizer in interface AWSIottestInvokeAuthorizerRequest - 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.public TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest) throws AmazonServiceException, AmazonClientException
Transfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
transferCertificate in interface AWSIottransferCertificateRequest - 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.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws AmazonServiceException, AmazonClientException
Updates an authorizer.
updateAuthorizer in interface AWSIotupdateAuthorizerRequest - 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.public void updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws AmazonServiceException, AmazonClientException
Updates a registered CA certificate.
updateCACertificate in interface AWSIotupdateCACertificateRequest - 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.public void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonServiceException, AmazonClientException
Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
updateCertificate in interface AWSIotupdateCertificateRequest - 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.public UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) throws AmazonServiceException, AmazonClientException
Updates the event configurations.
updateEventConfigurations in interface AWSIotupdateEventConfigurationsRequest - 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.public UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) throws AmazonServiceException, AmazonClientException
Updates the search configuration.
updateIndexingConfiguration in interface AWSIotupdateIndexingConfigurationRequest - 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.public UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) throws AmazonServiceException, AmazonClientException
Updates a role alias.
updateRoleAlias in interface AWSIotupdateRoleAliasRequest - 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.public UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest) throws AmazonServiceException, AmazonClientException
Updates an existing stream. The stream version will be incremented by one.
updateStream in interface AWSIotupdateStreamRequest - 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.public UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonServiceException, AmazonClientException
Updates the data for a thing.
updateThing in interface AWSIotupdateThingRequest - 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.public UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) throws AmazonServiceException, AmazonClientException
Update a thing group.
updateThingGroup in interface AWSIotupdateThingGroupRequest - 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.public UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) throws AmazonServiceException, AmazonClientException
Updates the groups to which the thing belongs.
updateThingGroupsForThing in interface AWSIotupdateThingGroupsForThingRequest - 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.@Deprecated public 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 the request.
getCachedResponseMetadata in interface AWSIotrequest - The originally executed requestCopyright © 2018. All rights reserved.