/*
* Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.iot;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.iot.model.*;
/**
* Interface for accessing AWS IoT
* 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. *
**/ public interface AWSIot { /** * Overrides the default endpoint for this client * ("https://iot.us-east-1.amazonaws.com"). Callers can use this method to * control which AWS region they want to work with. ** Callers can pass in just the endpoint (ex: "iot.us-east-1.amazonaws.com") * or a full URL, including the protocol (ex: * "https://iot.us-east-1.amazonaws.com"). If the protocol is not specified * here, the default protocol from this client's {@link ClientConfiguration} * will be used, which by default is HTTPS. *
* For more information on using AWS regions with the AWS SDK for Java, and * a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *
* This method is not threadsafe. An endpoint should be configured when * the client is created and before any service requests are made. Changing * it afterwards creates inevitable race conditions for any service requests * in transit or retrying. * * @param endpoint The endpoint (ex: "iot.us-east-1.amazonaws.com") or a * full URL, including the protocol (ex: * "https://iot.us-east-1.amazonaws.com") of the region specific * AWS endpoint this client will communicate with. * @throws IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AWSIot#setEndpoint(String)}, sets the regional * endpoint for this client's service calls. Callers can use this method to * control which AWS region they want to work with. *
* By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. *
* This method is not threadsafe. A region should be configured when the * client is created and before any service requests are made. Changing it * afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *
* 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. *
* * @param acceptCertificateTransferRequest* The input for the AcceptCertificateTransfer operation. *
* @throws ResourceNotFoundException * @throws TransferAlreadyCompletedException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds a thing to a billing group. *
** Requires permission to access the AddThingToBillingGroup action. *
* * @param addThingToBillingGroupRequest * @return addThingToBillingGroupResult The response from the * AddThingToBillingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ AddThingToBillingGroupResult addThingToBillingGroup( AddThingToBillingGroupRequest addThingToBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Adds a thing to a thing group. *
** Requires permission to access the AddThingToThingGroup action. *
* * @param addThingToThingGroupRequest * @return addThingToThingGroupResult The response from the * AddThingToThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ AddThingToThingGroupResult addThingToThingGroup( AddThingToThingGroupRequest addThingToThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param associateTargetsWithJobRequest * @return associateTargetsWithJobResult The response from the * AssociateTargetsWithJob service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ AssociateTargetsWithJobResult associateTargetsWithJob( AssociateTargetsWithJobRequest associateTargetsWithJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Attaches the specified policy to the specified principal (certificate or * other credential). *
** Requires permission to access the AttachPolicy action. *
* * @param attachPolicyRequest * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void attachPolicy(AttachPolicyRequest attachPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Attaches 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. *
* * @param attachPrincipalPolicyRequest* The input for the AttachPrincipalPolicy operation. *
* @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ @Deprecated void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param attachSecurityProfileRequest * @return attachSecurityProfileResult The response from the * AttachSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ AttachSecurityProfileResult attachSecurityProfile( AttachSecurityProfileRequest attachSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param attachThingPrincipalRequest* The input for the AttachThingPrincipal operation. *
* @return attachThingPrincipalResult The response from the * AttachThingPrincipal service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ AttachThingPrincipalResult attachThingPrincipal( AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param cancelAuditMitigationActionsTaskRequest * @return cancelAuditMitigationActionsTaskResult The response from the * CancelAuditMitigationActionsTask service method, as returned by * AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask( CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param cancelAuditTaskRequest * @return cancelAuditTaskResult The response from the CancelAuditTask * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Cancels a pending transfer for the specified certificate. *
** Note Only the transfer source account can use this operation to * cancel a transfer. (Transfer destinations can use * RejectCertificateTransfer instead.) After transfer, 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. *
* * @param cancelCertificateTransferRequest* The input for the CancelCertificateTransfer operation. *
* @throws ResourceNotFoundException * @throws TransferAlreadyCompletedException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonClientException, AmazonServiceException; /** ** Cancels a Device Defender ML Detect mitigation action. *
** Requires permission to access the CancelDetectMitigationActionsTask action. *
* * @param cancelDetectMitigationActionsTaskRequest * @return cancelDetectMitigationActionsTaskResult The response from the * CancelDetectMitigationActionsTask service method, as returned by * AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask( CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Cancels a job. *
** Requires permission to access the CancelJob action. *
* * @param cancelJobRequest * @return cancelJobResult The response from the CancelJob service method, * as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CancelJobResult cancelJob(CancelJobRequest cancelJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Cancels the execution of a job for a given thing. *
** Requires permission to access the CancelJobExecution action. *
* * @param cancelJobExecutionRequest * @throws InvalidRequestException * @throws InvalidStateTransitionException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws VersionConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest) throws AmazonClientException, AmazonServiceException; /** ** Clears the default authorizer. *
** Requires permission to access the ClearDefaultAuthorizer action. *
* * @param clearDefaultAuthorizerRequest * @return clearDefaultAuthorizerResult The response from the * ClearDefaultAuthorizer service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ClearDefaultAuthorizerResult clearDefaultAuthorizer( ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param confirmTopicRuleDestinationRequest * @return confirmTopicRuleDestinationResult The response from the * ConfirmTopicRuleDestination service method, as returned by AWS * IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ConfirmTopicRuleDestinationResult confirmTopicRuleDestination( ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a Device Defender audit suppression. *
** Requires permission to access the CreateAuditSuppression action. *
* * @param createAuditSuppressionRequest * @return createAuditSuppressionResult The response from the * CreateAuditSuppression service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateAuditSuppressionResult createAuditSuppression( CreateAuditSuppressionRequest createAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an authorizer. *
** Requires permission to access the CreateAuthorizer action. *
* * @param createAuthorizerRequest * @return createAuthorizerResult The response from the CreateAuthorizer * service method, as returned by AWS IoT. * @throws ResourceAlreadyExistsException * @throws InvalidRequestException * @throws LimitExceededException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a billing group. *
** Requires permission to access the CreateBillingGroup action. *
* * @param createBillingGroupRequest * @return createBillingGroupResult The response from the CreateBillingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** 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 or NIST P-384 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"
*
* The input for the CreateCertificateFromCsr operation. *
* @return createCertificateFromCsrResult The response from the * CreateCertificateFromCsr service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateCertificateFromCsrResult createCertificateFromCsr( CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonClientException, AmazonServiceException; /** ** Use this API to define a Custom Metric published by your devices to * Device Defender. *
** Requires permission to access the CreateCustomMetric action. *
* * @param createCustomMetricRequest * @return createCustomMetricResult The response from the CreateCustomMetric * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws LimitExceededException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param createDimensionRequest * @return createDimensionResult The response from the CreateDimension * service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws LimitExceededException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateDimensionResult createDimension(CreateDimensionRequest createDimensionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a domain configuration. *
** Requires permission to access the CreateDomainConfiguration action. *
* * @param createDomainConfigurationRequest * @return createDomainConfigurationResult The response from the * CreateDomainConfiguration service method, as returned by AWS IoT. * @throws LimitExceededException * @throws CertificateValidationException * @throws ResourceAlreadyExistsException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws InvalidRequestException * @throws UnauthorizedException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateDomainConfigurationResult createDomainConfiguration( CreateDomainConfigurationRequest createDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a dynamic thing group. *
** Requires permission to access the CreateDynamicThingGroup action. *
* * @param createDynamicThingGroupRequest * @return createDynamicThingGroupResult The response from the * CreateDynamicThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws InvalidQueryException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateDynamicThingGroupResult createDynamicThingGroup( CreateDynamicThingGroupRequest createDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a fleet metric. *
** Requires permission to access the CreateFleetMetric action. *
* * @param createFleetMetricRequest * @return createFleetMetricResult The response from the CreateFleetMetric * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws ResourceAlreadyExistsException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a job. *
** Requires permission to access the CreateJob action. *
* * @param createJobRequest * @return createJobResult The response from the CreateJob service method, * as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ResourceAlreadyExistsException * @throws LimitExceededException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateJobResult createJob(CreateJobRequest createJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a job template. *
** Requires permission to access the CreateJobTemplate action. *
* * @param createJobTemplateRequest * @return createJobTemplateResult The response from the CreateJobTemplate * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ConflictException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param createKeysAndCertificateRequest* The input for the CreateKeysAndCertificate operation. *
** Requires permission to access the CreateKeysAndCertificateRequest action. *
* @return createKeysAndCertificateResult The response from the * CreateKeysAndCertificate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateKeysAndCertificateResult createKeysAndCertificate( CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param createMitigationActionRequest * @return createMitigationActionResult The response from the * CreateMitigationAction service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateMitigationActionResult createMitigationAction( CreateMitigationActionRequest createMitigationActionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an IoT OTA update on a target group of things or groups. *
** Requires permission to access the CreateOTAUpdate action. *
* * @param createOTAUpdateRequest * @return createOTAUpdateResult The response from the CreateOTAUpdate * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws LimitExceededException * @throws ResourceNotFoundException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates an IoT software package that can be deployed to your fleet. *
** Requires permission to access the CreatePackage and GetIndexingConfiguration actions. *
* * @param createPackageRequest * @return createPackageResult The response from the CreatePackage service * method, as returned by AWS IoT. * @throws ThrottlingException * @throws ConflictException * @throws InternalServerException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreatePackageResult createPackage(CreatePackageRequest createPackageRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new version for an existing IoT software package. *
** Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions. *
* * @param createPackageVersionRequest * @return createPackageVersionResult The response from the * CreatePackageVersion service method, as returned by AWS IoT. * @throws ThrottlingException * @throws ConflictException * @throws InternalServerException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreatePackageVersionResult createPackageVersion( CreatePackageVersionRequest createPackageVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param createPolicyRequest* The input for the CreatePolicy operation. *
* @return createPolicyResult The response from the CreatePolicy service * method, as returned by AWS IoT. * @throws ResourceAlreadyExistsException * @throws MalformedPolicyException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates 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. *
* * @param createPolicyVersionRequest* The input for the CreatePolicyVersion operation. *
* @return createPolicyVersionResult The response from the * CreatePolicyVersion service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws MalformedPolicyException * @throws VersionsLimitExceededException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreatePolicyVersionResult createPolicyVersion( CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a provisioning claim. *
** Requires permission to access the CreateProvisioningClaim action. *
* * @param createProvisioningClaimRequest * @return createProvisioningClaimResult The response from the * CreateProvisioningClaim service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateProvisioningClaimResult createProvisioningClaim( CreateProvisioningClaimRequest createProvisioningClaimRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a provisioning template. *
** Requires permission to access the CreateProvisioningTemplate action. *
* * @param createProvisioningTemplateRequest * @return createProvisioningTemplateResult The response from the * CreateProvisioningTemplate service method, as returned by AWS * IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws LimitExceededException * @throws ThrottlingException * @throws UnauthorizedException * @throws ResourceAlreadyExistsException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateProvisioningTemplateResult createProvisioningTemplate( CreateProvisioningTemplateRequest createProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new version of a provisioning template. *
** Requires permission to access the CreateProvisioningTemplateVersion action. *
* * @param createProvisioningTemplateVersionRequest * @return createProvisioningTemplateVersionResult The response from the * CreateProvisioningTemplateVersion service method, as returned by * AWS IoT. * @throws VersionsLimitExceededException * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion( CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a role alias. *
** Requires permission to access the CreateRoleAlias action. *
* * @param createRoleAliasRequest * @return createRoleAliasResult The response from the CreateRoleAlias * service method, as returned by AWS IoT. * @throws ResourceAlreadyExistsException * @throws InvalidRequestException * @throws LimitExceededException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a scheduled audit that is run at a specified time interval. *
** Requires permission to access the CreateScheduledAudit action. *
* * @param createScheduledAuditRequest * @return createScheduledAuditResult The response from the * CreateScheduledAudit service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateScheduledAuditResult createScheduledAudit( CreateScheduledAuditRequest createScheduledAuditRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a Device Defender security profile. *
** Requires permission to access the CreateSecurityProfile action. *
* * @param createSecurityProfileRequest * @return createSecurityProfileResult The response from the * CreateSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateSecurityProfileResult createSecurityProfile( CreateSecurityProfileRequest createSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a stream for delivering one or more large files in chunks over * MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT * messages from a source like S3. You can have one or more files associated * with a stream. *
** Requires permission to access the CreateStream action. *
* * @param createStreamRequest * @return createStreamResult The response from the CreateStream service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws LimitExceededException * @throws ResourceNotFoundException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateStreamResult createStream(CreateStreamRequest createStreamRequest) throws AmazonClientException, AmazonServiceException; /** *
* Creates a 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. *
* * @param createThingRequest* The input for the CreateThing operation. *
* @return createThingResult The response from the CreateThing service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceAlreadyExistsException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Create a thing group. *
** This is a control plane operation. See Authorization for information about authorizing control plane * actions. *
** Requires permission to access the CreateThingGroup action. *
* * @param createThingGroupRequest * @return createThingGroupResult The response from the CreateThingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a new thing type. *
** Requires permission to access the CreateThingType action. *
* * @param createThingTypeRequest* The input for the CreateThingType operation. *
* @return createThingTypeResult The response from the CreateThingType * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceAlreadyExistsException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a 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. *
* * @param createTopicRuleRequest* The input for the CreateTopicRule operation. *
* @throws SqlParseException * @throws InternalException * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ServiceUnavailableException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a topic rule destination. The destination must be confirmed prior * to use. *
** Requires permission to access the CreateTopicRuleDestination action. *
* * @param createTopicRuleDestinationRequest * @return createTopicRuleDestinationResult The response from the * CreateTopicRuleDestination service method, as returned by AWS * IoT. * @throws InternalException * @throws InvalidRequestException * @throws ResourceAlreadyExistsException * @throws ServiceUnavailableException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ CreateTopicRuleDestinationResult createTopicRuleDestination( CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param deleteAccountAuditConfigurationRequest * @return deleteAccountAuditConfigurationResult The response from the * DeleteAccountAuditConfiguration service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration( DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a Device Defender audit suppression. *
** Requires permission to access the DeleteAuditSuppression action. *
* * @param deleteAuditSuppressionRequest * @return deleteAuditSuppressionResult The response from the * DeleteAuditSuppression service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteAuditSuppressionResult deleteAuditSuppression( DeleteAuditSuppressionRequest deleteAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes an authorizer. *
** Requires permission to access the DeleteAuthorizer action. *
* * @param deleteAuthorizerRequest * @return deleteAuthorizerResult The response from the DeleteAuthorizer * service method, as returned by AWS IoT. * @throws DeleteConflictException * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the billing group. *
** Requires permission to access the DeleteBillingGroup action. *
* * @param deleteBillingGroupRequest * @return deleteBillingGroupResult The response from the DeleteBillingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a registered CA certificate. *
** Requires permission to access the DeleteCACertificate action. *
* * @param deleteCACertificateRequest* Input for the DeleteCACertificate operation. *
* @return deleteCACertificateResult The response from the * DeleteCACertificate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws CertificateStateException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteCACertificateResult deleteCACertificate( DeleteCACertificateRequest deleteCACertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes 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. *
* * @param deleteCertificateRequest* The input for the DeleteCertificate operation. *
* @throws CertificateStateException * @throws DeleteConflictException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes 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.
*
* Removes the specified dimension from your Amazon Web Services accounts. *
** Requires permission to access the DeleteDimension action. *
* * @param deleteDimensionRequest * @return deleteDimensionResult The response from the DeleteDimension * service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteDimensionResult deleteDimension(DeleteDimensionRequest deleteDimensionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified domain configuration. *
** Requires permission to access the DeleteDomainConfiguration action. *
* * @param deleteDomainConfigurationRequest * @return deleteDomainConfigurationResult The response from the * DeleteDomainConfiguration service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws InvalidRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteDomainConfigurationResult deleteDomainConfiguration( DeleteDomainConfigurationRequest deleteDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a dynamic thing group. *
** Requires permission to access the DeleteDynamicThingGroup action. *
* * @param deleteDynamicThingGroupRequest * @return deleteDynamicThingGroupResult The response from the * DeleteDynamicThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteDynamicThingGroupResult deleteDynamicThingGroup( DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param deleteFleetMetricRequest * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws VersionConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a job and its related job executions. *
** Deleting a job may take time, depending on the number of job executions * created for the job and various other factors. While the job is being * deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". * Attempting to delete or cancel a job whose status is already * "DELETION_IN_PROGRESS" will result in an error. *
** Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or * a LimitExceededException will occur. *
** Requires permission to access the DeleteJob action. *
* * @param deleteJobRequest * @throws InvalidRequestException * @throws InvalidStateTransitionException * @throws ResourceNotFoundException * @throws LimitExceededException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteJob(DeleteJobRequest deleteJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a job execution. *
** Requires permission to access the DeleteJobExecution action. *
* * @param deleteJobExecutionRequest * @throws InvalidRequestException * @throws InvalidStateTransitionException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified job template. *
* * @param deleteJobTemplateRequest * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a defined mitigation action from your Amazon Web Services * accounts. *
** Requires permission to access the DeleteMitigationAction action. *
* * @param deleteMitigationActionRequest * @return deleteMitigationActionResult The response from the * DeleteMitigationAction service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteMitigationActionResult deleteMitigationAction( DeleteMitigationActionRequest deleteMitigationActionRequest) throws AmazonClientException, AmazonServiceException; /** ** Delete an OTA update. *
** Requires permission to access the DeleteOTAUpdate action. *
* * @param deleteOTAUpdateRequest * @return deleteOTAUpdateResult The response from the DeleteOTAUpdate * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ServiceUnavailableException * @throws VersionConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param deletePackageRequest * @return deletePackageResult The response from the DeletePackage service * method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a specific version from a software package. *
** Note: If a package version is designated as default, you must * remove the designation from the package using the UpdatePackage * action. *
* * @param deletePackageVersionRequest * @return deletePackageVersionResult The response from the * DeletePackageVersion service method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeletePackageVersionResult deletePackageVersion( DeletePackageVersionRequest deletePackageVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified policy. *
** A policy cannot be deleted if it has non-default versions or it is * attached to any certificate. *
** To delete a policy, use the DeletePolicyVersion 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. *
* * @param deletePolicyRequest* The input for the DeletePolicy operation. *
* @throws DeleteConflictException * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the specified 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. *
* * @param deletePolicyVersionRequest* The input for the DeletePolicyVersion operation. *
* @throws DeleteConflictException * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a provisioning template. *
** Requires permission to access the DeleteProvisioningTemplate action. *
* * @param deleteProvisioningTemplateRequest * @return deleteProvisioningTemplateResult The response from the * DeleteProvisioningTemplate service method, as returned by AWS * IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws DeleteConflictException * @throws ThrottlingException * @throws ConflictingResourceUpdateException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteProvisioningTemplateResult deleteProvisioningTemplate( DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a provisioning template version. *
** Requires permission to access the DeleteProvisioningTemplateVersion action. *
* * @param deleteProvisioningTemplateVersionRequest * @return deleteProvisioningTemplateVersionResult The response from the * DeleteProvisioningTemplateVersion service method, as returned by * AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws DeleteConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion( DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a CA certificate registration code. *
** Requires permission to access the DeleteRegistrationCode action. *
* * @param deleteRegistrationCodeRequest* The input for the DeleteRegistrationCode operation. *
* @return deleteRegistrationCodeResult The response from the * DeleteRegistrationCode service method, as returned by AWS IoT. * @throws ThrottlingException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteRegistrationCodeResult deleteRegistrationCode( DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a role alias *
** Requires permission to access the DeleteRoleAlias action. *
* * @param deleteRoleAliasRequest * @return deleteRoleAliasResult The response from the DeleteRoleAlias * service method, as returned by AWS IoT. * @throws DeleteConflictException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a scheduled audit. *
** Requires permission to access the DeleteScheduledAudit action. *
* * @param deleteScheduledAuditRequest * @return deleteScheduledAuditResult The response from the * DeleteScheduledAudit service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteScheduledAuditResult deleteScheduledAudit( DeleteScheduledAuditRequest deleteScheduledAuditRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a Device Defender security profile. *
** Requires permission to access the DeleteSecurityProfile action. *
* * @param deleteSecurityProfileRequest * @return deleteSecurityProfileResult The response from the * DeleteSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws VersionConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteSecurityProfileResult deleteSecurityProfile( DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a stream. *
** Requires permission to access the DeleteStream action. *
* * @param deleteStreamRequest * @return deleteStreamResult The response from the DeleteStream service * method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws DeleteConflictException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes 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. *
* * @param deleteThingRequest* The input for the DeleteThing operation. *
* @return deleteThingResult The response from the DeleteThing service * method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws VersionConflictException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a thing group. *
** Requires permission to access the DeleteThingGroup action. *
* * @param deleteThingGroupRequest * @return deleteThingGroupResult The response from the DeleteThingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes 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. *
* * @param deleteThingTypeRequest* The input for the DeleteThingType operation. *
* @return deleteThingTypeResult The response from the DeleteThingType * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes the rule. *
** Requires permission to access the DeleteTopicRule action. *
* * @param deleteTopicRuleRequest* The input for the DeleteTopicRule operation. *
* @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a topic rule destination. *
** Requires permission to access the DeleteTopicRuleDestination action. *
* * @param deleteTopicRuleDestinationRequest * @return deleteTopicRuleDestinationResult The response from the * DeleteTopicRuleDestination service method, as returned by AWS * IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeleteTopicRuleDestinationResult deleteTopicRuleDestination( DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Deletes a logging level. *
** Requires permission to access the DeleteV2LoggingLevel action. *
* * @param deleteV2LoggingLevelRequest * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException; /** ** Deprecates a thing type. You can not associate new things with deprecated * thing type. *
** Requires permission to access the DeprecateThingType action. *
* * @param deprecateThingTypeRequest* The input for the DeprecateThingType operation. *
* @return deprecateThingTypeResult The response from the DeprecateThingType * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param describeAccountAuditConfigurationRequest * @return describeAccountAuditConfigurationResult The response from the * DescribeAccountAuditConfiguration service method, as returned by * AWS IoT. * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration( DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param describeAuditFindingRequest * @return describeAuditFindingResult The response from the * DescribeAuditFinding service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAuditFindingResult describeAuditFinding( DescribeAuditFindingRequest describeAuditFindingRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param describeAuditMitigationActionsTaskRequest * @return describeAuditMitigationActionsTaskResult The response from the * DescribeAuditMitigationActionsTask service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask( DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a Device Defender audit suppression. *
* * @param describeAuditSuppressionRequest * @return describeAuditSuppressionResult The response from the * DescribeAuditSuppression service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAuditSuppressionResult describeAuditSuppression( DescribeAuditSuppressionRequest describeAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a Device Defender audit. *
** Requires permission to access the DescribeAuditTask action. *
* * @param describeAuditTaskRequest * @return describeAuditTaskResult The response from the DescribeAuditTask * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes an authorizer. *
** Requires permission to access the DescribeAuthorizer action. *
* * @param describeAuthorizerRequest * @return describeAuthorizerResult The response from the DescribeAuthorizer * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns information about a billing group. *
** Requires permission to access the DescribeBillingGroup action. *
* * @param describeBillingGroupRequest * @return describeBillingGroupResult The response from the * DescribeBillingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeBillingGroupResult describeBillingGroup( DescribeBillingGroupRequest describeBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a registered CA certificate. *
** Requires permission to access the DescribeCACertificate action. *
* * @param describeCACertificateRequest* The input for the DescribeCACertificate operation. *
* @return describeCACertificateResult The response from the * DescribeCACertificate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeCACertificateResult describeCACertificate( DescribeCACertificateRequest describeCACertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified certificate. *
** Requires permission to access the DescribeCertificate action. *
* * @param describeCertificateRequest* The input for the DescribeCertificate operation. *
* @return describeCertificateResult The response from the * DescribeCertificate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeCertificateResult describeCertificate( DescribeCertificateRequest describeCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a Device Defender detect custom metric. *
** Requires permission to access the DescribeCustomMetric action. *
* * @param describeCustomMetricRequest * @return describeCustomMetricResult The response from the * DescribeCustomMetric service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeCustomMetricResult describeCustomMetric( DescribeCustomMetricRequest describeCustomMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes the default authorizer. *
** Requires permission to access the DescribeDefaultAuthorizer action. *
* * @param describeDefaultAuthorizerRequest * @return describeDefaultAuthorizerResult The response from the * DescribeDefaultAuthorizer service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeDefaultAuthorizerResult describeDefaultAuthorizer( DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a Device Defender ML Detect mitigation action. *
** Requires permission to access the DescribeDetectMitigationActionsTask action. *
* * @param describeDetectMitigationActionsTaskRequest * @return describeDetectMitigationActionsTaskResult The response from the * DescribeDetectMitigationActionsTask service method, as returned * by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask( DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Provides details about a dimension that is defined in your Amazon Web * Services accounts. *
** Requires permission to access the DescribeDimension action. *
* * @param describeDimensionRequest * @return describeDimensionResult The response from the DescribeDimension * service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeDimensionResult describeDimension(DescribeDimensionRequest describeDimensionRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets summary information about a domain configuration. *
** Requires permission to access the DescribeDomainConfiguration action. *
* * @param describeDomainConfigurationRequest * @return describeDomainConfigurationResult The response from the * DescribeDomainConfiguration service method, as returned by AWS * IoT. * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InvalidRequestException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeDomainConfigurationResult describeDomainConfiguration( DescribeDomainConfigurationRequest describeDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a unique endpoint specific to the Amazon Web Services account * making the call. *
** Requires permission to access the DescribeEndpoint action. *
* * @param describeEndpointRequest* The input for the DescribeEndpoint operation. *
* @return describeEndpointResult The response from the DescribeEndpoint * service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws UnauthorizedException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes event configurations. *
** Requires permission to access the DescribeEventConfigurations action. *
* * @param describeEventConfigurationsRequest * @return describeEventConfigurationsResult The response from the * DescribeEventConfigurations service method, as returned by AWS * IoT. * @throws InternalFailureException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeEventConfigurationsResult describeEventConfigurations( DescribeEventConfigurationsRequest describeEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified fleet metric. *
** Requires permission to access the DescribeFleetMetric action. *
* * @param describeFleetMetricRequest * @return describeFleetMetricResult The response from the * DescribeFleetMetric service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeFleetMetricResult describeFleetMetric( DescribeFleetMetricRequest describeFleetMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a search index. *
** Requires permission to access the DescribeIndex action. *
* * @param describeIndexRequest * @return describeIndexResult The response from the DescribeIndex service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a job. *
** Requires permission to access the DescribeJob action. *
* * @param describeJobRequest * @return describeJobResult The response from the DescribeJob service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeJobResult describeJob(DescribeJobRequest describeJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a job execution. *
** Requires permission to access the DescribeJobExecution action. *
* * @param describeJobExecutionRequest * @return describeJobExecutionResult The response from the * DescribeJobExecution service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeJobExecutionResult describeJobExecution( DescribeJobExecutionRequest describeJobExecutionRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns information about a job template. *
* * @param describeJobTemplateRequest * @return describeJobTemplateResult The response from the * DescribeJobTemplate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeJobTemplateResult describeJobTemplate( DescribeJobTemplateRequest describeJobTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** View details of a managed job template. *
* * @param describeManagedJobTemplateRequest * @return describeManagedJobTemplateResult The response from the * DescribeManagedJobTemplate service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeManagedJobTemplateResult describeManagedJobTemplate( DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a mitigation action. *
** Requires permission to access the DescribeMitigationAction action. *
* * @param describeMitigationActionRequest * @return describeMitigationActionResult The response from the * DescribeMitigationAction service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeMitigationActionResult describeMitigationAction( DescribeMitigationActionRequest describeMitigationActionRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns information about a provisioning template. *
** Requires permission to access the DescribeProvisioningTemplate action. *
* * @param describeProvisioningTemplateRequest * @return describeProvisioningTemplateResult The response from the * DescribeProvisioningTemplate service method, as returned by AWS * IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeProvisioningTemplateResult describeProvisioningTemplate( DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns information about a provisioning template version. *
** Requires permission to access the DescribeProvisioningTemplateVersion action. *
* * @param describeProvisioningTemplateVersionRequest * @return describeProvisioningTemplateVersionResult The response from the * DescribeProvisioningTemplateVersion service method, as returned * by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion( DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a role alias. *
** Requires permission to access the DescribeRoleAlias action. *
* * @param describeRoleAliasRequest * @return describeRoleAliasResult The response from the DescribeRoleAlias * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a scheduled audit. *
** Requires permission to access the DescribeScheduledAudit action. *
* * @param describeScheduledAuditRequest * @return describeScheduledAuditResult The response from the * DescribeScheduledAudit service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeScheduledAuditResult describeScheduledAudit( DescribeScheduledAuditRequest describeScheduledAuditRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a Device Defender security profile. *
** Requires permission to access the DescribeSecurityProfile action. *
* * @param describeSecurityProfileRequest * @return describeSecurityProfileResult The response from the * DescribeSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeSecurityProfileResult describeSecurityProfile( DescribeSecurityProfileRequest describeSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a stream. *
** Requires permission to access the DescribeStream action. *
* * @param describeStreamRequest * @return describeStreamResult The response from the DescribeStream service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified thing. *
** Requires permission to access the DescribeThing action. *
* * @param describeThingRequest* The input for the DescribeThing operation. *
* @return describeThingResult The response from the DescribeThing service * method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Describe a thing group. *
** Requires permission to access the DescribeThingGroup action. *
* * @param describeThingGroupRequest * @return describeThingGroupResult The response from the DescribeThingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Describes a bulk thing provisioning task. *
** Requires permission to access the DescribeThingRegistrationTask action. *
* * @param describeThingRegistrationTaskRequest * @return describeThingRegistrationTaskResult The response from the * DescribeThingRegistrationTask service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeThingRegistrationTaskResult describeThingRegistrationTask( DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified thing type. *
** Requires permission to access the DescribeThingType action. *
* * @param describeThingTypeRequest* The input for the DescribeThingType operation. *
* @return describeThingTypeResult The response from the DescribeThingType * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param detachPolicyRequest * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void detachPolicy(DetachPolicyRequest detachPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param detachPrincipalPolicyRequest* The input for the DetachPrincipalPolicy operation. *
* @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ @Deprecated void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Disassociates a Device Defender security profile from a thing group or * from this account. *
** Requires permission to access the DetachSecurityProfile action. *
* * @param detachSecurityProfileRequest * @return detachSecurityProfileResult The response from the * DetachSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DetachSecurityProfileResult detachSecurityProfile( DetachSecurityProfileRequest detachSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param detachThingPrincipalRequest* The input for the DetachThingPrincipal operation. *
* @return detachThingPrincipalResult The response from the * DetachThingPrincipal service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ DetachThingPrincipalResult detachThingPrincipal( DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException; /** ** Disables the rule. *
** Requires permission to access the DisableTopicRule action. *
* * @param disableTopicRuleRequest* The input for the DisableTopicRuleRequest operation. *
* @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Enables the rule. *
** Requires permission to access the EnableTopicRule action. *
* * @param enableTopicRuleRequest* The input for the EnableTopicRuleRequest operation. *
* @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a Device Defender's ML Detect Security Profile training model's * status. *
** Requires permission to access the GetBehaviorModelTrainingSummaries action. *
* * @param getBehaviorModelTrainingSummariesRequest * @return getBehaviorModelTrainingSummariesResult The response from the * GetBehaviorModelTrainingSummaries service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries( GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) throws AmazonClientException, AmazonServiceException; /** ** Aggregates on indexed data with search queries pertaining to particular * fields. *
** Requires permission to access the GetBucketsAggregation action. *
* * @param getBucketsAggregationRequest * @return getBucketsAggregationResult The response from the * GetBucketsAggregation service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetBucketsAggregationResult getBucketsAggregation( GetBucketsAggregationRequest getBucketsAggregationRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns the approximate count of unique values that match the query. *
** Requires permission to access the GetCardinality action. *
* * @param getCardinalityRequest * @return getCardinalityResult The response from the GetCardinality service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetCardinalityResult getCardinality(GetCardinalityRequest getCardinalityRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of the policies that have an effect on the authorization * behavior of the specified device when it connects to the IoT device * gateway. *
** Requires permission to access the GetEffectivePolicies action. *
* * @param getEffectivePoliciesRequest * @return getEffectivePoliciesResult The response from the * GetEffectivePolicies service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetEffectivePoliciesResult getEffectivePolicies( GetEffectivePoliciesRequest getEffectivePoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the indexing configuration. *
** Requires permission to access the GetIndexingConfiguration action. *
* * @param getIndexingConfigurationRequest * @return getIndexingConfigurationResult The response from the * GetIndexingConfiguration service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetIndexingConfigurationResult getIndexingConfiguration( GetIndexingConfigurationRequest getIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a job document. *
** Requires permission to access the GetJobDocument action. *
* * @param getJobDocumentRequest * @return getJobDocumentResult The response from the GetJobDocument service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the logging options. *
*
* NOTE: use of this command is not recommended. Use
* GetV2LoggingOptions
instead.
*
* Requires permission to access the GetLoggingOptions action. *
* * @param getLoggingOptionsRequest* The input for the GetLoggingOptions operation. *
* @return getLoggingOptionsResult The response from the GetLoggingOptions * service method, as returned by AWS IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets an OTA update. *
** Requires permission to access the GetOTAUpdate action. *
* * @param getOTAUpdateRequest * @return getOTAUpdateResult The response from the GetOTAUpdate service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ServiceUnavailableException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified software package. *
** Requires permission to access the GetPackage action. *
* * @param getPackageRequest * @return getPackageResult The response from the GetPackage service method, * as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPackageResult getPackage(GetPackageRequest getPackageRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified software package's configuration. *
** Requires permission to access the GetPackageConfiguration action. *
* * @param getPackageConfigurationRequest * @return getPackageConfigurationResult The response from the * GetPackageConfiguration service method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPackageConfigurationResult getPackageConfiguration( GetPackageConfigurationRequest getPackageConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified package version. *
** Requires permission to access the GetPackageVersion action. *
* * @param getPackageVersionRequest * @return getPackageVersionResult The response from the GetPackageVersion * service method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPackageVersionResult getPackageVersion(GetPackageVersionRequest getPackageVersionRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param getPercentilesRequest * @return getPercentilesResult The response from the GetPercentiles service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPercentilesResult getPercentiles(GetPercentilesRequest getPercentilesRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified policy with the policy document of * the default version. *
** Requires permission to access the GetPolicy action. *
* * @param getPolicyRequest* The input for the GetPolicy operation. *
* @return getPolicyResult The response from the GetPolicy service method, * as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the specified policy version. *
** Requires permission to access the GetPolicyVersion action. *
* * @param getPolicyVersionRequest* The input for the GetPolicyVersion operation. *
* @return getPolicyVersionResult The response from the GetPolicyVersion * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a registration code used to register a CA certificate with IoT. *
** Requires permission to access the GetRegistrationCode action. *
* * @param getRegistrationCodeRequest* The input to the GetRegistrationCode operation. *
* @return getRegistrationCodeResult The response from the * GetRegistrationCode service method, as returned by AWS IoT. * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws InvalidRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetRegistrationCodeResult getRegistrationCode( GetRegistrationCodeRequest getRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param getStatisticsRequest * @return getStatisticsResult The response from the GetStatistics service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetStatisticsResult getStatistics(GetStatisticsRequest getStatisticsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about the rule. *
** Requires permission to access the GetTopicRule action. *
* * @param getTopicRuleRequest* The input for the GetTopicRule operation. *
* @return getTopicRuleResult The response from the GetTopicRule service * method, as returned by AWS IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets information about a topic rule destination. *
** Requires permission to access the GetTopicRuleDestination action. *
* * @param getTopicRuleDestinationRequest * @return getTopicRuleDestinationResult The response from the * GetTopicRuleDestination service method, as returned by AWS IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetTopicRuleDestinationResult getTopicRuleDestination( GetTopicRuleDestinationRequest getTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the fine grained logging options. *
** Requires permission to access the GetV2LoggingOptions action. *
* * @param getV2LoggingOptionsRequest * @return getV2LoggingOptionsResult The response from the * GetV2LoggingOptions service method, as returned by AWS IoT. * @throws InternalException * @throws NotConfiguredException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ GetV2LoggingOptionsResult getV2LoggingOptions( GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the active violations for a given Device Defender security profile. *
** Requires permission to access the ListActiveViolations action. *
* * @param listActiveViolationsRequest * @return listActiveViolationsResult The response from the * ListActiveViolations service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListActiveViolationsResult listActiveViolations( ListActiveViolationsRequest listActiveViolationsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the policies attached to the specified thing group. *
** Requires permission to access the ListAttachedPolicies action. *
* * @param listAttachedPoliciesRequest * @return listAttachedPoliciesResult The response from the * ListAttachedPolicies service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAttachedPoliciesResult listAttachedPolicies( ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the 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. *
* * @param listAuditFindingsRequest * @return listAuditFindingsResult The response from the ListAuditFindings * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets the status of audit mitigation action tasks that were executed. *
** Requires permission to access the ListAuditMitigationActionsExecutions action. *
* * @param listAuditMitigationActionsExecutionsRequest * @return listAuditMitigationActionsExecutionsResult The response from the * ListAuditMitigationActionsExecutions service method, as returned * by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions( ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of audit mitigation action tasks that match the specified * filters. *
** Requires permission to access the ListAuditMitigationActionsTasks action. *
* * @param listAuditMitigationActionsTasksRequest * @return listAuditMitigationActionsTasksResult The response from the * ListAuditMitigationActionsTasks service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks( ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists your Device Defender audit listings. *
** Requires permission to access the ListAuditSuppressions action. *
* * @param listAuditSuppressionsRequest * @return listAuditSuppressionsResult The response from the * ListAuditSuppressions service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuditSuppressionsResult listAuditSuppressions( ListAuditSuppressionsRequest listAuditSuppressionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the Device Defender audits that have been performed during a given * time period. *
** Requires permission to access the ListAuditTasks action. *
* * @param listAuditTasksRequest * @return listAuditTasksResult The response from the ListAuditTasks service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuditTasksResult listAuditTasks(ListAuditTasksRequest listAuditTasksRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the authorizers registered in your account. *
** Requires permission to access the ListAuthorizers action. *
* * @param listAuthorizersRequest * @return listAuthorizersResult The response from the ListAuthorizers * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the billing groups you have created. *
** Requires permission to access the ListBillingGroups action. *
* * @param listBillingGroupsRequest * @return listBillingGroupsResult The response from the ListBillingGroups * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param listCACertificatesRequest* Input for the ListCACertificates operation. *
* @return listCACertificatesResult The response from the ListCACertificates * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the 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. *
* * @param listCertificatesRequest* The input for the ListCertificates operation. *
* @return listCertificatesResult The response from the ListCertificates * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonClientException, AmazonServiceException; /** ** List the device certificates signed by the specified CA certificate. *
** Requires permission to access the ListCertificatesByCA action. *
* * @param listCertificatesByCARequest* The input to the ListCertificatesByCA operation. *
* @return listCertificatesByCAResult The response from the * ListCertificatesByCA service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListCertificatesByCAResult listCertificatesByCA( ListCertificatesByCARequest listCertificatesByCARequest) throws AmazonClientException, AmazonServiceException; /** ** Lists your Device Defender detect custom metrics. *
** Requires permission to access the ListCustomMetrics action. *
* * @param listCustomMetricsRequest * @return listCustomMetricsResult The response from the ListCustomMetrics * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists mitigation actions executions for a Device Defender ML Detect * Security Profile. *
** Requires permission to access the ListDetectMitigationActionsExecutions action. *
* * @param listDetectMitigationActionsExecutionsRequest * @return listDetectMitigationActionsExecutionsResult The response from the * ListDetectMitigationActionsExecutions service method, as returned * by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions( ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) throws AmazonClientException, AmazonServiceException; /** ** List of Device Defender ML Detect mitigation actions tasks. *
** Requires permission to access the ListDetectMitigationActionsTasks action. *
* * @param listDetectMitigationActionsTasksRequest * @return listDetectMitigationActionsTasksResult The response from the * ListDetectMitigationActionsTasks service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks( ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) throws AmazonClientException, AmazonServiceException; /** ** List the set of dimensions that are defined for your Amazon Web Services * accounts. *
** Requires permission to access the ListDimensions action. *
* * @param listDimensionsRequest * @return listDimensionsResult The response from the ListDimensions service * method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListDimensionsResult listDimensions(ListDimensionsRequest listDimensionsRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param listDomainConfigurationsRequest * @return listDomainConfigurationsResult The response from the * ListDomainConfigurations service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListDomainConfigurationsResult listDomainConfigurations( ListDomainConfigurationsRequest listDomainConfigurationsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists all your fleet metrics. *
** Requires permission to access the ListFleetMetrics action. *
* * @param listFleetMetricsRequest * @return listFleetMetricsResult The response from the ListFleetMetrics * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the search indices. *
** Requires permission to access the ListIndices action. *
* * @param listIndicesRequest * @return listIndicesResult The response from the ListIndices service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the job executions for a job. *
** Requires permission to access the ListJobExecutionsForJob action. *
* * @param listJobExecutionsForJobRequest * @return listJobExecutionsForJobResult The response from the * ListJobExecutionsForJob service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListJobExecutionsForJobResult listJobExecutionsForJob( ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the job executions for the specified thing. *
** Requires permission to access the ListJobExecutionsForThing action. *
* * @param listJobExecutionsForThingRequest * @return listJobExecutionsForThingResult The response from the * ListJobExecutionsForThing service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListJobExecutionsForThingResult listJobExecutionsForThing( ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a list of job templates. *
** Requires permission to access the ListJobTemplates action. *
* * @param listJobTemplatesRequest * @return listJobTemplatesResult The response from the ListJobTemplates * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists jobs. *
** Requires permission to access the ListJobs action. *
* * @param listJobsRequest * @return listJobsResult The response from the ListJobs service method, as * returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListJobsResult listJobs(ListJobsRequest listJobsRequest) throws AmazonClientException, AmazonServiceException; /** ** Returns a list of managed job templates. *
* * @param listManagedJobTemplatesRequest * @return listManagedJobTemplatesResult The response from the * ListManagedJobTemplates service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalServerException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListManagedJobTemplatesResult listManagedJobTemplates( ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param listMetricValuesRequest * @return listMetricValuesResult The response from the ListMetricValues * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListMetricValuesResult listMetricValues(ListMetricValuesRequest listMetricValuesRequest) throws AmazonClientException, AmazonServiceException; /** ** Gets a list of all mitigation actions that match the specified filter * criteria. *
** Requires permission to access the ListMitigationActions action. *
* * @param listMitigationActionsRequest * @return listMitigationActionsResult The response from the * ListMitigationActions service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListMitigationActionsResult listMitigationActions( ListMitigationActionsRequest listMitigationActionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists OTA updates. *
** Requires permission to access the ListOTAUpdates action. *
* * @param listOTAUpdatesRequest * @return listOTAUpdatesResult The response from the ListOTAUpdates service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists certificates that are being transferred but not yet accepted. *
** Requires permission to access the ListOutgoingCertificates action. *
* * @param listOutgoingCertificatesRequest* The input to the ListOutgoingCertificates operation. *
* @return listOutgoingCertificatesResult The response from the * ListOutgoingCertificates service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListOutgoingCertificatesResult listOutgoingCertificates( ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the software package versions associated to the account. *
** Requires permission to access the ListPackageVersions action. *
* * @param listPackageVersionsRequest * @return listPackageVersionsResult The response from the * ListPackageVersions service method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListPackageVersionsResult listPackageVersions( ListPackageVersionsRequest listPackageVersionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the software packages associated to the account. *
** Requires permission to access the ListPackages action. *
* * @param listPackagesRequest * @return listPackagesResult The response from the ListPackages service * method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists your policies. *
** Requires permission to access the ListPolicies action. *
* * @param listPoliciesRequest* The input for the ListPolicies operation. *
* @return listPoliciesResult The response from the ListPolicies service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists 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. *
* * @param listPolicyPrincipalsRequest* The input for the ListPolicyPrincipals operation. *
* @return listPolicyPrincipalsResult The response from the * ListPolicyPrincipals service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ @Deprecated ListPolicyPrincipalsResult listPolicyPrincipals( ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the versions of the specified policy and identifies the default * version. *
** Requires permission to access the ListPolicyVersions action. *
* * @param listPolicyVersionsRequest* The input for the ListPolicyVersions operation. *
* @return listPolicyVersionsResult The response from the ListPolicyVersions * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the 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. *
* * @param listPrincipalPoliciesRequest* The input for the ListPrincipalPolicies operation. *
* @return listPrincipalPoliciesResult The response from the * ListPrincipalPolicies service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ @Deprecated ListPrincipalPoliciesResult listPrincipalPolicies( ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the 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. *
* * @param listPrincipalThingsRequest* The input for the ListPrincipalThings operation. *
* @return listPrincipalThingsResult The response from the * ListPrincipalThings service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListPrincipalThingsResult listPrincipalThings( ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonClientException, AmazonServiceException; /** ** A list of provisioning template versions. *
** Requires permission to access the ListProvisioningTemplateVersions action. *
* * @param listProvisioningTemplateVersionsRequest * @return listProvisioningTemplateVersionsResult The response from the * ListProvisioningTemplateVersions service method, as returned by * AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions( ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the provisioning templates in your Amazon Web Services account. *
** Requires permission to access the ListProvisioningTemplates action. *
* * @param listProvisioningTemplatesRequest * @return listProvisioningTemplatesResult The response from the * ListProvisioningTemplates service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListProvisioningTemplatesResult listProvisioningTemplates( ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
** Lists the role aliases registered in your account. *
** Requires permission to access the ListRoleAliases action. *
* * @param listRoleAliasesRequest * @return listRoleAliasesResult The response from the ListRoleAliases * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists all of your scheduled audits. *
** Requires permission to access the ListScheduledAudits action. *
* * @param listScheduledAuditsRequest * @return listScheduledAuditsResult The response from the * ListScheduledAudits service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListScheduledAuditsResult listScheduledAudits( ListScheduledAuditsRequest listScheduledAuditsRequest) throws AmazonClientException, AmazonServiceException; /** ** 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.
*
* Lists the Device Defender security profiles attached to a target (thing * group). *
** Requires permission to access the ListSecurityProfilesForTarget action. *
* * @param listSecurityProfilesForTargetRequest * @return listSecurityProfilesForTargetResult The response from the * ListSecurityProfilesForTarget service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListSecurityProfilesForTargetResult listSecurityProfilesForTarget( ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists all of the streams in your Amazon Web Services account. *
** Requires permission to access the ListStreams action. *
* * @param listStreamsRequest * @return listStreamsResult The response from the ListStreams service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the tags (metadata) you have assigned to the resource. *
** Requires permission to access the ListTagsForResource action. *
* * @param listTagsForResourceRequest * @return listTagsForResourceResult The response from the * ListTagsForResource service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListTagsForResourceResult listTagsForResource( ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** List targets for the specified policy. *
** Requires permission to access the ListTargetsForPolicy action. *
* * @param listTargetsForPolicyRequest * @return listTargetsForPolicyResult The response from the * ListTargetsForPolicy service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListTargetsForPolicyResult listTargetsForPolicy( ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the targets (thing groups) associated with a given Device Defender * security profile. *
** Requires permission to access the ListTargetsForSecurityProfile action. *
* * @param listTargetsForSecurityProfileRequest * @return listTargetsForSecurityProfileResult The response from the * ListTargetsForSecurityProfile service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListTargetsForSecurityProfileResult listTargetsForSecurityProfile( ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** List the thing groups in your account. *
** Requires permission to access the ListThingGroups action. *
* * @param listThingGroupsRequest * @return listThingGroupsResult The response from the ListThingGroups * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest) throws AmazonClientException, AmazonServiceException; /** ** List the thing groups to which the specified thing belongs. *
** Requires permission to access the ListThingGroupsForThing action. *
* * @param listThingGroupsForThingRequest * @return listThingGroupsForThingResult The response from the * ListThingGroupsForThing service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingGroupsForThingResult listThingGroupsForThing( ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param listThingPrincipalsRequest* The input for the ListThingPrincipal operation. *
* @return listThingPrincipalsResult The response from the * ListThingPrincipals service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingPrincipalsResult listThingPrincipals( ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonClientException, AmazonServiceException; /** ** Information about the thing registration tasks. *
* * @param listThingRegistrationTaskReportsRequest * @return listThingRegistrationTaskReportsResult The response from the * ListThingRegistrationTaskReports service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports( ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws AmazonClientException, AmazonServiceException; /** ** List bulk thing provisioning tasks. *
** Requires permission to access the ListThingRegistrationTasks action. *
* * @param listThingRegistrationTasksRequest * @return listThingRegistrationTasksResult The response from the * ListThingRegistrationTasks service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingRegistrationTasksResult listThingRegistrationTasks( ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the existing thing types. *
** Requires permission to access the ListThingTypes action. *
* * @param listThingTypesRequest* The input for the ListThingTypes operation. *
* @return listThingTypesResult The response from the ListThingTypes service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest) throws AmazonClientException, AmazonServiceException; /** *
* Lists 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.
*
* The input for the ListThings operation. *
* @return listThingsResult The response from the ListThings service method, * as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the things you have added to the given billing group. *
** Requires permission to access the ListThingsInBillingGroup action. *
* * @param listThingsInBillingGroupRequest * @return listThingsInBillingGroupResult The response from the * ListThingsInBillingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingsInBillingGroupResult listThingsInBillingGroup( ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the things in the specified group. *
** Requires permission to access the ListThingsInThingGroup action. *
* * @param listThingsInThingGroupRequest * @return listThingsInThingGroupResult The response from the * ListThingsInThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListThingsInThingGroupResult listThingsInThingGroup( ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists all the topic rule destinations in your Amazon Web Services * account. *
** Requires permission to access the ListTopicRuleDestinations action. *
* * @param listTopicRuleDestinationsRequest * @return listTopicRuleDestinationsResult The response from the * ListTopicRuleDestinations service method, as returned by AWS IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListTopicRuleDestinationsResult listTopicRuleDestinations( ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists the rules for the specific topic. *
** Requires permission to access the ListTopicRules action. *
* * @param listTopicRulesRequest* The input for the ListTopicRules operation. *
* @return listTopicRulesResult The response from the ListTopicRules service * method, as returned by AWS IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists logging levels. *
** Requires permission to access the ListV2LoggingLevels action. *
* * @param listV2LoggingLevelsRequest * @return listV2LoggingLevelsResult The response from the * ListV2LoggingLevels service method, as returned by AWS IoT. * @throws InternalException * @throws NotConfiguredException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListV2LoggingLevelsResult listV2LoggingLevels( ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws AmazonClientException, AmazonServiceException; /** ** Lists 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. *
* * @param listViolationEventsRequest * @return listViolationEventsResult The response from the * ListViolationEvents service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ListViolationEventsResult listViolationEvents( ListViolationEventsRequest listViolationEventsRequest) throws AmazonClientException, AmazonServiceException; /** ** Set a verification state and provide a description of that verification * state on a violation (detect alarm). *
* * @param putVerificationStateOnViolationRequest * @return putVerificationStateOnViolationResult The response from the * PutVerificationStateOnViolation service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ PutVerificationStateOnViolationResult putVerificationStateOnViolation( PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest) throws AmazonClientException, AmazonServiceException; /** *
* 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. *
* * @param registerCACertificateRequest* The input to the RegisterCACertificate operation. *
* @return registerCACertificateResult The response from the * RegisterCACertificate service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws ResourceAlreadyExistsException * @throws RegistrationCodeValidationException * @throws InvalidRequestException * @throws CertificateValidationException * @throws ThrottlingException * @throws LimitExceededException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ RegisterCACertificateResult registerCACertificate( RegisterCACertificateRequest registerCACertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Registers a 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. *
* * @param registerCertificateRequest* The input to the RegisterCertificate operation. *
* @return registerCertificateResult The response from the * RegisterCertificate service method, as returned by AWS IoT. * @throws ResourceAlreadyExistsException * @throws InvalidRequestException * @throws CertificateValidationException * @throws CertificateStateException * @throws CertificateConflictException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ RegisterCertificateResult registerCertificate( RegisterCertificateRequest registerCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Register a certificate that does not have a certificate authority (CA). * For supported certificates, consult Certificate signing algorithms supported by IoT. *
* * @param registerCertificateWithoutCARequest * @return registerCertificateWithoutCAResult The response from the * RegisterCertificateWithoutCA service method, as returned by AWS * IoT. * @throws ResourceAlreadyExistsException * @throws InvalidRequestException * @throws CertificateStateException * @throws CertificateValidationException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ RegisterCertificateWithoutCAResult registerCertificateWithoutCA( RegisterCertificateWithoutCARequest registerCertificateWithoutCARequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param registerThingRequest * @return registerThingResult The response from the RegisterThing service * method, as returned by AWS IoT. * @throws InternalFailureException * @throws ServiceUnavailableException * @throws InvalidRequestException * @throws UnauthorizedException * @throws ThrottlingException * @throws ConflictingResourceUpdateException * @throws ResourceRegistrationFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ RegisterThingResult registerThing(RegisterThingRequest registerThingRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param rejectCertificateTransferRequest* The input for the RejectCertificateTransfer operation. *
* @throws ResourceNotFoundException * @throws TransferAlreadyCompletedException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
** 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. *
* * @param removeThingFromThingGroupRequest * @return removeThingFromThingGroupResult The response from the * RemoveThingFromThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ RemoveThingFromThingGroupResult removeThingFromThingGroup( RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param replaceTopicRuleRequest* The input for the ReplaceTopicRule operation. *
* @throws SqlParseException * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonClientException, AmazonServiceException; /** ** The query search index. *
** Requires permission to access the SearchIndex action. *
* * @param searchIndexRequest * @return searchIndexResult The response from the SearchIndex service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param setDefaultAuthorizerRequest * @return setDefaultAuthorizerResult The response from the * SetDefaultAuthorizer service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceAlreadyExistsException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ SetDefaultAuthorizerResult setDefaultAuthorizer( SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the 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. *
* * @param setDefaultPolicyVersionRequest* The input for the SetDefaultPolicyVersion operation. *
* @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the logging options. *
*
* NOTE: use of this command is not recommended. Use
* SetV2LoggingOptions
instead.
*
* Requires permission to access the SetLoggingOptions action. *
* * @param setLoggingOptionsRequest* The input for the SetLoggingOptions operation. *
* @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the logging level. *
** Requires permission to access the SetV2LoggingLevel action. *
* * @param setV2LoggingLevelRequest * @throws InternalException * @throws NotConfiguredException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException; /** ** Sets the logging options for the V2 logging service. *
** Requires permission to access the SetV2LoggingOptions action. *
* * @param setV2LoggingOptionsRequest * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException; /** ** Starts a task that applies a set of mitigation actions to the specified * target. *
** Requires permission to access the StartAuditMitigationActionsTask action. *
* * @param startAuditMitigationActionsTaskRequest * @return startAuditMitigationActionsTaskResult The response from the * StartAuditMitigationActionsTask service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws TaskAlreadyExistsException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask( StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Starts a Device Defender ML Detect mitigation actions task. *
** Requires permission to access the StartDetectMitigationActionsTask action. *
* * @param startDetectMitigationActionsTaskRequest * @return startDetectMitigationActionsTaskResult The response from the * StartDetectMitigationActionsTask service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws TaskAlreadyExistsException * @throws LimitExceededException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask( StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Starts an on-demand Device Defender audit. *
** Requires permission to access the StartOnDemandAuditTask action. *
* * @param startOnDemandAuditTaskRequest * @return startOnDemandAuditTaskResult The response from the * StartOnDemandAuditTask service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ StartOnDemandAuditTaskResult startOnDemandAuditTask( StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Creates a bulk thing provisioning task. *
** Requires permission to access the StartThingRegistrationTask action. *
* * @param startThingRegistrationTaskRequest * @return startThingRegistrationTaskResult The response from the * StartThingRegistrationTask service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ StartThingRegistrationTaskResult startThingRegistrationTask( StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** Cancels a bulk thing provisioning task. *
** Requires permission to access the StopThingRegistrationTask action. *
* * @param stopThingRegistrationTaskRequest * @return stopThingRegistrationTaskResult The response from the * StopThingRegistrationTask service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ StopThingRegistrationTaskResult stopThingRegistrationTask( StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param tagResourceRequest * @return tagResourceResult The response from the TagResource service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param testAuthorizationRequest * @return testAuthorizationResult The response from the TestAuthorization * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws LimitExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest) throws AmazonClientException, AmazonServiceException; /** ** Tests 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. *
* * @param testInvokeAuthorizerRequest * @return testInvokeAuthorizerResult The response from the * TestInvokeAuthorizer service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws InvalidResponseException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ TestInvokeAuthorizerResult testInvokeAuthorizer( TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param transferCertificateRequest* The input for the TransferCertificate operation. *
* @return transferCertificateResult The response from the * TransferCertificate service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws CertificateStateException * @throws TransferConflictException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ TransferCertificateResult transferCertificate( TransferCertificateRequest transferCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Removes the given tags (metadata) from the resource. *
** Requires permission to access the UntagResource action. *
* * @param untagResourceRequest * @return untagResourceResult The response from the UntagResource service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param updateAccountAuditConfigurationRequest * @return updateAccountAuditConfigurationResult The response from the * UpdateAccountAuditConfiguration service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration( UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a Device Defender audit suppression. *
* * @param updateAuditSuppressionRequest * @return updateAuditSuppressionResult The response from the * UpdateAuditSuppression service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateAuditSuppressionResult updateAuditSuppression( UpdateAuditSuppressionRequest updateAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates an authorizer. *
** Requires permission to access the UpdateAuthorizer action. *
* * @param updateAuthorizerRequest * @return updateAuthorizerResult The response from the UpdateAuthorizer * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws LimitExceededException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates information about the billing group. *
** Requires permission to access the UpdateBillingGroup action. *
* * @param updateBillingGroupRequest * @return updateBillingGroupResult The response from the UpdateBillingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a registered CA certificate. *
** Requires permission to access the UpdateCACertificate action. *
* * @param updateCACertificateRequest* The input to the UpdateCACertificate operation. *
* @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates 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. *
* * @param updateCertificateRequest* The input for the UpdateCertificate operation. *
* @throws ResourceNotFoundException * @throws CertificateStateException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a Device Defender detect custom metric. *
** Requires permission to access the UpdateCustomMetric action. *
* * @param updateCustomMetricRequest * @return updateCustomMetricResult The response from the UpdateCustomMetric * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param updateDimensionRequest * @return updateDimensionResult The response from the UpdateDimension * service method, as returned by AWS IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateDimensionResult updateDimension(UpdateDimensionRequest updateDimensionRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates values stored in the domain configuration. Domain configurations * for default endpoints can't be updated. *
** Requires permission to access the UpdateDomainConfiguration action. *
* * @param updateDomainConfigurationRequest * @return updateDomainConfigurationResult The response from the * UpdateDomainConfiguration service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws CertificateValidationException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateDomainConfigurationResult updateDomainConfiguration( UpdateDomainConfigurationRequest updateDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a dynamic thing group. *
** Requires permission to access the UpdateDynamicThingGroup action. *
* * @param updateDynamicThingGroupRequest * @return updateDynamicThingGroupResult The response from the * UpdateDynamicThingGroup service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateDynamicThingGroupResult updateDynamicThingGroup( UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the event configurations. *
** Requires permission to access the UpdateEventConfigurations action. *
* * @param updateEventConfigurationsRequest * @return updateEventConfigurationsResult The response from the * UpdateEventConfigurations service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws InternalFailureException * @throws ThrottlingException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateEventConfigurationsResult updateEventConfigurations( UpdateEventConfigurationsRequest updateEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the data for a fleet metric. *
** Requires permission to access the UpdateFleetMetric action. *
* * @param updateFleetMetricRequest * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws InvalidQueryException * @throws InvalidAggregationException * @throws VersionConflictException * @throws IndexNotReadyException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the search configuration. *
** Requires permission to access the UpdateIndexingConfiguration action. *
* * @param updateIndexingConfigurationRequest * @return updateIndexingConfigurationResult The response from the * UpdateIndexingConfiguration service method, as returned by AWS * IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateIndexingConfigurationResult updateIndexingConfiguration( UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates supported fields of the specified job. *
** Requires permission to access the UpdateJob action. *
* * @param updateJobRequest * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws ServiceUnavailableException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ void updateJob(UpdateJobRequest updateJobRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the definition for the specified mitigation action. *
** Requires permission to access the UpdateMitigationAction action. *
* * @param updateMitigationActionRequest * @return updateMitigationActionResult The response from the * UpdateMitigationAction service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateMitigationActionResult updateMitigationAction( UpdateMitigationActionRequest updateMitigationActionRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the supported fields for a specific package. *
** Requires permission to access the UpdatePackage and GetIndexingConfiguration actions. *
* * @param updatePackageRequest * @return updatePackageResult The response from the UpdatePackage service * method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the package configuration. *
** Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions. *
* * @param updatePackageConfigurationRequest * @return updatePackageConfigurationResult The response from the * UpdatePackageConfiguration service method, as returned by AWS * IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdatePackageConfigurationResult updatePackageConfiguration( UpdatePackageConfigurationRequest updatePackageConfigurationRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the supported fields for a specific package version. *
** Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions. *
* * @param updatePackageVersionRequest * @return updatePackageVersionResult The response from the * UpdatePackageVersion service method, as returned by AWS IoT. * @throws ThrottlingException * @throws InternalServerException * @throws ValidationException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdatePackageVersionResult updatePackageVersion( UpdatePackageVersionRequest updatePackageVersionRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a provisioning template. *
** Requires permission to access the UpdateProvisioningTemplate action. *
* * @param updateProvisioningTemplateRequest * @return updateProvisioningTemplateResult The response from the * UpdateProvisioningTemplate service method, as returned by AWS * IoT. * @throws InternalFailureException * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateProvisioningTemplateResult updateProvisioningTemplate( UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a role alias. *
** Requires permission to access the UpdateRoleAlias action. *
* * @param updateRoleAliasRequest * @return updateRoleAliasResult The response from the UpdateRoleAlias * service method, as returned by AWS IoT. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a scheduled audit, including which checks are performed and how * often the audit takes place. *
** Requires permission to access the UpdateScheduledAudit action. *
* * @param updateScheduledAuditRequest * @return updateScheduledAuditResult The response from the * UpdateScheduledAudit service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateScheduledAuditResult updateScheduledAudit( UpdateScheduledAuditRequest updateScheduledAuditRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates a Device Defender security profile. *
** Requires permission to access the UpdateSecurityProfile action. *
* * @param updateSecurityProfileRequest * @return updateSecurityProfileResult The response from the * UpdateSecurityProfile service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateSecurityProfileResult updateSecurityProfile( UpdateSecurityProfileRequest updateSecurityProfileRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates an existing stream. The stream version will be incremented by * one. *
** Requires permission to access the UpdateStream action. *
* * @param updateStreamRequest * @return updateStreamResult The response from the UpdateStream service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the data for a thing. *
** Requires permission to access the UpdateThing action. *
* * @param updateThingRequest* The input for the UpdateThing operation. *
* @return updateThingResult The response from the UpdateThing service * method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Update a thing group. *
** Requires permission to access the UpdateThingGroup action. *
* * @param updateThingGroupRequest * @return updateThingGroupResult The response from the UpdateThingGroup * service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws VersionConflictException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates the groups to which the thing belongs. *
** Requires permission to access the UpdateThingGroupsForThing action. *
* * @param updateThingGroupsForThingRequest * @return updateThingGroupsForThingResult The response from the * UpdateThingGroupsForThing service method, as returned by AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws ResourceNotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateThingGroupsForThingResult updateThingGroupsForThing( UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException; /** ** Updates 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. *
* * @param updateTopicRuleDestinationRequest * @return updateTopicRuleDestinationResult The response from the * UpdateTopicRuleDestination service method, as returned by AWS * IoT. * @throws InternalException * @throws InvalidRequestException * @throws ServiceUnavailableException * @throws UnauthorizedException * @throws ConflictingResourceUpdateException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ UpdateTopicRuleDestinationResult updateTopicRuleDestination( UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException; /** ** Validates a Device Defender security profile behaviors specification. *
** Requires permission to access the ValidateSecurityProfileBehaviors action. *
* * @param validateSecurityProfileBehaviorsRequest * @return validateSecurityProfileBehaviorsResult The response from the * ValidateSecurityProfileBehaviors service method, as returned by * AWS IoT. * @throws InvalidRequestException * @throws ThrottlingException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by AWS * IoT indicating either a problem with the data in the request, * or a server side issue. */ ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors( ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest) throws AmazonClientException, AmazonServiceException; /** * Shuts down this client object, releasing any resources that might be held * open. This is an optional method, and callers are not expected to call * it, but can if they want to explicitly release any open resources. Once a * client has been shutdown, it should not be used to make any more * requests. */ public void shutdown(); /** * Returns additional metadata for a previously executed successful request, * typically used for debugging issues where a service isn't acting as * expected. This data isn't considered part of the result data returned by * an operation, so it's available through this separate, diagnostic * interface. ** Response metadata is only cached for a limited period of time, so if you * need to access this extra diagnostic information for an executed request, * you should use this method to retrieve it as soon as possible after * executing a request. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }