@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIotClient extends AmazonWebServiceClient implements AWSIot
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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.
The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.
For more information about how IoT works, see the Developer Guide.
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services 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, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@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.
Requires permission to access the AcceptCertificateTransfer action.
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.
Requires permission to access the AddThingToBillingGroup action.
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.
Requires permission to access the AddThingToThingGroup action.
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.
Requires permission to access the AssociateTargetsWithJob action.
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 the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
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.
Requires permission to access the AttachSecurityProfile action.
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, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
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.
Requires permission to access the CancelAuditMitigationActionsTask action.
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 isn't in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
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, 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.
Requires permission to access the CancelCertificateTransfer action.
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 CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest request)
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTask
in interface AWSIot
cancelDetectMitigationActionsTaskRequest
- 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 CancelJobResult cancelJob(CancelJobRequest request)
Cancels a job.
Requires permission to access the CancelJob action.
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.LimitExceededException
- A limit has been exceeded.public CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest request)
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
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.
Requires permission to access the ClearDefaultAuthorizer action.
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, 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.
Requires permission to access the ConfirmTopicRuleDestination action.
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 CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest request)
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppression
in interface AWSIot
createAuditSuppressionRequest
- 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 CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
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.
Requires permission to access the CreateBillingGroup action.
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.
Requires permission to access the CreateCertificateFromCsr action.
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, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
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. In the following commands, we assume that 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
Amazon Web Services CLI command to create a certificate for the
corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the command 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 CreateCertificateProviderResult createCertificateProvider(CreateCertificateProviderRequest request)
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr
API for fleet provisioning will change and all API calls to
CreateCertificateFromCsr
will invoke the certificate provider to create the certificates. It can
take up to a few minutes for this behavior to change after a certificate provider is created.
createCertificateProvider
in interface AWSIot
createCertificateProviderRequest
- LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.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 CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest request)
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
createCustomMetric
in interface AWSIot
createCustomMetricRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public CreateDimensionResult createDimension(CreateDimensionRequest request)
Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device
Defender. For example, using a TOPIC_FILTER
dimension, you can narrow down the scope of the metric
only to MQTT topics whose name match the pattern specified in the dimension.
Requires permission to access the CreateDimension action.
createDimension
in interface AWSIot
createDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.public CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest request)
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
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.
Requires permission to access the CreateDynamicThingGroup action.
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 CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest request)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetric
in interface AWSIot
createFleetMetricRequest
- 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.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.public CreateJobResult createJob(CreateJobRequest request)
Creates a job.
Requires permission to access the CreateJob action.
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 CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest request)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplate
in interface AWSIot
createJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- A resource with the same name already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.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 IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
createKeysAndCertificate
in interface AWSIot
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
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. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
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 IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
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 CreatePackageResult createPackage(CreatePackageRequest request)
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackage
in interface AWSIot
createPackageRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ServiceQuotaExceededException
- A limit has been exceeded.public CreatePackageVersionResult createPackageVersion(CreatePackageVersionRequest request)
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersion
in interface AWSIot
createPackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ServiceQuotaExceededException
- A limit has been exceeded.public CreatePolicyResult createPolicy(CreatePolicyRequest request)
Creates an 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.
Requires permission to access the CreatePolicy action.
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 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).
Requires permission to access the CreatePolicyVersion action.
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.
Requires permission to access the CreateProvisioningClaim action.
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 provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
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 provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
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.
Requires permission to access the CreateRoleAlias action.
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.
Requires permission to access the CreateScheduledAudit action.
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.
Requires permission to access the CreateSecurityProfile action.
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.
Requires permission to access the CreateStream action.
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.
Requires permission to access the CreateThing action.
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.
If the ThingGroup
that you create has the exact same attributes as an existing
ThingGroup
, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
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.
Requires permission to access the CreateThingType action.
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.
Requires permission to access the CreateTopicRule action.
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.
Requires permission to access the CreateTopicRuleDestination action.
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.
Requires permission to access the DeleteAccountAuditConfiguration action.
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 DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest request)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppression
in interface AWSIot
deleteAuditSuppressionRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
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.
Requires permission to access the DeleteBillingGroup action.
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.
Requires permission to access the DeleteCACertificate action.
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 DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
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 DeleteCertificateProviderResult deleteCertificateProvider(DeleteCertificateProviderRequest request)
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr
will
resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
deleteCertificateProvider
in interface AWSIot
deleteCertificateProviderRequest
- 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 DeleteCustomMetricResult deleteCustomMetric(DeleteCustomMetricRequest request)
Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
API with metricName
set to your custom metric name.
deleteCustomMetric
in interface AWSIot
deleteCustomMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public DeleteDimensionResult deleteDimension(DeleteDimensionRequest request)
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimension
in interface AWSIot
deleteDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.public DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest request)
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
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.
Requires permission to access the DeleteDynamicThingGroup action.
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 DeleteFleetMetricResult deleteFleetMetric(DeleteFleetMetricRequest request)
Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.
Requires permission to access the DeleteFleetMetric action.
deleteFleetMetric
in interface AWSIot
deleteFleetMetricRequest
- 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.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 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.
Requires permission to access the DeleteJob action.
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.
Requires permission to access the DeleteJobExecution action.
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 DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest request)
Deletes the specified job template.
deleteJobTemplate
in interface AWSIot
deleteJobTemplateRequest
- 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 DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest request)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
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.
Requires permission to access the DeleteOTAUpdate action.
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 DeletePackageResult deletePackage(DeletePackageRequest request)
Deletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
deletePackage
in interface AWSIot
deletePackageRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.public DeletePackageVersionResult deletePackageVersion(DeletePackageVersionRequest request)
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
deletePackageVersion
in interface AWSIot
deletePackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DeletePolicy action.
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 action. 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.
Requires permission to access the DeletePolicyVersion action.
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 provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
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.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.UnauthorizedException
- You are not authorized to perform this operation.public DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest request)
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
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.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.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.
Requires permission to access the DeleteRegistrationCode action.
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
Requires permission to access the DeleteRoleAlias action.
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.
Requires permission to access the DeleteScheduledAudit action.
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.
Requires permission to access the DeleteSecurityProfile action.
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.
Requires permission to access the DeleteStream action.
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.
Requires permission to access the DeleteThing action.
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.
Requires permission to access the DeleteThingGroup action.
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.
Requires permission to access the DeleteThingType action.
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.
Requires permission to access the DeleteTopicRule action.
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.
Requires permission to access the DeleteTopicRuleDestination action.
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.
Requires permission to access the DeleteV2LoggingLevel action.
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.
Requires permission to access the DeprecateThingType action.
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.
Requires permission to access the DescribeAccountAuditConfiguration action.
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 the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
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 DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest request)
Gets information about a Device Defender audit suppression.
describeAuditSuppression
in interface AWSIot
describeAuditSuppressionRequest
- 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.
Requires permission to access the DescribeAuditTask action.
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.
Requires permission to access the DescribeAuthorizer action.
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.
Requires permission to access the DescribeBillingGroup action.
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.
Requires permission to access the DescribeCACertificate action.
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.
Requires permission to access the DescribeCertificate action.
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 DescribeCertificateProviderResult describeCertificateProvider(DescribeCertificateProviderRequest request)
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProvider
in interface AWSIot
describeCertificateProviderRequest
- 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 DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest request)
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetric
in interface AWSIot
describeCustomMetricRequest
- 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 DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest request)
Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
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 DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest request)
Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
describeDetectMitigationActionsTask
in interface AWSIot
describeDetectMitigationActionsTaskRequest
- 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 DescribeDimensionResult describeDimension(DescribeDimensionRequest request)
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
describeDimension
in interface AWSIot
describeDimensionRequest
- 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.public DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest request)
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
describeDomainConfiguration
in interface AWSIot
describeDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InvalidRequestException
- The request is not valid.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 or creates a unique endpoint specific to the Amazon Web Services account making the call.
The first time DescribeEndpoint
is called, an endpoint is created. All subsequent calls to
DescribeEndpoint
return the same endpoint.
Requires permission to access the DescribeEndpoint action.
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.
Requires permission to access the DescribeEventConfigurations action.
describeEventConfigurations
in interface AWSIot
describeEventConfigurationsRequest
- InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.public DescribeFleetMetricResult describeFleetMetric(DescribeFleetMetricRequest request)
Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
describeFleetMetric
in interface AWSIot
describeFleetMetricRequest
- 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 DescribeIndexResult describeIndex(DescribeIndexRequest request)
Describes a search index.
Requires permission to access the DescribeIndex action.
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.
Requires permission to access the DescribeJob action.
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.
Requires permission to access the DescribeJobExecution action.
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 DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest request)
Returns information about a job template.
describeJobTemplate
in interface AWSIot
describeJobTemplateRequest
- 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 DescribeManagedJobTemplateResult describeManagedJobTemplate(DescribeManagedJobTemplateRequest request)
View details of a managed job template.
describeManagedJobTemplate
in interface AWSIot
describeManagedJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.public DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest request)
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction 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 provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
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 provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
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.
Requires permission to access the DescribeRoleAlias action.
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.
Requires permission to access the DescribeScheduledAudit action.
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.
Requires permission to access the DescribeSecurityProfile action.
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.
Requires permission to access the DescribeStream action.
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.
Requires permission to access the DescribeThing action.
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.
Requires permission to access the DescribeThingGroup action.
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.
Requires permission to access the DescribeThingRegistrationTask action.
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.
Requires permission to access the DescribeThingType action.
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.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DetachPolicy action.
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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
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.
Requires permission to access the DetachSecurityProfile action.
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.
Requires permission to access the DetachThingPrincipal action.
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.
Requires permission to access the DisableTopicRule action.
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.
Requires permission to access the EnableTopicRule action.
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 GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest request)
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
getBehaviorModelTrainingSummaries
in interface AWSIot
getBehaviorModelTrainingSummariesRequest
- 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 GetBucketsAggregationResult getBucketsAggregation(GetBucketsAggregationRequest request)
Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
getBucketsAggregation
in interface AWSIot
getBucketsAggregationRequest
- 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 GetCardinalityResult getCardinality(GetCardinalityRequest request)
Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
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 IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
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.
Requires permission to access the GetIndexingConfiguration action.
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.
Requires permission to access the GetJobDocument action.
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.
Requires permission to access the GetLoggingOptions action.
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.
Requires permission to access the GetOTAUpdate action.
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 GetPackageResult getPackage(GetPackageRequest request)
Gets information about the specified software package.
Requires permission to access the GetPackage action.
getPackage
in interface AWSIot
getPackageRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.public GetPackageConfigurationResult getPackageConfiguration(GetPackageConfigurationRequest request)
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
getPackageConfiguration
in interface AWSIot
getPackageConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.public GetPackageVersionResult getPackageVersion(GetPackageVersionRequest request)
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
getPackageVersion
in interface AWSIot
getPackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.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.
Requires permission to access the GetPercentiles action.
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.
Requires permission to access the GetPolicy action.
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.
Requires permission to access the GetPolicyVersion action.
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 IoT.
IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.
Requires permission to access the GetRegistrationCode action.
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.
Requires permission to access the GetStatistics action.
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.
Requires permission to access the GetTopicRule action.
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.
Requires permission to access the GetTopicRuleDestination action.
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.
Requires permission to access the GetV2LoggingOptions action.
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.
Requires permission to access the ListActiveViolations action.
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.
Requires permission to access the ListAttachedPolicies action.
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 90 days.)
Requires permission to access the ListAuditFindings action.
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.
Requires permission to access the ListAuditMitigationActionsExecutions action.
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.
Requires permission to access the ListAuditMitigationActionsTasks action.
listAuditMitigationActionsTasks
in interface AWSIot
listAuditMitigationActionsTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest request)
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
listAuditSuppressions
in interface AWSIot
listAuditSuppressionsRequest
- 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.
Requires permission to access the ListAuditTasks action.
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.
Requires permission to access the ListAuthorizers action.
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.
Requires permission to access the ListBillingGroups action.
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 Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
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 ListCertificateProvidersResult listCertificateProviders(ListCertificateProvidersRequest request)
Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
listCertificateProviders
in interface AWSIot
listCertificateProvidersRequest
- 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 Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
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.
Requires permission to access the ListCertificatesByCA action.
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 ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest request)
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
listCustomMetrics
in interface AWSIot
listCustomMetricsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest request)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
listDetectMitigationActionsExecutions
in interface AWSIot
listDetectMitigationActionsExecutionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest request)
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
listDetectMitigationActionsTasks
in interface AWSIot
listDetectMitigationActionsTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListDimensionsResult listDimensions(ListDimensionsRequest request)
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
listDimensions
in interface AWSIot
listDimensionsRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.public ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest request)
Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
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 ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest request)
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
listFleetMetrics
in interface AWSIot
listFleetMetricsRequest
- 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.
Requires permission to access the ListIndices action.
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.
Requires permission to access the ListJobExecutionsForJob action.
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.
Requires permission to access the ListJobExecutionsForThing action.
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 ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest request)
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
listJobTemplates
in interface AWSIot
listJobTemplatesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public ListJobsResult listJobs(ListJobsRequest request)
Lists jobs.
Requires permission to access the ListJobs action.
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 ListManagedJobTemplatesResult listManagedJobTemplates(ListManagedJobTemplatesRequest request)
Returns a list of managed job templates.
listManagedJobTemplates
in interface AWSIot
listManagedJobTemplatesRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.public ListMetricValuesResult listMetricValues(ListMetricValuesRequest request)
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
listMetricValues
in interface AWSIot
listMetricValuesRequest
- 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 ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest request)
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
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.
Requires permission to access the ListOTAUpdates action.
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.
Requires permission to access the ListOutgoingCertificates action.
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 ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest request)
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
listPackageVersions
in interface AWSIot
listPackageVersionsRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.public ListPackagesResult listPackages(ListPackagesRequest request)
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
listPackages
in interface AWSIot
listPackagesRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
Lists your policies.
Requires permission to access the ListPolicies action.
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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
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.
Requires permission to access the ListPolicyVersions action.
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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
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.
Requires permission to access the ListPrincipalThings action.
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 provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
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 provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
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 ListRelatedResourcesForAuditFindingResult listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest request)
The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
listRelatedResourcesForAuditFinding
in interface AWSIot
listRelatedResourcesForAuditFindingRequest
- 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 ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest request)
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
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.
Requires permission to access the ListScheduledAudits action.
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've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName
and metricName
cannot be used in the same request.
listSecurityProfiles
in interface AWSIot
listSecurityProfilesRequest
- 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 ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest request)
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
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 Amazon Web Services account.
Requires permission to access the ListStreams action.
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.
Requires permission to access the ListTagsForResource action.
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.
Requires permission to access the ListTargetsForPolicy action.
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.
Requires permission to access the ListTargetsForSecurityProfile action.
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.
Requires permission to access the ListThingGroups action.
listThingGroups
in interface AWSIot
listThingGroupsRequest
- 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 ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest request)
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
listThingGroupsForThing
in interface AWSIot
listThingGroupsForThingRequest
- 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 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.
Requires permission to access the ListThingPrincipals action.
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.
Requires permission to access the ListThingRegistrationTasks action.
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.
Requires permission to access the ListThingTypes action.
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. For more information, see List Things from
the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You will not be charged for calling this API if an Access denied
error is returned. You will also
not be charged if no attributes or pagination token was provided in request and no pagination token and no
results were returned.
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.
Requires permission to access the ListThingsInBillingGroup action.
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.
Requires permission to access the ListThingsInThingGroup action.
listThingsInThingGroup
in interface AWSIot
listThingsInThingGroupRequest
- 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 ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest request)
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
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.
Requires permission to access the ListTopicRules action.
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.
Requires permission to access the ListV2LoggingLevels action.
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).
Requires permission to access the ListViolationEvents action.
listViolationEvents
in interface AWSIot
listViolationEventsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public PutVerificationStateOnViolationResult putVerificationStateOnViolation(PutVerificationStateOnViolationRequest request)
Set a verification state and provide a description of that verification state on a violation (detect alarm).
putVerificationStateOnViolation
in interface AWSIot
putVerificationStateOnViolationRequest
- 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 Amazon Web Services IoT Core. There is no limit to the number of CA certificates
you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same
CA subject field
per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
registerCACertificate
in interface AWSIot
registerCACertificateRequest
- The input to the RegisterCACertificate operation.ResourceNotFoundException
- The specified resource does not exist.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 IoT in the same certificate mode as the signing CA. 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.
Requires permission to access the RegisterCertificate action.
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 RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest request)
Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
registerCertificateWithoutCA
in interface AWSIot
registerCertificateWithoutCARequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.CertificateStateException
- The certificate operation is not allowed.CertificateValidationException
- The certificate is invalid.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 IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
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 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.
Requires permission to access the RejectCertificateTransfer action.
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.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
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.
You must specify either a thingGroupArn
or a thingGroupName
to identify the thing group
and either a thingArn
or a thingName
to identify the thing to remove from the thing
group.
Requires permission to access the RemoveThingFromThingGroup action.
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.
Requires permission to access the ReplaceTopicRule action.
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.
Requires permission to access the SearchIndex action.
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.
Requires permission to access the SetDefaultAuthorizer action.
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 ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
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.
Requires permission to access the SetLoggingOptions action.
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.
Requires permission to access the SetV2LoggingLevel action.
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.LimitExceededException
- A limit has been exceeded.public SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest request)
Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
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.
Requires permission to access the StartAuditMitigationActionsTask action.
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 StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest request)
Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
startDetectMitigationActionsTask
in interface AWSIot
startDetectMitigationActionsTaskRequest
- 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.
Requires permission to access the StartOnDemandAuditTask action.
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.
Requires permission to access the StartThingRegistrationTask action.
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.
Requires permission to access the StopThingRegistrationTask action.
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.
Requires permission to access the TagResource action.
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 IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
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 IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
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 Amazon Web Services account.
Requires permission to access the TransferCertificate action.
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 action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action 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.
Requires permission to access the UntagResource action.
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.
Requires permission to access the UpdateAccountAuditConfiguration action.
updateAccountAuditConfiguration
in interface AWSIot
updateAccountAuditConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.public UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest request)
Updates a Device Defender audit suppression.
updateAuditSuppression
in interface AWSIot
updateAuditSuppressionRequest
- 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 UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
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.
Requires permission to access the UpdateBillingGroup action.
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.
Requires permission to access the UpdateCACertificate action.
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.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
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 UpdateCertificateProviderResult updateCertificateProvider(UpdateCertificateProviderRequest request)
Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
updateCertificateProvider
in interface AWSIot
updateCertificateProviderRequest
- 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 UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest request)
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
updateCustomMetric
in interface AWSIot
updateCustomMetricRequest
- 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 UpdateDimensionResult updateDimension(UpdateDimensionRequest request)
Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
updateDimension
in interface AWSIot
updateDimensionRequest
- 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.public UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest request)
Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
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.
Requires permission to access the UpdateDynamicThingGroup action.
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.
Requires permission to access the UpdateEventConfigurations action.
updateEventConfigurations
in interface AWSIot
updateEventConfigurationsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.public UpdateFleetMetricResult updateFleetMetric(UpdateFleetMetricRequest request)
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
updateFleetMetric
in interface AWSIot
updateFleetMetricRequest
- 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.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.IndexNotReadyException
- The index is not ready.public UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest request)
Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
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.
Requires permission to access the UpdateJob action.
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.
Requires permission to access the UpdateMitigationAction 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 UpdatePackageResult updatePackage(UpdatePackageRequest request)
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
updatePackage
in interface AWSIot
updatePackageRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.public UpdatePackageConfigurationResult updatePackageConfiguration(UpdatePackageConfigurationRequest request)
Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
updatePackageConfiguration
in interface AWSIot
updatePackageConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.public UpdatePackageVersionResult updatePackageVersion(UpdatePackageVersionRequest request)
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
updatePackageVersion
in interface AWSIot
updatePackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.public UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest request)
Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
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.
Requires permission to access the UpdateRoleAlias action.
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.
Requires permission to access the UpdateScheduledAudit action.
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.
Requires permission to access the UpdateSecurityProfile action.
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.
Requires permission to access the UpdateStream action.
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.
Requires permission to access the UpdateThing action.
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.
Requires permission to access the UpdateThingGroup action.
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.
Requires permission to access the UpdateThingGroupsForThing action.
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.
Requires permission to access the UpdateTopicRuleDestination action.
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.
Requires permission to access the ValidateSecurityProfileBehaviors action.
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 requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSIot
shutdown
in class AmazonWebServiceClient