@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSIotClient()
Deprecated.
|
AWSIotClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSIotClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSIotClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSIotClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSIotClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AWSIotClient()
AWSIotClientBuilder.defaultClient()
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)
AwsClientBuilder.withClientConfiguration(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 AWS IoT (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSIotClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSIotClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AWSIotClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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 AWS IoT (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
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.@Deprecated public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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 AWS IoT (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSIotClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 AWS IoT (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSIotClientBuilder builder()
public AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest request)
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 AWSIot
acceptCertificateTransferRequest
- The input for the AcceptCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest request)
Adds a thing to a billing group.
addThingToBillingGroup
in interface AWSIot
addThingToBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest request)
Adds a thing to a thing group.
addThingToThingGroup
in interface AWSIot
addThingToThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest request)
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 AWSIot
associateTargetsWithJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
Attaches a policy to the specified target.
attachPolicy
in interface AWSIot
attachPolicyRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.@Deprecated public AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest request)
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
attachPrincipalPolicy
in interface AWSIot
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest request)
Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
attachSecurityProfile
in interface AWSIot
attachSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest request)
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
attachThingPrincipal
in interface AWSIot
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest request)
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
cancelAuditMitigationActionsTask
in interface AWSIot
cancelAuditMitigationActionsTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest request)
Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
cancelAuditTask
in interface AWSIot
cancelAuditTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest request)
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 AWSIot
cancelCertificateTransferRequest
- The input for the CancelCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CancelJobResult cancelJob(CancelJobRequest request)
Cancels a job.
cancelJob
in interface AWSIot
cancelJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest request)
Cancels the execution of a job for a given thing.
cancelJobExecution
in interface AWSIot
cancelJobExecutionRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.public ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest request)
Clears the default authorizer.
clearDefaultAuthorizer
in interface AWSIot
clearDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ConfirmTopicRuleDestinationResult confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest request)
Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation
message to the endpoint or base address you specify. The message includes a token which you pass back when
calling ConfirmTopicRuleDestination
to confirm that you own or have access to the endpoint.
confirmTopicRuleDestination
in interface AWSIot
confirmTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
Creates an authorizer.
createAuthorizer
in interface AWSIot
createAuthorizerRequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest request)
Creates a billing group.
createBillingGroup
in interface AWSIot
createBillingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest request)
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 AWSIot
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest request)
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
createDomainConfiguration
in interface AWSIot
createDomainConfigurationRequest
- LimitExceededException
- A limit has been exceeded.CertificateValidationException
- The certificate is invalid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.public CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest request)
Creates a dynamic thing group.
createDynamicThingGroup
in interface AWSIot
createDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.InvalidQueryException
- The query is invalid.LimitExceededException
- A limit has been exceeded.public CreateJobResult createJob(CreateJobRequest request)
Creates a job.
createJob
in interface AWSIot
createJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest request)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT API.
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 AWSIot
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest request)
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.
createMitigationAction
in interface AWSIot
createMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest request)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdate
in interface AWSIot
createOTAUpdateRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.public CreatePolicyResult createPolicy(CreatePolicyRequest request)
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 AWSIot
createPolicyRequest
- The input for the CreatePolicy operation.ResourceAlreadyExistsException
- The resource already exists.MalformedPolicyException
- The policy documentation is not valid.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)
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 AWSIot
createPolicyVersionRequest
- The input for the CreatePolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.MalformedPolicyException
- The policy documentation is not valid.VersionsLimitExceededException
- The number of policy versions exceeds the limit.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest request)
Creates a provisioning claim.
createProvisioningClaim
in interface AWSIot
createProvisioningClaimRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest request)
Creates a fleet provisioning template.
createProvisioningTemplate
in interface AWSIot
createProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ResourceAlreadyExistsException
- The resource already exists.public CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest request)
Creates a new version of a fleet provisioning template.
createProvisioningTemplateVersion
in interface AWSIot
createProvisioningTemplateVersionRequest
- VersionsLimitExceededException
- The number of policy versions exceeds the limit.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest request)
Creates a role alias.
createRoleAlias
in interface AWSIot
createRoleAliasRequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest request)
Creates a scheduled audit that is run at a specified time interval.
createScheduledAudit
in interface AWSIot
createScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
Creates a Device Defender security profile.
createSecurityProfile
in interface AWSIot
createSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CreateStreamResult createStream(CreateStreamRequest request)
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.
createStream
in interface AWSIot
createStreamRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public CreateThingResult createThing(CreateThingRequest request)
Creates a thing record in the registry. If this call is made multiple times using the same thing name and
configuration, the call will succeed. If this call is made with the same thing name but different configuration a
ResourceAlreadyExistsException
is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
createThing
in interface AWSIot
createThingRequest
- The input for the CreateThing operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.public CreateThingGroupResult createThingGroup(CreateThingGroupRequest request)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
createThingGroup
in interface AWSIot
createThingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CreateThingTypeResult createThingType(CreateThingTypeRequest request)
Creates a new thing type.
createThingType
in interface AWSIot
createThingTypeRequest
- The input for the CreateThingType operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.public CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest request)
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 AWSIot
createTopicRuleRequest
- The input for the CreateTopicRule operation.SqlParseException
- The Rule-SQL expression can't be parsed correctly.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest request)
Creates a topic rule destination. The destination must be confirmed prior to use.
createTopicRuleDestination
in interface AWSIot
createTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest request)
Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
deleteAccountAuditConfiguration
in interface AWSIot
deleteAccountAuditConfigurationRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an authorizer.
deleteAuthorizer
in interface AWSIot
deleteAuthorizerRequest
- DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest request)
Deletes the billing group.
deleteBillingGroup
in interface AWSIot
deleteBillingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest request)
Deletes a registered CA certificate.
deleteCACertificate
in interface AWSIot
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.InvalidRequestException
- The request is not valid.CertificateStateException
- The certificate operation is not allowed.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing 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 AWSIot
deleteCertificateRequest
- The input for the DeleteCertificate operation.CertificateStateException
- The certificate operation is not allowed.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest request)
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
deleteDomainConfiguration
in interface AWSIot
deleteDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.public DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest request)
Deletes a dynamic thing group.
deleteDynamicThingGroup
in interface AWSIot
deleteDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteJobResult deleteJob(DeleteJobRequest request)
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 AWSIot
deleteJobRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public DeleteJobExecutionResult deleteJobExecution(DeleteJobExecutionRequest request)
Deletes a job execution.
deleteJobExecution
in interface AWSIot
deleteJobExecutionRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest request)
Deletes a defined mitigation action from your AWS account.
deleteMitigationAction
in interface AWSIot
deleteMitigationActionRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest request)
Delete an OTA update.
deleteOTAUpdate
in interface AWSIot
deleteOTAUpdateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
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 AWSIot
deletePolicyRequest
- The input for the DeletePolicy operation.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)
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 AWSIot
deletePolicyVersionRequest
- The input for the DeletePolicyVersion operation.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest request)
Deletes a fleet provisioning template.
deleteProvisioningTemplate
in interface AWSIot
deleteProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.public DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest request)
Deletes a fleet provisioning template version.
deleteProvisioningTemplateVersion
in interface AWSIot
deleteProvisioningTemplateVersionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest request)
Deletes a CA certificate registration code.
deleteRegistrationCode
in interface AWSIot
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest request)
Deletes a role alias
deleteRoleAlias
in interface AWSIot
deleteRoleAliasRequest
- DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest request)
Deletes a scheduled audit.
deleteScheduledAudit
in interface AWSIot
deleteScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
Deletes a Device Defender security profile.
deleteSecurityProfile
in interface AWSIot
deleteSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.public DeleteStreamResult deleteStream(DeleteStreamRequest request)
Deletes a stream.
deleteStream
in interface AWSIot
deleteStreamRequest
- ResourceNotFoundException
- The specified resource does not exist.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteThingResult deleteThing(DeleteThingRequest request)
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
deleteThing
in interface AWSIot
deleteThingRequest
- The input for the DeleteThing operation.ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest request)
Deletes a thing group.
deleteThingGroup
in interface AWSIot
deleteThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest request)
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 AWSIot
deleteThingTypeRequest
- The input for the DeleteThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest request)
Deletes the rule.
deleteTopicRule
in interface AWSIot
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest request)
Deletes a topic rule destination.
deleteTopicRuleDestination
in interface AWSIot
deleteTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest request)
Deletes a logging level.
deleteV2LoggingLevel
in interface AWSIot
deleteV2LoggingLevelRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest request)
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingType
in interface AWSIot
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest request)
Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
describeAccountAuditConfiguration
in interface AWSIot
describeAccountAuditConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest request)
Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
describeAuditFinding
in interface AWSIot
describeAuditFindingRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest request)
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
describeAuditMitigationActionsTask
in interface AWSIot
describeAuditMitigationActionsTaskRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest request)
Gets information about a Device Defender audit.
describeAuditTask
in interface AWSIot
describeAuditTaskRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest request)
Describes an authorizer.
describeAuthorizer
in interface AWSIot
describeAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest request)
Returns information about a billing group.
describeBillingGroup
in interface AWSIot
describeBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest request)
Describes a registered CA certificate.
describeCACertificate
in interface AWSIot
describeCACertificateRequest
- The input for the DescribeCACertificate operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
Gets information about the specified certificate.
describeCertificate
in interface AWSIot
describeCertificateRequest
- The input for the DescribeCertificate operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest request)
Describes the default authorizer.
describeDefaultAuthorizer
in interface AWSIot
describeDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest request)
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
describeDomainConfiguration
in interface AWSIot
describeDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
Returns a unique endpoint specific to the AWS account making the call.
describeEndpoint
in interface AWSIot
describeEndpointRequest
- The input for the DescribeEndpoint operation.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.public DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest request)
Describes event configurations.
describeEventConfigurations
in interface AWSIot
describeEventConfigurationsRequest
- InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.public DescribeIndexResult describeIndex(DescribeIndexRequest request)
Describes a search index.
describeIndex
in interface AWSIot
describeIndexRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeJobResult describeJob(DescribeJobRequest request)
Describes a job.
describeJob
in interface AWSIot
describeJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest request)
Describes a job execution.
describeJobExecution
in interface AWSIot
describeJobExecutionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest request)
Gets information about a mitigation action.
describeMitigationAction
in interface AWSIot
describeMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest request)
Returns information about a fleet provisioning template.
describeProvisioningTemplate
in interface AWSIot
describeProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.public DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest request)
Returns information about a fleet provisioning template version.
describeProvisioningTemplateVersion
in interface AWSIot
describeProvisioningTemplateVersionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.public DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest request)
Describes a role alias.
describeRoleAlias
in interface AWSIot
describeRoleAliasRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest request)
Gets information about a scheduled audit.
describeScheduledAudit
in interface AWSIot
describeScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
Gets information about a Device Defender security profile.
describeSecurityProfile
in interface AWSIot
describeSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DescribeStreamResult describeStream(DescribeStreamRequest request)
Gets information about a stream.
describeStream
in interface AWSIot
describeStreamRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeThingResult describeThing(DescribeThingRequest request)
Gets information about the specified thing.
describeThing
in interface AWSIot
describeThingRequest
- The input for the DescribeThing operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest request)
Describe a thing group.
describeThingGroup
in interface AWSIot
describeThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest request)
Describes a bulk thing provisioning task.
describeThingRegistrationTask
in interface AWSIot
describeThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest request)
Gets information about the specified thing type.
describeThingType
in interface AWSIot
describeThingTypeRequest
- The input for the DescribeThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
Detaches a policy from the specified target.
detachPolicy
in interface AWSIot
detachPolicyRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.@Deprecated public DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest request)
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicy
in interface AWSIot
detachPrincipalPolicyRequest
- The input for the DetachPrincipalPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest request)
Disassociates a Device Defender security profile from a thing group or from this account.
detachSecurityProfile
in interface AWSIot
detachSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest request)
Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
detachThingPrincipal
in interface AWSIot
detachThingPrincipalRequest
- The input for the DetachThingPrincipal operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest request)
Disables the rule.
disableTopicRule
in interface AWSIot
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest request)
Enables the rule.
enableTopicRule
in interface AWSIot
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public GetCardinalityResult getCardinality(GetCardinalityRequest request)
Returns the approximate count of unique values that match the query.
getCardinality
in interface AWSIot
getCardinalityRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.public GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest request)
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
getEffectivePolicies
in interface AWSIot
getEffectivePoliciesRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest request)
Gets the indexing configuration.
getIndexingConfiguration
in interface AWSIot
getIndexingConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public GetJobDocumentResult getJobDocument(GetJobDocumentRequest request)
Gets a job document.
getJobDocument
in interface AWSIot
getJobDocumentRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions
instead.
getLoggingOptions
in interface AWSIot
getLoggingOptionsRequest
- The input for the GetLoggingOptions operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest request)
Gets an OTA update.
getOTAUpdate
in interface AWSIot
getOTAUpdateRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.ResourceNotFoundException
- The specified resource does not exist.public GetPercentilesResult getPercentiles(GetPercentilesRequest request)
Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles
. This
function returns a value for each percentile group specified (or the default percentile groupings). The
percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation, the more values that
match the query, the more accurate the percentile values.
getPercentiles
in interface AWSIot
getPercentilesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.public GetPolicyResult getPolicy(GetPolicyRequest request)
Gets information about the specified policy with the policy document of the default version.
getPolicy
in interface AWSIot
getPolicyRequest
- The input for the GetPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)
Gets information about the specified policy version.
getPolicyVersion
in interface AWSIot
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest request)
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCode
in interface AWSIot
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.public GetStatisticsResult getStatistics(GetStatisticsRequest request)
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the
specified aggregated field. If the aggregation field is of type String
, only the count statistic is
returned.
getStatistics
in interface AWSIot
getStatisticsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.public GetTopicRuleResult getTopicRule(GetTopicRuleRequest request)
Gets information about the rule.
getTopicRule
in interface AWSIot
getTopicRuleRequest
- The input for the GetTopicRule operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.public GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest request)
Gets information about a topic rule destination.
getTopicRuleDestination
in interface AWSIot
getTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.public GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest request)
Gets the fine grained logging options.
getV2LoggingOptions
in interface AWSIot
getV2LoggingOptionsRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.ServiceUnavailableException
- The service is temporarily unavailable.public ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest request)
Lists the active violations for a given Device Defender security profile.
listActiveViolations
in interface AWSIot
listActiveViolationsRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest request)
Lists the policies attached to the specified thing group.
listAttachedPolicies
in interface AWSIot
listAttachedPoliciesRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest request)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
listAuditFindings
in interface AWSIot
listAuditFindingsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest request)
Gets the status of audit mitigation action tasks that were executed.
listAuditMitigationActionsExecutions
in interface AWSIot
listAuditMitigationActionsExecutionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest request)
Gets a list of audit mitigation action tasks that match the specified filters.
listAuditMitigationActionsTasks
in interface AWSIot
listAuditMitigationActionsTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAuditTasksResult listAuditTasks(ListAuditTasksRequest request)
Lists the Device Defender audits that have been performed during a given time period.
listAuditTasks
in interface AWSIot
listAuditTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAuthorizersResult listAuthorizers(ListAuthorizersRequest request)
Lists the authorizers registered in your account.
listAuthorizers
in interface AWSIot
listAuthorizersRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest request)
Lists the billing groups you have created.
listBillingGroups
in interface AWSIot
listBillingGroupsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.public ListCACertificatesResult listCACertificates(ListCACertificatesRequest request)
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 AWSIot
listCACertificatesRequest
- Input for the ListCACertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
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 AWSIot
listCertificatesRequest
- The input for the ListCertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest request)
List the device certificates signed by the specified CA certificate.
listCertificatesByCA
in interface AWSIot
listCertificatesByCARequest
- The input to the ListCertificatesByCA operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest request)
Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
The domain configuration feature is in public preview and is subject to change.
listDomainConfigurations
in interface AWSIot
listDomainConfigurationsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListIndicesResult listIndices(ListIndicesRequest request)
Lists the search indices.
listIndices
in interface AWSIot
listIndicesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest request)
Lists the job executions for a job.
listJobExecutionsForJob
in interface AWSIot
listJobExecutionsForJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest request)
Lists the job executions for the specified thing.
listJobExecutionsForThing
in interface AWSIot
listJobExecutionsForThingRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public ListJobsResult listJobs(ListJobsRequest request)
Lists jobs.
listJobs
in interface AWSIot
listJobsRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest request)
Gets a list of all mitigation actions that match the specified filter criteria.
listMitigationActions
in interface AWSIot
listMitigationActionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest request)
Lists OTA updates.
listOTAUpdates
in interface AWSIot
listOTAUpdatesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest request)
Lists certificates that are being transferred but not yet accepted.
listOutgoingCertificates
in interface AWSIot
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
Lists your policies.
listPolicies
in interface AWSIot
listPoliciesRequest
- The input for the ListPolicies operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.@Deprecated public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest request)
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
listPolicyPrincipals
in interface AWSIot
listPolicyPrincipalsRequest
- The input for the ListPolicyPrincipals operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)
Lists the versions of the specified policy and identifies the default version.
listPolicyVersions
in interface AWSIot
listPolicyVersionsRequest
- The input for the ListPolicyVersions operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.@Deprecated public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest request)
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 AWSIot
listPrincipalPoliciesRequest
- The input for the ListPrincipalPolicies operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest request)
Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
listPrincipalThings
in interface AWSIot
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest request)
A list of fleet provisioning template versions.
listProvisioningTemplateVersions
in interface AWSIot
listProvisioningTemplateVersionsRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.public ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest request)
Lists the fleet provisioning templates in your AWS account.
listProvisioningTemplates
in interface AWSIot
listProvisioningTemplatesRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.public ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest request)
Lists the role aliases registered in your account.
listRoleAliases
in interface AWSIot
listRoleAliasesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest request)
Lists all of your scheduled audits.
listScheduledAudits
in interface AWSIot
listScheduledAuditsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
listSecurityProfiles
in interface AWSIot
listSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest request)
Lists the Device Defender security profiles attached to a target (thing group).
listSecurityProfilesForTarget
in interface AWSIot
listSecurityProfilesForTargetRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListStreamsResult listStreams(ListStreamsRequest request)
Lists all of the streams in your AWS account.
listStreams
in interface AWSIot
listStreamsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags (metadata) you have assigned to the resource.
listTagsForResource
in interface AWSIot
listTagsForResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
List targets for the specified policy.
listTargetsForPolicy
in interface AWSIot
listTargetsForPolicyRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest request)
Lists the targets (thing groups) associated with a given Device Defender security profile.
listTargetsForSecurityProfile
in interface AWSIot
listTargetsForSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListThingGroupsResult listThingGroups(ListThingGroupsRequest request)
List the thing groups in your account.
listThingGroups
in interface AWSIot
listThingGroupsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest request)
List the thing groups to which the specified thing belongs.
listThingGroupsForThing
in interface AWSIot
listThingGroupsForThingRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest request)
Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
listThingPrincipals
in interface AWSIot
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest request)
Information about the thing registration tasks.
listThingRegistrationTaskReports
in interface AWSIot
listThingRegistrationTaskReportsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.public ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest request)
List bulk thing provisioning tasks.
listThingRegistrationTasks
in interface AWSIot
listThingRegistrationTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.public ListThingTypesResult listThingTypes(ListThingTypesRequest request)
Lists the existing thing types.
listThingTypes
in interface AWSIot
listThingTypesRequest
- The input for the ListThingTypes operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListThingsResult listThings(ListThingsRequest request)
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 AWSIot
listThingsRequest
- The input for the ListThings operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest request)
Lists the things you have added to the given billing group.
listThingsInBillingGroup
in interface AWSIot
listThingsInBillingGroupRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.public ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest request)
Lists the things in the specified group.
listThingsInThingGroup
in interface AWSIot
listThingsInThingGroupRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest request)
Lists all the topic rule destinations in your AWS account.
listTopicRuleDestinations
in interface AWSIot
listTopicRuleDestinationsRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.public ListTopicRulesResult listTopicRules(ListTopicRulesRequest request)
Lists the rules for the specific topic.
listTopicRules
in interface AWSIot
listTopicRulesRequest
- The input for the ListTopicRules operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest request)
Lists logging levels.
listV2LoggingLevels
in interface AWSIot
listV2LoggingLevelsRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public ListViolationEventsResult listViolationEvents(ListViolationEventsRequest request)
Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
listViolationEvents
in interface AWSIot
listViolationEventsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest request)
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 AWSIot
registerCACertificateRequest
- The input to the RegisterCACertificate operation.ResourceAlreadyExistsException
- The resource already exists.RegistrationCodeValidationException
- The registration code is invalid.InvalidRequestException
- The request is not valid.CertificateValidationException
- The certificate is invalid.ThrottlingException
- The rate exceeds the limit.LimitExceededException
- A limit has been exceeded.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
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 AWSIot
registerCertificateRequest
- The input to the RegisterCertificate operation.ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.CertificateValidationException
- The certificate is invalid.CertificateStateException
- The certificate operation is not allowed.CertificateConflictException
- Unable to verify the CA certificate used to sign the device certificate you are attempting to register.
This is happens when you have registered more than one CA certificate that has the same subject field and
public key.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public RegisterThingResult registerThing(RegisterThingRequest request)
Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
registerThing
in interface AWSIot
registerThingRequest
- InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.ResourceRegistrationFailureException
- The resource registration failed.public RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest request)
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 AWSIot
rejectCertificateTransferRequest
- The input for the RejectCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest request)
Removes the given thing from the billing group.
removeThingFromBillingGroup
in interface AWSIot
removeThingFromBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest request)
Remove the specified thing from the specified group.
removeThingFromThingGroup
in interface AWSIot
removeThingFromThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest request)
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 AWSIot
replaceTopicRuleRequest
- The input for the ReplaceTopicRule operation.SqlParseException
- The Rule-SQL expression can't be parsed correctly.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public SearchIndexResult searchIndex(SearchIndexRequest request)
The query search index.
searchIndex
in interface AWSIot
searchIndexRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.IndexNotReadyException
- The index is not ready.public SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest request)
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
setDefaultAuthorizer
in interface AWSIot
setDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
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 AWSIot
setDefaultPolicyVersionRequest
- The input for the SetDefaultPolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest request)
Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions
instead.
setLoggingOptions
in interface AWSIot
setLoggingOptionsRequest
- The input for the SetLoggingOptions operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest request)
Sets the logging level.
setV2LoggingLevel
in interface AWSIot
setV2LoggingLevelRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest request)
Sets the logging options for the V2 logging service.
setV2LoggingOptions
in interface AWSIot
setV2LoggingOptionsRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.public StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest request)
Starts a task that applies a set of mitigation actions to the specified target.
startAuditMitigationActionsTask
in interface AWSIot
startAuditMitigationActionsTaskRequest
- InvalidRequestException
- The request is not valid.TaskAlreadyExistsException
- This exception occurs if you attempt to start a task with the same task-id as an existing task but with a
different clientRequestToken.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest request)
Starts an on-demand Device Defender audit.
startOnDemandAuditTask
in interface AWSIot
startOnDemandAuditTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest request)
Creates a bulk thing provisioning task.
startThingRegistrationTask
in interface AWSIot
startThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.public StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest request)
Cancels a bulk thing provisioning task.
stopThingRegistrationTask
in interface AWSIot
stopThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public TagResourceResult tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
tagResource
in interface AWSIot
tagResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.LimitExceededException
- A limit has been exceeded.public TestAuthorizationResult testAuthorization(TestAuthorizationRequest request)
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
testAuthorization
in interface AWSIot
testAuthorizationRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
testInvokeAuthorizer
in interface AWSIot
testInvokeAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidResponseException
- The response is invalid.public TransferCertificateResult transferCertificate(TransferCertificateRequest request)
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 AWSIot
transferCertificateRequest
- The input for the TransferCertificate operation.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.CertificateStateException
- The certificate operation is not allowed.TransferConflictException
- You can't transfer the certificate because authorization policies are still attached.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the given tags (metadata) from the resource.
untagResource
in interface AWSIot
untagResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.public UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest request)
Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
updateAccountAuditConfiguration
in interface AWSIot
updateAccountAuditConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
Updates an authorizer.
updateAuthorizer
in interface AWSIot
updateAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest request)
Updates information about the billing group.
updateBillingGroup
in interface AWSIot
updateBillingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest request)
Updates a registered CA certificate.
updateCACertificate
in interface AWSIot
updateCACertificateRequest
- The input to the UpdateCACertificate operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
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 AWSIot
updateCertificateRequest
- The input for the UpdateCertificate operation.ResourceNotFoundException
- The specified resource does not exist.CertificateStateException
- The certificate operation is not allowed.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest request)
Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
The domain configuration feature is in public preview and is subject to change.
updateDomainConfiguration
in interface AWSIot
updateDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.CertificateValidationException
- The certificate is invalid.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest request)
Updates a dynamic thing group.
updateDynamicThingGroup
in interface AWSIot
updateDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.public UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest request)
Updates the event configurations.
updateEventConfigurations
in interface AWSIot
updateEventConfigurationsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.public UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest request)
Updates the search configuration.
updateIndexingConfiguration
in interface AWSIot
updateIndexingConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateJobResult updateJob(UpdateJobRequest request)
Updates supported fields of the specified job.
updateJob
in interface AWSIot
updateJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.public UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest request)
Updates the definition for the specified mitigation action.
updateMitigationAction
in interface AWSIot
updateMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest request)
Updates a fleet provisioning template.
updateProvisioningTemplate
in interface AWSIot
updateProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest request)
Updates a role alias.
updateRoleAlias
in interface AWSIot
updateRoleAliasRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest request)
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
updateScheduledAudit
in interface AWSIot
updateScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
Updates a Device Defender security profile.
updateSecurityProfile
in interface AWSIot
updateSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public UpdateStreamResult updateStream(UpdateStreamRequest request)
Updates an existing stream. The stream version will be incremented by one.
updateStream
in interface AWSIot
updateStreamRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.public UpdateThingResult updateThing(UpdateThingRequest request)
Updates the data for a thing.
updateThing
in interface AWSIot
updateThingRequest
- The input for the UpdateThing operation.InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest request)
Update a thing group.
updateThingGroup
in interface AWSIot
updateThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest request)
Updates the groups to which the thing belongs.
updateThingGroupsForThing
in interface AWSIot
updateThingGroupsForThingRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.public UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest request)
Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
updateTopicRuleDestination
in interface AWSIot
updateTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.public ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest request)
Validates a Device Defender security profile behaviors specification.
validateSecurityProfileBehaviors
in interface AWSIot
validateSecurityProfileBehaviorsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.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 AWSIot
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.