com.amazonaws.services.iot.AWSIot Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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 javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.iot.model.*;
/**
* Interface for accessing AWS IoT.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.iot.AbstractAWSIot} instead.
*
*
* AWS IoT
*
* AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators,
* embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to
* communicate with, configure rules for data processing and integration with other services, organize resources
* associated with each device (Registry), configure logging, and create and manage policies and credentials to
* authenticate devices.
*
*
* The service endpoints that expose this API are listed in AWS 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 AWS
* Signature Version 4 to sign the request is: execute-api.
*
*
* For more information about how AWS IoT works, see the Developer Guide.
*
*
* For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to
* AWS Services.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIot {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "iot";
/**
* 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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* 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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* 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. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* @param acceptCertificateTransferRequest
* The input for the AcceptCertificateTransfer operation.
* @return Result of the AcceptCertificateTransfer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws TransferAlreadyCompletedException
* You can't revert the certificate transfer because the transfer is already complete.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.AcceptCertificateTransfer
*/
AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest);
/**
*
* Adds a thing to a billing group.
*
*
* @param addThingToBillingGroupRequest
* @return Result of the AddThingToBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.AddThingToBillingGroup
*/
AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest);
/**
*
* Adds a thing to a thing group.
*
*
* @param addThingToThingGroupRequest
* @return Result of the AddThingToThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.AddThingToThingGroup
*/
AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest);
/**
*
* 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.
*
*
*
*
* @param associateTargetsWithJobRequest
* @return Result of the AssociateTargetsWithJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.AssociateTargetsWithJob
*/
AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest);
/**
*
* Attaches a policy to the specified target.
*
*
* @param attachPolicyRequest
* @return Result of the AttachPolicy operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.AttachPolicy
*/
AttachPolicyResult attachPolicy(AttachPolicyRequest attachPolicyRequest);
/**
*
* Attaches the specified policy to the specified principal (certificate or other credential).
*
*
* Note: This API is deprecated. Please use AttachPolicy instead.
*
*
* @param attachPrincipalPolicyRequest
* The input for the AttachPrincipalPolicy operation.
* @return Result of the AttachPrincipalPolicy operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.AttachPrincipalPolicy
*/
@Deprecated
AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest);
/**
*
* 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.
*
*
* @param attachSecurityProfileRequest
* @return Result of the AttachSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.AttachSecurityProfile
*/
AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest);
/**
*
* Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users,
* groups, and roles, Amazon Cognito identities or federated identities.
*
*
* @param attachThingPrincipalRequest
* The input for the AttachThingPrincipal operation.
* @return Result of the AttachThingPrincipal operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.AttachThingPrincipal
*/
AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest);
/**
*
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException
* occurs.
*
*
* @param cancelAuditMitigationActionsTaskRequest
* @return Result of the CancelAuditMitigationActionsTask operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CancelAuditMitigationActionsTask
*/
CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest);
/**
*
* Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in
* progress, an "InvalidRequestException" occurs.
*
*
* @param cancelAuditTaskRequest
* @return Result of the CancelAuditTask operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CancelAuditTask
*/
CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest);
/**
*
* Cancels a pending transfer for the specified certificate.
*
*
* Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations
* can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source
* account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be
* cancelled.
*
*
* After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to
* INACTIVE.
*
*
* @param cancelCertificateTransferRequest
* The input for the CancelCertificateTransfer operation.
* @return Result of the CancelCertificateTransfer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws TransferAlreadyCompletedException
* You can't revert the certificate transfer because the transfer is already complete.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CancelCertificateTransfer
*/
CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest);
/**
*
* Cancels a job.
*
*
* @param cancelJobRequest
* @return Result of the CancelJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.CancelJob
*/
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest);
/**
*
* Cancels the execution of a job for a given thing.
*
*
* @param cancelJobExecutionRequest
* @return Result of the CancelJobExecution operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InvalidStateTransitionException
* An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
* is "IN_PROGRESS" without setting the force parameter.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.CancelJobExecution
*/
CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest);
/**
*
* Clears the default authorizer.
*
*
* @param clearDefaultAuthorizerRequest
* @return Result of the ClearDefaultAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ClearDefaultAuthorizer
*/
ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest);
/**
*
* Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation
* message to the endpoint or base address you specify. The message includes a token which you pass back when
* calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
*
*
* @param confirmTopicRuleDestinationRequest
* @return Result of the ConfirmTopicRuleDestination operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.ConfirmTopicRuleDestination
*/
ConfirmTopicRuleDestinationResult confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest);
/**
*
* Creates a Device Defender audit suppression.
*
*
* @param createAuditSuppressionRequest
* @return Result of the CreateAuditSuppression operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.CreateAuditSuppression
*/
CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest);
/**
*
* Creates an authorizer.
*
*
* @param createAuthorizerRequest
* @return Result of the CreateAuthorizer operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateAuthorizer
*/
CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest);
/**
*
* Creates a billing group.
*
*
* @param createBillingGroupRequest
* @return Result of the CreateBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateBillingGroup
*/
CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest);
/**
*
* Creates an X.509 certificate using the specified certificate signing request.
*
*
* Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or
* an ECC key from NIST P-256 or NIST P-384 curves.
*
*
* Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
*
*
* You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that
* directory, and then specifying that directory on the command line. The following commands show how to create a
* batch of certificates given a batch of CSRs.
*
*
* Assuming a set of CSRs are located inside of the directory my-csr-directory:
*
*
* On Linux and OS X, the command is:
*
*
* $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request
* file://my-csr-directory/{}
*
*
* This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot
* create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
*
*
* The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the
* certificate creation process:
*
*
* $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request
* file://my-csr-directory/{}
*
*
* On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
*
*
* > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request
* file://my-csr-directory/$_}
*
*
* On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
*
*
* > forfiles /p my-csr-directory /c
* "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*
*
* @param createCertificateFromCsrRequest
* The input for the CreateCertificateFromCsr operation.
* @return Result of the CreateCertificateFromCsr operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateCertificateFromCsr
*/
CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest);
/**
*
* Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS 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.
*
*
* @param createDimensionRequest
* @return Result of the CreateDimension operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.CreateDimension
*/
CreateDimensionResult createDimension(CreateDimensionRequest createDimensionRequest);
/**
*
* Creates a domain configuration.
*
*
*
* The domain configuration feature is in public preview and is subject to change.
*
*
*
* @param createDomainConfigurationRequest
* @return Result of the CreateDomainConfiguration operation returned by the service.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws CertificateValidationException
* The certificate is invalid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.CreateDomainConfiguration
*/
CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest);
/**
*
* Creates a dynamic thing group.
*
*
* @param createDynamicThingGroupRequest
* @return Result of the CreateDynamicThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidQueryException
* The query is invalid.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.CreateDynamicThingGroup
*/
CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest);
/**
*
* Creates a job.
*
*
* @param createJobRequest
* @return Result of the CreateJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.CreateJob
*/
CreateJobResult createJob(CreateJobRequest createJobRequest);
/**
*
* Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
* CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.
*
*
* Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep
* it in a secure location.
*
*
* @param createKeysAndCertificateRequest
* The input for the CreateKeysAndCertificate operation.
* @return Result of the CreateKeysAndCertificate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateKeysAndCertificate
*/
CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest);
/**
*
* 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.
*
*
* @param createMitigationActionRequest
* @return Result of the CreateMitigationAction operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateMitigationAction
*/
CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest);
/**
*
* Creates an AWS IoT OTAUpdate on a target group of things or groups.
*
*
* @param createOTAUpdateRequest
* @return Result of the CreateOTAUpdate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.CreateOTAUpdate
*/
CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest);
/**
*
* Creates an AWS IoT policy.
*
*
* The created policy is the default version for the policy. This operation creates a policy version with a version
* identifier of 1 and sets 1 as the policy's default version.
*
*
* @param createPolicyRequest
* The input for the CreatePolicy operation.
* @return Result of the CreatePolicy operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws MalformedPolicyException
* The policy documentation is not valid.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreatePolicy
*/
CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest);
/**
*
* Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed
* policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to
* delete an existing version before you create a new one.
*
*
* Optionally, you can set the new version as the policy's default version. The default version is the operative
* version (that is, the version that is in effect for the certificates to which the policy is attached).
*
*
* @param createPolicyVersionRequest
* The input for the CreatePolicyVersion operation.
* @return Result of the CreatePolicyVersion operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws MalformedPolicyException
* The policy documentation is not valid.
* @throws VersionsLimitExceededException
* The number of policy versions exceeds the limit.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreatePolicyVersion
*/
CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest);
/**
*
* Creates a provisioning claim.
*
*
* @param createProvisioningClaimRequest
* @return Result of the CreateProvisioningClaim operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateProvisioningClaim
*/
CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest);
/**
*
* Creates a fleet provisioning template.
*
*
* @param createProvisioningTemplateRequest
* @return Result of the CreateProvisioningTemplate operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @sample AWSIot.CreateProvisioningTemplate
*/
CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest);
/**
*
* Creates a new version of a fleet provisioning template.
*
*
* @param createProvisioningTemplateVersionRequest
* @return Result of the CreateProvisioningTemplateVersion operation returned by the service.
* @throws VersionsLimitExceededException
* The number of policy versions exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.CreateProvisioningTemplateVersion
*/
CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest);
/**
*
* Creates a role alias.
*
*
* @param createRoleAliasRequest
* @return Result of the CreateRoleAlias operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateRoleAlias
*/
CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest);
/**
*
* Creates a scheduled audit that is run at a specified time interval.
*
*
* @param createScheduledAuditRequest
* @return Result of the CreateScheduledAudit operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.CreateScheduledAudit
*/
CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest);
/**
*
* Creates a Device Defender security profile.
*
*
* @param createSecurityProfileRequest
* @return Result of the CreateSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateSecurityProfile
*/
CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest);
/**
*
* 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.
*
*
* @param createStreamRequest
* @return Result of the CreateStream operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateStream
*/
CreateStreamResult createStream(CreateStreamRequest createStreamRequest);
/**
*
* 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.
*
*
*
* @param createThingRequest
* The input for the CreateThing operation.
* @return Result of the CreateThing operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.CreateThing
*/
CreateThingResult createThing(CreateThingRequest createThingRequest);
/**
*
* Create a thing group.
*
*
*
* This is a control plane operation. See Authorization for
* information about authorizing control plane actions.
*
*
*
* @param createThingGroupRequest
* @return Result of the CreateThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.CreateThingGroup
*/
CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest);
/**
*
* Creates a new thing type.
*
*
* @param createThingTypeRequest
* The input for the CreateThingType operation.
* @return Result of the CreateThingType operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @sample AWSIot.CreateThingType
*/
CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest);
/**
*
* 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.
*
*
* @param createTopicRuleRequest
* The input for the CreateTopicRule operation.
* @return Result of the CreateTopicRule operation returned by the service.
* @throws SqlParseException
* The Rule-SQL expression can't be parsed correctly.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.CreateTopicRule
*/
CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest createTopicRuleRequest);
/**
*
* Creates a topic rule destination. The destination must be confirmed prior to use.
*
*
* @param createTopicRuleDestinationRequest
* @return Result of the CreateTopicRuleDestination operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.CreateTopicRuleDestination
*/
CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest);
/**
*
* 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.
*
*
* @param deleteAccountAuditConfigurationRequest
* @return Result of the DeleteAccountAuditConfiguration operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteAccountAuditConfiguration
*/
DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest);
/**
*
* Deletes a Device Defender audit suppression.
*
*
* @param deleteAuditSuppressionRequest
* @return Result of the DeleteAuditSuppression operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteAuditSuppression
*/
DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest);
/**
*
* Deletes an authorizer.
*
*
* @param deleteAuthorizerRequest
* @return Result of the DeleteAuthorizer operation returned by the service.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteAuthorizer
*/
DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest);
/**
*
* Deletes the billing group.
*
*
* @param deleteBillingGroupRequest
* @return Result of the DeleteBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteBillingGroup
*/
DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest);
/**
*
* Deletes a registered CA certificate.
*
*
* @param deleteCACertificateRequest
* Input for the DeleteCACertificate operation.
* @return Result of the DeleteCACertificate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DeleteCACertificate
*/
DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest);
/**
*
* Deletes the specified certificate.
*
*
* A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE.
* To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the
* UpdateCertificate API to set the certificate to the INACTIVE status.
*
*
* @param deleteCertificateRequest
* The input for the DeleteCertificate operation.
* @return Result of the DeleteCertificate operation returned by the service.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DeleteCertificate
*/
DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest);
/**
*
* Removes the specified dimension from your AWS account.
*
*
* @param deleteDimensionRequest
* @return Result of the DeleteDimension operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.DeleteDimension
*/
DeleteDimensionResult deleteDimension(DeleteDimensionRequest deleteDimensionRequest);
/**
*
* Deletes the specified domain configuration.
*
*
*
* The domain configuration feature is in public preview and is subject to change.
*
*
*
* @param deleteDomainConfigurationRequest
* @return Result of the DeleteDomainConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @sample AWSIot.DeleteDomainConfiguration
*/
DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest);
/**
*
* Deletes a dynamic thing group.
*
*
* @param deleteDynamicThingGroupRequest
* @return Result of the DeleteDynamicThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteDynamicThingGroup
*/
DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest);
/**
*
* 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.
*
*
* @param deleteJobRequest
* @return Result of the DeleteJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InvalidStateTransitionException
* An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
* is "IN_PROGRESS" without setting the force parameter.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.DeleteJob
*/
DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest);
/**
*
* Deletes a job execution.
*
*
* @param deleteJobExecutionRequest
* @return Result of the DeleteJobExecution operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InvalidStateTransitionException
* An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
* is "IN_PROGRESS" without setting the force parameter.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.DeleteJobExecution
*/
DeleteJobExecutionResult deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest);
/**
*
* Deletes a defined mitigation action from your AWS account.
*
*
* @param deleteMitigationActionRequest
* @return Result of the DeleteMitigationAction operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteMitigationAction
*/
DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest);
/**
*
* Delete an OTA update.
*
*
* @param deleteOTAUpdateRequest
* @return Result of the DeleteOTAUpdate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.DeleteOTAUpdate
*/
DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest);
/**
*
* Deletes the specified policy.
*
*
* A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
*
*
* To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the
* DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete
* the policy.
*
*
* When a policy is deleted using DeletePolicy, its default version is deleted with it.
*
*
* @param deletePolicyRequest
* The input for the DeletePolicy operation.
* @return Result of the DeletePolicy operation returned by the service.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeletePolicy
*/
DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest);
/**
*
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using
* this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a
* policy is marked as the default version, use ListPolicyVersions.
*
*
* @param deletePolicyVersionRequest
* The input for the DeletePolicyVersion operation.
* @return Result of the DeletePolicyVersion operation returned by the service.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeletePolicyVersion
*/
DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest);
/**
*
* Deletes a fleet provisioning template.
*
*
* @param deleteProvisioningTemplateRequest
* @return Result of the DeleteProvisioningTemplate operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.DeleteProvisioningTemplate
*/
DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest);
/**
*
* Deletes a fleet provisioning template version.
*
*
* @param deleteProvisioningTemplateVersionRequest
* @return Result of the DeleteProvisioningTemplateVersion operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @sample AWSIot.DeleteProvisioningTemplateVersion
*/
DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest);
/**
*
* Deletes a CA certificate registration code.
*
*
* @param deleteRegistrationCodeRequest
* The input for the DeleteRegistrationCode operation.
* @return Result of the DeleteRegistrationCode operation returned by the service.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteRegistrationCode
*/
DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest);
/**
*
* Deletes a role alias
*
*
* @param deleteRoleAliasRequest
* @return Result of the DeleteRoleAlias operation returned by the service.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DeleteRoleAlias
*/
DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest);
/**
*
* Deletes a scheduled audit.
*
*
* @param deleteScheduledAuditRequest
* @return Result of the DeleteScheduledAudit operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteScheduledAudit
*/
DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest);
/**
*
* Deletes a Device Defender security profile.
*
*
* @param deleteSecurityProfileRequest
* @return Result of the DeleteSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.DeleteSecurityProfile
*/
DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest);
/**
*
* Deletes a stream.
*
*
* @param deleteStreamRequest
* @return Result of the DeleteStream operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws DeleteConflictException
* You can't delete the resource because it is attached to one or more resources.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteStream
*/
DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest);
/**
*
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a
* thing that doesn't exist.
*
*
* @param deleteThingRequest
* The input for the DeleteThing operation.
* @return Result of the DeleteThing operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteThing
*/
DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest);
/**
*
* Deletes a thing group.
*
*
* @param deleteThingGroupRequest
* @return Result of the DeleteThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteThingGroup
*/
DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest);
/**
*
* 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.
*
*
* @param deleteThingTypeRequest
* The input for the DeleteThingType operation.
* @return Result of the DeleteThingType operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeleteThingType
*/
DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest);
/**
*
* Deletes the rule.
*
*
* @param deleteTopicRuleRequest
* The input for the DeleteTopicRule operation.
* @return Result of the DeleteTopicRule operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.DeleteTopicRule
*/
DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest);
/**
*
* Deletes a topic rule destination.
*
*
* @param deleteTopicRuleDestinationRequest
* @return Result of the DeleteTopicRuleDestination operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.DeleteTopicRuleDestination
*/
DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest);
/**
*
* Deletes a logging level.
*
*
* @param deleteV2LoggingLevelRequest
* @return Result of the DeleteV2LoggingLevel operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.DeleteV2LoggingLevel
*/
DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest);
/**
*
* Deprecates a thing type. You can not associate new things with deprecated thing type.
*
*
* @param deprecateThingTypeRequest
* The input for the DeprecateThingType operation.
* @return Result of the DeprecateThingType operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DeprecateThingType
*/
DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest);
/**
*
* 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.
*
*
* @param describeAccountAuditConfigurationRequest
* @return Result of the DescribeAccountAuditConfiguration operation returned by the service.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAccountAuditConfiguration
*/
DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest);
/**
*
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of
* the issue, and when the audit that returned the finding was started.
*
*
* @param describeAuditFindingRequest
* @return Result of the DescribeAuditFinding operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAuditFinding
*/
DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest);
/**
*
* 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 Result of the DescribeAuditMitigationActionsTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAuditMitigationActionsTask
*/
DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(
DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest);
/**
*
* Gets information about a Device Defender audit suppression.
*
*
* @param describeAuditSuppressionRequest
* @return Result of the DescribeAuditSuppression operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAuditSuppression
*/
DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest);
/**
*
* Gets information about a Device Defender audit.
*
*
* @param describeAuditTaskRequest
* @return Result of the DescribeAuditTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAuditTask
*/
DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest);
/**
*
* Describes an authorizer.
*
*
* @param describeAuthorizerRequest
* @return Result of the DescribeAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeAuthorizer
*/
DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest);
/**
*
* Returns information about a billing group.
*
*
* @param describeBillingGroupRequest
* @return Result of the DescribeBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeBillingGroup
*/
DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest);
/**
*
* Describes a registered CA certificate.
*
*
* @param describeCACertificateRequest
* The input for the DescribeCACertificate operation.
* @return Result of the DescribeCACertificate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeCACertificate
*/
DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest);
/**
*
* Gets information about the specified certificate.
*
*
* @param describeCertificateRequest
* The input for the DescribeCertificate operation.
* @return Result of the DescribeCertificate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeCertificate
*/
DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest);
/**
*
* Describes the default authorizer.
*
*
* @param describeDefaultAuthorizerRequest
* @return Result of the DescribeDefaultAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeDefaultAuthorizer
*/
DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest);
/**
*
* Provides details about a dimension that is defined in your AWS account.
*
*
* @param describeDimensionRequest
* @return Result of the DescribeDimension operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.DescribeDimension
*/
DescribeDimensionResult describeDimension(DescribeDimensionRequest describeDimensionRequest);
/**
*
* Gets summary information about a domain configuration.
*
*
*
* The domain configuration feature is in public preview and is subject to change.
*
*
*
* @param describeDomainConfigurationRequest
* @return Result of the DescribeDomainConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InvalidRequestException
* The request is not valid.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeDomainConfiguration
*/
DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest);
/**
*
* Returns a unique endpoint specific to the AWS account making the call.
*
*
* @param describeEndpointRequest
* The input for the DescribeEndpoint operation.
* @return Result of the DescribeEndpoint operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.DescribeEndpoint
*/
DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest);
/**
*
* Describes event configurations.
*
*
* @param describeEventConfigurationsRequest
* @return Result of the DescribeEventConfigurations operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.DescribeEventConfigurations
*/
DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest);
/**
*
* Describes a search index.
*
*
* @param describeIndexRequest
* @return Result of the DescribeIndex operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeIndex
*/
DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest);
/**
*
* Describes a job.
*
*
* @param describeJobRequest
* @return Result of the DescribeJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.DescribeJob
*/
DescribeJobResult describeJob(DescribeJobRequest describeJobRequest);
/**
*
* Describes a job execution.
*
*
* @param describeJobExecutionRequest
* @return Result of the DescribeJobExecution operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.DescribeJobExecution
*/
DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest);
/**
*
* Gets information about a mitigation action.
*
*
* @param describeMitigationActionRequest
* @return Result of the DescribeMitigationAction operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeMitigationAction
*/
DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest);
/**
*
* Returns information about a fleet provisioning template.
*
*
* @param describeProvisioningTemplateRequest
* @return Result of the DescribeProvisioningTemplate operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.DescribeProvisioningTemplate
*/
DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest);
/**
*
* Returns information about a fleet provisioning template version.
*
*
* @param describeProvisioningTemplateVersionRequest
* @return Result of the DescribeProvisioningTemplateVersion operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.DescribeProvisioningTemplateVersion
*/
DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(
DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest);
/**
*
* Describes a role alias.
*
*
* @param describeRoleAliasRequest
* @return Result of the DescribeRoleAlias operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeRoleAlias
*/
DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest);
/**
*
* Gets information about a scheduled audit.
*
*
* @param describeScheduledAuditRequest
* @return Result of the DescribeScheduledAudit operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeScheduledAudit
*/
DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest);
/**
*
* Gets information about a Device Defender security profile.
*
*
* @param describeSecurityProfileRequest
* @return Result of the DescribeSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeSecurityProfile
*/
DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest);
/**
*
* Gets information about a stream.
*
*
* @param describeStreamRequest
* @return Result of the DescribeStream operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeStream
*/
DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest);
/**
*
* Gets information about the specified thing.
*
*
* @param describeThingRequest
* The input for the DescribeThing operation.
* @return Result of the DescribeThing operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeThing
*/
DescribeThingResult describeThing(DescribeThingRequest describeThingRequest);
/**
*
* Describe a thing group.
*
*
* @param describeThingGroupRequest
* @return Result of the DescribeThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeThingGroup
*/
DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest);
/**
*
* Describes a bulk thing provisioning task.
*
*
* @param describeThingRegistrationTaskRequest
* @return Result of the DescribeThingRegistrationTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.DescribeThingRegistrationTask
*/
DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest);
/**
*
* Gets information about the specified thing type.
*
*
* @param describeThingTypeRequest
* The input for the DescribeThingType operation.
* @return Result of the DescribeThingType operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DescribeThingType
*/
DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest);
/**
*
* Detaches a policy from the specified target.
*
*
* @param detachPolicyRequest
* @return Result of the DetachPolicy operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.DetachPolicy
*/
DetachPolicyResult detachPolicy(DetachPolicyRequest detachPolicyRequest);
/**
*
* Removes the specified policy from the specified certificate.
*
*
* Note: This API is deprecated. Please use DetachPolicy instead.
*
*
* @param detachPrincipalPolicyRequest
* The input for the DetachPrincipalPolicy operation.
* @return Result of the DetachPrincipalPolicy operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DetachPrincipalPolicy
*/
@Deprecated
DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest);
/**
*
* Disassociates a Device Defender security profile from a thing group or from this account.
*
*
* @param detachSecurityProfileRequest
* @return Result of the DetachSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DetachSecurityProfile
*/
DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest);
/**
*
* 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.
*
*
*
* @param detachThingPrincipalRequest
* The input for the DetachThingPrincipal operation.
* @return Result of the DetachThingPrincipal operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.DetachThingPrincipal
*/
DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest);
/**
*
* Disables the rule.
*
*
* @param disableTopicRuleRequest
* The input for the DisableTopicRuleRequest operation.
* @return Result of the DisableTopicRule operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.DisableTopicRule
*/
DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest);
/**
*
* Enables the rule.
*
*
* @param enableTopicRuleRequest
* The input for the EnableTopicRuleRequest operation.
* @return Result of the EnableTopicRule operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.EnableTopicRule
*/
EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest);
/**
*
* Returns the approximate count of unique values that match the query.
*
*
* @param getCardinalityRequest
* @return Result of the GetCardinality operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidQueryException
* The query is invalid.
* @throws InvalidAggregationException
* The aggregation is invalid.
* @throws IndexNotReadyException
* The index is not ready.
* @sample AWSIot.GetCardinality
*/
GetCardinalityResult getCardinality(GetCardinalityRequest getCardinalityRequest);
/**
*
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it
* connects to the AWS IoT device gateway.
*
*
* @param getEffectivePoliciesRequest
* @return Result of the GetEffectivePolicies operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.GetEffectivePolicies
*/
GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest);
/**
*
* Gets the indexing configuration.
*
*
* @param getIndexingConfigurationRequest
* @return Result of the GetIndexingConfiguration operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.GetIndexingConfiguration
*/
GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest);
/**
*
* Gets a job document.
*
*
* @param getJobDocumentRequest
* @return Result of the GetJobDocument operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.GetJobDocument
*/
GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest);
/**
*
* Gets the logging options.
*
*
* NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
*
*
* @param getLoggingOptionsRequest
* The input for the GetLoggingOptions operation.
* @return Result of the GetLoggingOptions operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.GetLoggingOptions
*/
GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest);
/**
*
* Gets an OTA update.
*
*
* @param getOTAUpdateRequest
* @return Result of the GetOTAUpdate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.GetOTAUpdate
*/
GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest);
/**
*
* 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.
*
*
* @param getPercentilesRequest
* @return Result of the GetPercentiles operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidQueryException
* The query is invalid.
* @throws InvalidAggregationException
* The aggregation is invalid.
* @throws IndexNotReadyException
* The index is not ready.
* @sample AWSIot.GetPercentiles
*/
GetPercentilesResult getPercentiles(GetPercentilesRequest getPercentilesRequest);
/**
*
* Gets information about the specified policy with the policy document of the default version.
*
*
* @param getPolicyRequest
* The input for the GetPolicy operation.
* @return Result of the GetPolicy operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.GetPolicy
*/
GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest);
/**
*
* Gets information about the specified policy version.
*
*
* @param getPolicyVersionRequest
* The input for the GetPolicyVersion operation.
* @return Result of the GetPolicyVersion operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.GetPolicyVersion
*/
GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest);
/**
*
* Gets a registration code used to register a CA certificate with AWS IoT.
*
*
* @param getRegistrationCodeRequest
* The input to the GetRegistrationCode operation.
* @return Result of the GetRegistrationCode operation returned by the service.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @sample AWSIot.GetRegistrationCode
*/
GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest);
/**
*
* 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.
*
*
* @param getStatisticsRequest
* @return Result of the GetStatistics operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidQueryException
* The query is invalid.
* @throws InvalidAggregationException
* The aggregation is invalid.
* @throws IndexNotReadyException
* The index is not ready.
* @sample AWSIot.GetStatistics
*/
GetStatisticsResult getStatistics(GetStatisticsRequest getStatisticsRequest);
/**
*
* Gets information about the rule.
*
*
* @param getTopicRuleRequest
* The input for the GetTopicRule operation.
* @return Result of the GetTopicRule operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.GetTopicRule
*/
GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest);
/**
*
* Gets information about a topic rule destination.
*
*
* @param getTopicRuleDestinationRequest
* @return Result of the GetTopicRuleDestination operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.GetTopicRuleDestination
*/
GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest);
/**
*
* Gets the fine grained logging options.
*
*
* @param getV2LoggingOptionsRequest
* @return Result of the GetV2LoggingOptions operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws NotConfiguredException
* The resource is not configured.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.GetV2LoggingOptions
*/
GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest);
/**
*
* Lists the active violations for a given Device Defender security profile.
*
*
* @param listActiveViolationsRequest
* @return Result of the ListActiveViolations operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListActiveViolations
*/
ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest);
/**
*
* Lists the policies attached to the specified thing group.
*
*
* @param listAttachedPoliciesRequest
* @return Result of the ListAttachedPolicies operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.ListAttachedPolicies
*/
ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest);
/**
*
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time
* period. (Findings are retained for 180 days.)
*
*
* @param listAuditFindingsRequest
* @return Result of the ListAuditFindings operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuditFindings
*/
ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest);
/**
*
* Gets the status of audit mitigation action tasks that were executed.
*
*
* @param listAuditMitigationActionsExecutionsRequest
* @return Result of the ListAuditMitigationActionsExecutions operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuditMitigationActionsExecutions
*/
ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(
ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest);
/**
*
* Gets a list of audit mitigation action tasks that match the specified filters.
*
*
* @param listAuditMitigationActionsTasksRequest
* @return Result of the ListAuditMitigationActionsTasks operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuditMitigationActionsTasks
*/
ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest);
/**
*
* Lists your Device Defender audit listings.
*
*
* @param listAuditSuppressionsRequest
* @return Result of the ListAuditSuppressions operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuditSuppressions
*/
ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest);
/**
*
* Lists the Device Defender audits that have been performed during a given time period.
*
*
* @param listAuditTasksRequest
* @return Result of the ListAuditTasks operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuditTasks
*/
ListAuditTasksResult listAuditTasks(ListAuditTasksRequest listAuditTasksRequest);
/**
*
* Lists the authorizers registered in your account.
*
*
* @param listAuthorizersRequest
* @return Result of the ListAuthorizers operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListAuthorizers
*/
ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest);
/**
*
* Lists the billing groups you have created.
*
*
* @param listBillingGroupsRequest
* @return Result of the ListBillingGroups operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.ListBillingGroups
*/
ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest);
/**
*
* Lists the CA certificates registered for your AWS account.
*
*
* The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional
* results.
*
*
* @param listCACertificatesRequest
* Input for the ListCACertificates operation.
* @return Result of the ListCACertificates operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListCACertificates
*/
ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest);
/**
*
* Lists the certificates registered in your AWS account.
*
*
* The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional
* results.
*
*
* @param listCertificatesRequest
* The input for the ListCertificates operation.
* @return Result of the ListCertificates operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListCertificates
*/
ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest);
/**
*
* List the device certificates signed by the specified CA certificate.
*
*
* @param listCertificatesByCARequest
* The input to the ListCertificatesByCA operation.
* @return Result of the ListCertificatesByCA operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListCertificatesByCA
*/
ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest);
/**
*
* List the set of dimensions that are defined for your AWS account.
*
*
* @param listDimensionsRequest
* @return Result of the ListDimensions operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.ListDimensions
*/
ListDimensionsResult listDimensions(ListDimensionsRequest listDimensionsRequest);
/**
*
* Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration
* name.
*
*
*
* The domain configuration feature is in public preview and is subject to change.
*
*
*
* @param listDomainConfigurationsRequest
* @return Result of the ListDomainConfigurations operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListDomainConfigurations
*/
ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest);
/**
*
* Lists the search indices.
*
*
* @param listIndicesRequest
* @return Result of the ListIndices operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListIndices
*/
ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest);
/**
*
* Lists the job executions for a job.
*
*
* @param listJobExecutionsForJobRequest
* @return Result of the ListJobExecutionsForJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListJobExecutionsForJob
*/
ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest);
/**
*
* Lists the job executions for the specified thing.
*
*
* @param listJobExecutionsForThingRequest
* @return Result of the ListJobExecutionsForThing operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListJobExecutionsForThing
*/
ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest);
/**
*
* Lists jobs.
*
*
* @param listJobsRequest
* @return Result of the ListJobs operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListJobs
*/
ListJobsResult listJobs(ListJobsRequest listJobsRequest);
/**
*
* Gets a list of all mitigation actions that match the specified filter criteria.
*
*
* @param listMitigationActionsRequest
* @return Result of the ListMitigationActions operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListMitigationActions
*/
ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest);
/**
*
* Lists OTA updates.
*
*
* @param listOTAUpdatesRequest
* @return Result of the ListOTAUpdates operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListOTAUpdates
*/
ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest);
/**
*
* Lists certificates that are being transferred but not yet accepted.
*
*
* @param listOutgoingCertificatesRequest
* The input to the ListOutgoingCertificates operation.
* @return Result of the ListOutgoingCertificates operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListOutgoingCertificates
*/
ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest);
/**
*
* Lists your policies.
*
*
* @param listPoliciesRequest
* The input for the ListPolicies operation.
* @return Result of the ListPolicies operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListPolicies
*/
ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest);
/**
*
* Lists the principals associated with the specified policy.
*
*
* Note: This API is deprecated. Please use ListTargetsForPolicy instead.
*
*
* @param listPolicyPrincipalsRequest
* The input for the ListPolicyPrincipals operation.
* @return Result of the ListPolicyPrincipals operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListPolicyPrincipals
*/
@Deprecated
ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest);
/**
*
* Lists the versions of the specified policy and identifies the default version.
*
*
* @param listPolicyVersionsRequest
* The input for the ListPolicyVersions operation.
* @return Result of the ListPolicyVersions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListPolicyVersions
*/
ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest);
/**
*
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
*
*
* Note: This API is deprecated. Please use ListAttachedPolicies instead.
*
*
* @param listPrincipalPoliciesRequest
* The input for the ListPrincipalPolicies operation.
* @return Result of the ListPrincipalPolicies operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListPrincipalPolicies
*/
@Deprecated
ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest);
/**
*
* 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.
*
*
* @param listPrincipalThingsRequest
* The input for the ListPrincipalThings operation.
* @return Result of the ListPrincipalThings operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListPrincipalThings
*/
ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest);
/**
*
* A list of fleet provisioning template versions.
*
*
* @param listProvisioningTemplateVersionsRequest
* @return Result of the ListProvisioningTemplateVersions operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.ListProvisioningTemplateVersions
*/
ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest);
/**
*
* Lists the fleet provisioning templates in your AWS account.
*
*
* @param listProvisioningTemplatesRequest
* @return Result of the ListProvisioningTemplates operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.ListProvisioningTemplates
*/
ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest);
/**
*
* Lists the role aliases registered in your account.
*
*
* @param listRoleAliasesRequest
* @return Result of the ListRoleAliases operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListRoleAliases
*/
ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest);
/**
*
* Lists all of your scheduled audits.
*
*
* @param listScheduledAuditsRequest
* @return Result of the ListScheduledAudits operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListScheduledAudits
*/
ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest);
/**
*
* Lists the Device Defender security profiles you have created. You can use filters to list only those security
* profiles associated with a thing group or only those associated with your account.
*
*
* @param listSecurityProfilesRequest
* @return Result of the ListSecurityProfiles operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListSecurityProfiles
*/
ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest);
/**
*
* Lists the Device Defender security profiles attached to a target (thing group).
*
*
* @param listSecurityProfilesForTargetRequest
* @return Result of the ListSecurityProfilesForTarget operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListSecurityProfilesForTarget
*/
ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest);
/**
*
* Lists all of the streams in your AWS account.
*
*
* @param listStreamsRequest
* @return Result of the ListStreams operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListStreams
*/
ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest);
/**
*
* Lists the tags (metadata) you have assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.ListTagsForResource
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* List targets for the specified policy.
*
*
* @param listTargetsForPolicyRequest
* @return Result of the ListTargetsForPolicy operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.ListTargetsForPolicy
*/
ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest);
/**
*
* Lists the targets (thing groups) associated with a given Device Defender security profile.
*
*
* @param listTargetsForSecurityProfileRequest
* @return Result of the ListTargetsForSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListTargetsForSecurityProfile
*/
ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest);
/**
*
* List the thing groups in your account.
*
*
* @param listThingGroupsRequest
* @return Result of the ListThingGroups operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListThingGroups
*/
ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest);
/**
*
* List the thing groups to which the specified thing belongs.
*
*
* @param listThingGroupsForThingRequest
* @return Result of the ListThingGroupsForThing operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListThingGroupsForThing
*/
ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest);
/**
*
* 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.
*
*
* @param listThingPrincipalsRequest
* The input for the ListThingPrincipal operation.
* @return Result of the ListThingPrincipals operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListThingPrincipals
*/
ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest);
/**
*
* Information about the thing registration tasks.
*
*
* @param listThingRegistrationTaskReportsRequest
* @return Result of the ListThingRegistrationTaskReports operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListThingRegistrationTaskReports
*/
ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest);
/**
*
* List bulk thing provisioning tasks.
*
*
* @param listThingRegistrationTasksRequest
* @return Result of the ListThingRegistrationTasks operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListThingRegistrationTasks
*/
ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest);
/**
*
* Lists the existing thing types.
*
*
* @param listThingTypesRequest
* The input for the ListThingTypes operation.
* @return Result of the ListThingTypes operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListThingTypes
*/
ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest);
/**
*
* 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.
*
*
*
* 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.
*
*
*
* @param listThingsRequest
* The input for the ListThings operation.
* @return Result of the ListThings operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListThings
*/
ListThingsResult listThings(ListThingsRequest listThingsRequest);
/**
*
* Lists the things you have added to the given billing group.
*
*
* @param listThingsInBillingGroupRequest
* @return Result of the ListThingsInBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.ListThingsInBillingGroup
*/
ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest);
/**
*
* Lists the things in the specified group.
*
*
* @param listThingsInThingGroupRequest
* @return Result of the ListThingsInThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.ListThingsInThingGroup
*/
ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest);
/**
*
* Lists all the topic rule destinations in your AWS account.
*
*
* @param listTopicRuleDestinationsRequest
* @return Result of the ListTopicRuleDestinations operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @sample AWSIot.ListTopicRuleDestinations
*/
ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest);
/**
*
* Lists the rules for the specific topic.
*
*
* @param listTopicRulesRequest
* The input for the ListTopicRules operation.
* @return Result of the ListTopicRules operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListTopicRules
*/
ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest);
/**
*
* Lists logging levels.
*
*
* @param listV2LoggingLevelsRequest
* @return Result of the ListV2LoggingLevels operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws NotConfiguredException
* The resource is not configured.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.ListV2LoggingLevels
*/
ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest);
/**
*
* 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).
*
*
* @param listViolationEventsRequest
* @return Result of the ListViolationEvents operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ListViolationEvents
*/
ListViolationEventsResult listViolationEvents(ListViolationEventsRequest listViolationEventsRequest);
/**
*
* Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which
* can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same
* subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you
* have more than one CA certificate registered, make sure you pass the CA certificate when you register your device
* certificates with the RegisterCertificate API.
*
*
* @param registerCACertificateRequest
* The input to the RegisterCACertificate operation.
* @return Result of the RegisterCACertificate operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws RegistrationCodeValidationException
* The registration code is invalid.
* @throws InvalidRequestException
* The request is not valid.
* @throws CertificateValidationException
* The certificate is invalid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.RegisterCACertificate
*/
RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest);
/**
*
* Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject
* field, you must specify the CA certificate that was used to sign the device certificate being registered.
*
*
* @param registerCertificateRequest
* The input to the RegisterCertificate operation.
* @return Result of the RegisterCertificate operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws InvalidRequestException
* The request is not valid.
* @throws CertificateValidationException
* The certificate is invalid.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws CertificateConflictException
* Unable to verify the CA certificate used to sign the device certificate you are attempting to register.
* This is happens when you have registered more than one CA certificate that has the same subject field and
* public key.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.RegisterCertificate
*/
RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest);
/**
*
* Register a certificate that does not have a certificate authority (CA).
*
*
* @param registerCertificateWithoutCARequest
* @return Result of the RegisterCertificateWithoutCA operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @throws InvalidRequestException
* The request is not valid.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws CertificateValidationException
* The certificate is invalid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.RegisterCertificateWithoutCA
*/
RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest registerCertificateWithoutCARequest);
/**
*
* Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls
* might exceed your account level AWS IoT Throttling
* Limits and cause throttle errors. Please contact AWS
* Customer Support to raise your throttling limits if necessary.
*
*
* @param registerThingRequest
* @return Result of the RegisterThing operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InvalidRequestException
* The request is not valid.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @throws ResourceRegistrationFailureException
* The resource registration failed.
* @sample AWSIot.RegisterThing
*/
RegisterThingResult registerThing(RegisterThingRequest registerThingRequest);
/**
*
* Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status
* changes from PENDING_TRANSFER to INACTIVE.
*
*
* To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
*
*
* This operation can only be called by the transfer destination. After it is called, the certificate will be
* returned to the source's account in the INACTIVE state.
*
*
* @param rejectCertificateTransferRequest
* The input for the RejectCertificateTransfer operation.
* @return Result of the RejectCertificateTransfer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws TransferAlreadyCompletedException
* You can't revert the certificate transfer because the transfer is already complete.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.RejectCertificateTransfer
*/
RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest);
/**
*
* Removes the given thing from the billing group.
*
*
* @param removeThingFromBillingGroupRequest
* @return Result of the RemoveThingFromBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.RemoveThingFromBillingGroup
*/
RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest);
/**
*
* 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.
*
*
* @param removeThingFromThingGroupRequest
* @return Result of the RemoveThingFromThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.RemoveThingFromThingGroup
*/
RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest);
/**
*
* 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.
*
*
* @param replaceTopicRuleRequest
* The input for the ReplaceTopicRule operation.
* @return Result of the ReplaceTopicRule operation returned by the service.
* @throws SqlParseException
* The Rule-SQL expression can't be parsed correctly.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.ReplaceTopicRule
*/
ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest);
/**
*
* The query search index.
*
*
* @param searchIndexRequest
* @return Result of the SearchIndex operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidQueryException
* The query is invalid.
* @throws IndexNotReadyException
* The index is not ready.
* @sample AWSIot.SearchIndex
*/
SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest);
/**
*
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an
* authorizer.
*
*
* @param setDefaultAuthorizerRequest
* @return Result of the SetDefaultAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceAlreadyExistsException
* The resource already exists.
* @sample AWSIot.SetDefaultAuthorizer
*/
SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest);
/**
*
* Sets the specified version of the specified policy as the policy's default (operative) version. This action
* affects all certificates to which the policy is attached. To list the principals the policy is attached to, use
* the ListPrincipalPolicy API.
*
*
* @param setDefaultPolicyVersionRequest
* The input for the SetDefaultPolicyVersion operation.
* @return Result of the SetDefaultPolicyVersion operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.SetDefaultPolicyVersion
*/
SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest);
/**
*
* Sets the logging options.
*
*
* NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
*
*
* @param setLoggingOptionsRequest
* The input for the SetLoggingOptions operation.
* @return Result of the SetLoggingOptions operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.SetLoggingOptions
*/
SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest);
/**
*
* Sets the logging level.
*
*
* @param setV2LoggingLevelRequest
* @return Result of the SetV2LoggingLevel operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws NotConfiguredException
* The resource is not configured.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.SetV2LoggingLevel
*/
SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest);
/**
*
* Sets the logging options for the V2 logging service.
*
*
* @param setV2LoggingOptionsRequest
* @return Result of the SetV2LoggingOptions operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.SetV2LoggingOptions
*/
SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest);
/**
*
* Starts a task that applies a set of mitigation actions to the specified target.
*
*
* @param startAuditMitigationActionsTaskRequest
* @return Result of the StartAuditMitigationActionsTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws TaskAlreadyExistsException
* This exception occurs if you attempt to start a task with the same task-id as an existing task but with a
* different clientRequestToken.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.StartAuditMitigationActionsTask
*/
StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest);
/**
*
* Starts an on-demand Device Defender audit.
*
*
* @param startOnDemandAuditTaskRequest
* @return Result of the StartOnDemandAuditTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.StartOnDemandAuditTask
*/
StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest);
/**
*
* Creates a bulk thing provisioning task.
*
*
* @param startThingRegistrationTaskRequest
* @return Result of the StartThingRegistrationTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.StartThingRegistrationTask
*/
StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest);
/**
*
* Cancels a bulk thing provisioning task.
*
*
* @param stopThingRegistrationTaskRequest
* @return Result of the StopThingRegistrationTask operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.StopThingRegistrationTask
*/
StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest);
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.TagResource
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to
* test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
*
*
* @param testAuthorizationRequest
* @return Result of the TestAuthorization operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws LimitExceededException
* A limit has been exceeded.
* @sample AWSIot.TestAuthorization
*/
TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest);
/**
*
* Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the
* custom authorization behavior of devices that connect to the AWS IoT device gateway.
*
*
* @param testInvokeAuthorizerRequest
* @return Result of the TestInvokeAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidResponseException
* The response is invalid.
* @sample AWSIot.TestInvokeAuthorizer
*/
TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest);
/**
*
* Transfers the specified certificate to the specified AWS account.
*
*
* You can cancel the transfer until it is acknowledged by the recipient.
*
*
* No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer
* target.
*
*
* The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to
* deactivate it.
*
*
* The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach
* them.
*
*
* @param transferCertificateRequest
* The input for the TransferCertificate operation.
* @return Result of the TransferCertificate operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws TransferConflictException
* You can't transfer the certificate because authorization policies are still attached.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.TransferCertificate
*/
TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest);
/**
*
* Removes the given tags (metadata) from the resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.UntagResource
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateAccountAuditConfigurationRequest
* @return Result of the UpdateAccountAuditConfiguration operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateAccountAuditConfiguration
*/
UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest);
/**
*
* Updates a Device Defender audit suppression.
*
*
* @param updateAuditSuppressionRequest
* @return Result of the UpdateAuditSuppression operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateAuditSuppression
*/
UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest);
/**
*
* Updates an authorizer.
*
*
* @param updateAuthorizerRequest
* @return Result of the UpdateAuthorizer operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws LimitExceededException
* A limit has been exceeded.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateAuthorizer
*/
UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest);
/**
*
* Updates information about the billing group.
*
*
* @param updateBillingGroupRequest
* @return Result of the UpdateBillingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.UpdateBillingGroup
*/
UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest);
/**
*
* Updates a registered CA certificate.
*
*
* @param updateCACertificateRequest
* The input to the UpdateCACertificate operation.
* @return Result of the UpdateCACertificate operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateCACertificate
*/
UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest);
/**
*
* Updates the status of the specified certificate. This operation is idempotent.
*
*
* Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to AWS IoT.
*
*
* Within a few minutes of updating a certificate from the ACTIVE state to any other state, AWS 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.
* @return Result of the UpdateCertificate operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws CertificateStateException
* The certificate operation is not allowed.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateCertificate
*/
UpdateCertificateResult updateCertificate(UpdateCertificateRequest updateCertificateRequest);
/**
*
* Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can
* delete it and re-create it).
*
*
* @param updateDimensionRequest
* @return Result of the UpdateDimension operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.UpdateDimension
*/
UpdateDimensionResult updateDimension(UpdateDimensionRequest updateDimensionRequest);
/**
*
* Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
*
*
*
* The domain configuration feature is in public preview and is subject to change.
*
*
*
* @param updateDomainConfigurationRequest
* @return Result of the UpdateDomainConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws CertificateValidationException
* The certificate is invalid.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateDomainConfiguration
*/
UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest);
/**
*
* Updates a dynamic thing group.
*
*
* @param updateDynamicThingGroupRequest
* @return Result of the UpdateDynamicThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidQueryException
* The query is invalid.
* @sample AWSIot.UpdateDynamicThingGroup
*/
UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest);
/**
*
* Updates the event configurations.
*
*
* @param updateEventConfigurationsRequest
* @return Result of the UpdateEventConfigurations operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ThrottlingException
* The rate exceeds the limit.
* @sample AWSIot.UpdateEventConfigurations
*/
UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest);
/**
*
* Updates the search configuration.
*
*
* @param updateIndexingConfigurationRequest
* @return Result of the UpdateIndexingConfiguration operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateIndexingConfiguration
*/
UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest);
/**
*
* Updates supported fields of the specified job.
*
*
* @param updateJobRequest
* @return Result of the UpdateJob operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @sample AWSIot.UpdateJob
*/
UpdateJobResult updateJob(UpdateJobRequest updateJobRequest);
/**
*
* Updates the definition for the specified mitigation action.
*
*
* @param updateMitigationActionRequest
* @return Result of the UpdateMitigationAction operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateMitigationAction
*/
UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest);
/**
*
* Updates a fleet provisioning template.
*
*
* @param updateProvisioningTemplateRequest
* @return Result of the UpdateProvisioningTemplate operation returned by the service.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.UpdateProvisioningTemplate
*/
UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest);
/**
*
* Updates a role alias.
*
*
* @param updateRoleAliasRequest
* @return Result of the UpdateRoleAlias operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateRoleAlias
*/
UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest);
/**
*
* Updates a scheduled audit, including which checks are performed and how often the audit takes place.
*
*
* @param updateScheduledAuditRequest
* @return Result of the UpdateScheduledAudit operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateScheduledAudit
*/
UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest);
/**
*
* Updates a Device Defender security profile.
*
*
* @param updateSecurityProfileRequest
* @return Result of the UpdateSecurityProfile operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateSecurityProfile
*/
UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest);
/**
*
* Updates an existing stream. The stream version will be incremented by one.
*
*
* @param updateStreamRequest
* @return Result of the UpdateStream operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.UpdateStream
*/
UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest);
/**
*
* Updates the data for a thing.
*
*
* @param updateThingRequest
* The input for the UpdateThing operation.
* @return Result of the UpdateThing operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.UpdateThing
*/
UpdateThingResult updateThing(UpdateThingRequest updateThingRequest);
/**
*
* Update a thing group.
*
*
* @param updateThingGroupRequest
* @return Result of the UpdateThingGroup operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws VersionConflictException
* An exception thrown when the version of an entity specified with the expectedVersion
* parameter does not match the latest version in the system.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.UpdateThingGroup
*/
UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest);
/**
*
* Updates the groups to which the thing belongs.
*
*
* @param updateThingGroupsForThingRequest
* @return Result of the UpdateThingGroupsForThing operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @throws ResourceNotFoundException
* The specified resource does not exist.
* @sample AWSIot.UpdateThingGroupsForThing
*/
UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest);
/**
*
* Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the
* destination.
*
*
* @param updateTopicRuleDestinationRequest
* @return Result of the UpdateTopicRuleDestination operation returned by the service.
* @throws InternalException
* An unexpected error has occurred.
* @throws InvalidRequestException
* The request is not valid.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws UnauthorizedException
* You are not authorized to perform this operation.
* @throws ConflictingResourceUpdateException
* A conflicting resource update exception. This exception is thrown when two pending updates cause a
* conflict.
* @sample AWSIot.UpdateTopicRuleDestination
*/
UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest);
/**
*
* Validates a Device Defender security profile behaviors specification.
*
*
* @param validateSecurityProfileBehaviorsRequest
* @return Result of the ValidateSecurityProfileBehaviors operation returned by the service.
* @throws InvalidRequestException
* The request is not valid.
* @throws ThrottlingException
* The rate exceeds the limit.
* @throws InternalFailureException
* An unexpected error has occurred.
* @sample AWSIot.ValidateSecurityProfileBehaviors
*/
ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest);
/**
* 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.
*/
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.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy