/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iot; import 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. *
*
*
* IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, * embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data * endpoint to communicate with, configure rules for data processing and integration with other services, organize * resources associated with each device (Registry), configure logging, and create and manage policies and credentials * to authenticate devices. *
** The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and * Quotas. You must use the endpoint for the region that has the resources you want to access. *
** The service name used by Amazon Web * Services Signature Version 4 to sign the request is: execute-api. *
** For more information about how IoT works, see the Developer Guide. *
** For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to * Amazon Web Services Services. *
*/ @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. *
** Requires permission to access the AcceptCertificateTransfer action. *
* * @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. *
** Requires permission to access the AddThingToBillingGroup action. *
* * @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. *
** Requires permission to access the AddThingToThingGroup action. *
* * @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. *
** Requires permission to access the AssociateTargetsWithJob action. *
* * @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 the specified policy to the specified principal (certificate or other credential). *
** Requires permission to access the AttachPolicy action. *
* * @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 action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use AttachPolicy instead. *
** Requires permission to access the AttachPrincipalPolicy action. *
* * @param attachPrincipalPolicyRequest * The input for the AttachPrincipalPolicy operation. * @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. *
** Requires permission to access the AttachSecurityProfile action. *
* * @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 theexpectedVersion
* 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, Amazon Cognito * identities or federated identities. *
** Requires permission to access the AttachThingPrincipal action. *
* * @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. *
** Requires permission to access the CancelAuditMitigationActionsTask action. *
* * @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 isn't in * progress, an "InvalidRequestException" occurs. *
** Requires permission to access the CancelAuditTask action. *
* * @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, IoT returns the certificate to the source * account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be * cancelled. *
** After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to * INACTIVE. *
** Requires permission to access the CancelCertificateTransfer action. *
* * @param cancelCertificateTransferRequest * The input for the CancelCertificateTransfer operation. * @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 Device Defender ML Detect mitigation action. *
** Requires permission to access the CancelDetectMitigationActionsTask action. *
* * @param cancelDetectMitigationActionsTaskRequest * @return Result of the CancelDetectMitigationActionsTask 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.CancelDetectMitigationActionsTask */ CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest); /** ** Cancels a job. *
** Requires permission to access the CancelJob action. *
* * @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. * @throws LimitExceededException * A limit has been exceeded. * @sample AWSIot.CancelJob */ CancelJobResult cancelJob(CancelJobRequest cancelJobRequest); /** ** Cancels the execution of a job for a given thing. *
** Requires permission to access the CancelJobExecution action. *
* * @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 theforce
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. *
** Requires permission to access the ClearDefaultAuthorizer action. *
* * @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, IoT sends a confirmation
* message to the endpoint or base address you specify. The message includes a token which you pass back when
* calling ConfirmTopicRuleDestination
to confirm that you own or have access to the endpoint.
*
* Requires permission to access the ConfirmTopicRuleDestination action. *
* * @param confirmTopicRuleDestinationRequest * @return 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. *
** Requires permission to access the CreateAuditSuppression action. *
* * @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. *
** Requires permission to access the CreateAuthorizer action. *
* * @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. *
** Requires permission to access the CreateBillingGroup action. *
* * @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. *
** Requires permission to access the CreateCertificateFromCsr action. *
** The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key * from NIST P-256 or NIST P-384 curves. For supported certificates, consult * Certificate signing algorithms supported by IoT. *
** Reusing the same certificate signing request (CSR) results in a distinct certificate. *
*
* You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
* into that directory, and then specifying that directory on the command line. The following commands show how to
* create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
* located inside of the directory my-csr-directory:
*
* On Linux and OS X, the command is: *
*
* $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
* aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
* corresponding CSR.
*
* You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
* the certificate creation process:
*
* $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
*
* On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
*
* On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: *
*
* > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*
* Use this API to define a Custom Metric published by your devices to Device Defender. *
** Requires permission to access the CreateCustomMetric action. *
* * @param createCustomMetricRequest * @return Result of the CreateCustomMetric operation returned by the service. * @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. * @throws InternalFailureException * An unexpected error has occurred. * @sample AWSIot.CreateCustomMetric */ CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest); /** *
* Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device
* Defender. For example, using a TOPIC_FILTER
dimension, you can narrow down the scope of the metric
* only to MQTT topics whose name match the pattern specified in the dimension.
*
* Requires permission to access the CreateDimension action. *
* * @param createDimensionRequest * @return 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. *
** Requires permission to access the CreateDomainConfiguration action. *
* * @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. *
** Requires permission to access the CreateDynamicThingGroup action. *
* * @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 fleet metric. *
** Requires permission to access the CreateFleetMetric action. *
* * @param createFleetMetricRequest * @return Result of the CreateFleetMetric 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. * @throws ResourceAlreadyExistsException * The resource already exists. * @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.CreateFleetMetric */ CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest); /** ** Creates a job. *
** Requires permission to access the CreateJob action. *
* * @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 job template. *
** Requires permission to access the CreateJobTemplate action. *
* * @param createJobTemplateRequest * @return Result of the CreateJobTemplate operation returned by the service. * @throws InvalidRequestException * The request is not valid. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ConflictException * A resource with the same name 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.CreateJobTemplate */ CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest); /** *
* Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
* CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT API.
*
* Note This is the only time IoT issues the private key for this certificate, so it is important to keep it * in a secure location. *
** Requires permission to access the CreateKeysAndCertificate action. *
* * @param createKeysAndCertificateRequest * The input for the CreateKeysAndCertificate operation. ** Requires permission to access the CreateKeysAndCertificateRequest action. * @return 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. *
** Requires permission to access the CreateMitigationAction action. *
* * @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 IoT OTA update on a target group of things or groups. *
** Requires permission to access the CreateOTAUpdate action. *
* * @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 IoT software package that can be deployed to your fleet. *
** Requires permission to access the CreatePackage and GetIndexingConfiguration actions. *
* * @param createPackageRequest * @return Result of the CreatePackage operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws ConflictException * A resource with the same name already exists. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ServiceQuotaExceededException * A limit has been exceeded. * @sample AWSIot.CreatePackage */ CreatePackageResult createPackage(CreatePackageRequest createPackageRequest); /** ** Creates a new version for an existing IoT software package. *
** Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions. *
* * @param createPackageVersionRequest * @return Result of the CreatePackageVersion operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws ConflictException * A resource with the same name already exists. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ServiceQuotaExceededException * A limit has been exceeded. * @sample AWSIot.CreatePackageVersion */ CreatePackageVersionResult createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest); /** ** Creates an IoT policy. *
** The created policy is the default version for the policy. This operation creates a policy version with a version * identifier of 1 and sets 1 as the policy's default version. *
** Requires permission to access the CreatePolicy action. *
* * @param createPolicyRequest * The input for the CreatePolicy operation. * @return 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 IoT policy. To update a policy, create a new policy version. A managed * policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to * delete an existing version before you create a new one. *
** Optionally, you can set the new version as the policy's default version. The default version is the operative * version (that is, the version that is in effect for the certificates to which the policy is attached). *
** Requires permission to access the CreatePolicyVersion action. *
* * @param createPolicyVersionRequest * The input for the CreatePolicyVersion operation. * @return 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. *
** Requires permission to access the CreateProvisioningClaim action. *
* * @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 provisioning template. *
** Requires permission to access the CreateProvisioningTemplate action. *
* * @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 provisioning template. *
** Requires permission to access the CreateProvisioningTemplateVersion action. *
* * @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. *
** Requires permission to access the CreateRoleAlias action. *
* * @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. *
** Requires permission to access the CreateScheduledAudit action. *
* * @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. *
** Requires permission to access the CreateSecurityProfile action. *
* * @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. *
** Requires permission to access the CreateStream action. *
* * @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. *
** Requires permission to access the CreateThing action. *
* * @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. *
** Requires permission to access the CreateThingGroup action. *
* * @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. *
** Requires permission to access the CreateThingType action. *
* * @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. *
** Requires permission to access the CreateTopicRule action. *
* * @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. *
** Requires permission to access the CreateTopicRuleDestination action. *
* * @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. *
** Requires permission to access the DeleteAccountAuditConfiguration action. *
* * @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. *
** Requires permission to access the DeleteAuditSuppression action. *
* * @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. *
** Requires permission to access the DeleteAuthorizer action. *
* * @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. *
** Requires permission to access the DeleteBillingGroup action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the DeleteCACertificate action. *
* * @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 DetachPolicy action to detach all policies. Next, use the * UpdateCertificate action to set the certificate to the INACTIVE status. *
** Requires permission to access the DeleteCertificate action. *
* * @param deleteCertificateRequest * The input for the DeleteCertificate operation. * @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); /** ** Deletes a Device Defender detect custom metric. *
** Requires permission to access the DeleteCustomMetric action. *
*
* Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
* part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
* API with metricName
set to your custom metric name.
*
* Removes the specified dimension from your Amazon Web Services accounts. *
** Requires permission to access the DeleteDimension action. *
* * @param deleteDimensionRequest * @return 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. *
** Requires permission to access the DeleteDomainConfiguration action. *
* * @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. *
** Requires permission to access the DeleteDynamicThingGroup action. *
* * @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 theexpectedVersion
* 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 the specified fleet metric. Returns successfully with no error if the deletion is successful or you * specify a fleet metric that doesn't exist. *
** Requires permission to access the DeleteFleetMetric action. *
* * @param deleteFleetMetricRequest * @return Result of the DeleteFleetMetric 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 VersionConflictException * An exception thrown when the version of an entity specified with theexpectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.DeleteFleetMetric
*/
DeleteFleetMetricResult deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest);
/**
* * Deletes a job and its related job executions. *
** Deleting a job may take time, depending on the number of job executions created for the job and various other * factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". * Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. *
** Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. *
** Requires permission to access the DeleteJob action. *
* * @param deleteJobRequest * @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 theforce
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. *
** Requires permission to access the DeleteJobExecution action. *
* * @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 theforce
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 the specified job template. *
* * @param deleteJobTemplateRequest * @return Result of the DeleteJobTemplate 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.DeleteJobTemplate */ DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest); /** ** Deletes a defined mitigation action from your Amazon Web Services accounts. *
** Requires permission to access the DeleteMitigationAction action. *
* * @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. *
** Requires permission to access the DeleteOTAUpdate action. *
* * @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 theexpectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.DeleteOTAUpdate
*/
DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest);
/**
* * Deletes a specific version from a software package. *
** Note: All package versions must be deleted before deleting the software package. *
** Requires permission to access the DeletePackageVersion action. *
* * @param deletePackageRequest * @return Result of the DeletePackage operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @sample AWSIot.DeletePackage */ DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest); /** ** Deletes a specific version from a software package. *
** Note: If a package version is designated as default, you must remove the designation from the package * using the UpdatePackage action. *
* * @param deletePackageVersionRequest * @return Result of the DeletePackageVersion operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @sample AWSIot.DeletePackageVersion */ DeletePackageVersionResult deletePackageVersion(DeletePackageVersionRequest deletePackageVersionRequest); /** ** Deletes the specified policy. *
** A policy cannot be deleted if it has non-default versions or it is attached to any certificate. *
** To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; * use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy * action to delete the policy. *
** When a policy is deleted using DeletePolicy, its default version is deleted with it. *
** Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is * detached before it's ready to be deleted. *
** Requires permission to access the DeletePolicy action. *
* * @param deletePolicyRequest * The input for the DeletePolicy operation. * @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 action. To delete the default version of a policy, use DeletePolicy. To find out which version of a * policy is marked as the default version, use ListPolicyVersions. *
** Requires permission to access the DeletePolicyVersion action. *
* * @param deletePolicyVersionRequest * The input for the DeletePolicyVersion operation. * @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 provisioning template. *
** Requires permission to access the DeleteProvisioningTemplate action. *
* * @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 ConflictingResourceUpdateException * A conflicting resource update exception. This exception is thrown when two pending updates cause a * conflict. * @throws UnauthorizedException * You are not authorized to perform this operation. * @sample AWSIot.DeleteProvisioningTemplate */ DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest); /** ** Deletes a provisioning template version. *
** Requires permission to access the DeleteProvisioningTemplateVersion action. *
* * @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 ConflictingResourceUpdateException * A conflicting resource update exception. This exception is thrown when two pending updates cause a * conflict. * @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. *
** Requires permission to access the DeleteRegistrationCode action. *
* * @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 *
** Requires permission to access the DeleteRoleAlias action. *
* * @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. *
** Requires permission to access the DeleteScheduledAudit action. *
* * @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. *
** Requires permission to access the DeleteSecurityProfile action. *
* * @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 theexpectedVersion
* parameter does not match the latest version in the system.
* @sample AWSIot.DeleteSecurityProfile
*/
DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest);
/**
* * Deletes a stream. *
** Requires permission to access the DeleteStream action. *
* * @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. *
** Requires permission to access the DeleteThing action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the DeleteThingGroup action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the DeleteThingType action. *
* * @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. *
** Requires permission to access the DeleteTopicRule action. *
* * @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. *
** Requires permission to access the DeleteTopicRuleDestination action. *
* * @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. *
** Requires permission to access the DeleteV2LoggingLevel action. *
* * @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. *
** Requires permission to access the DeprecateThingType action. *
* * @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. *
** Requires permission to access the DescribeAccountAuditConfiguration action. *
* * @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 the start time when the audit that returned the finding. *
** Requires permission to access the DescribeAuditFinding action. *
* * @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. *
** Requires permission to access the DescribeAuditTask action. *
* * @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. *
** Requires permission to access the DescribeAuthorizer action. *
* * @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. *
** Requires permission to access the DescribeBillingGroup action. *
* * @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. *
** Requires permission to access the DescribeCACertificate action. *
* * @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. *
** Requires permission to access the DescribeCertificate action. *
* * @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); /** ** Gets information about a Device Defender detect custom metric. *
** Requires permission to access the DescribeCustomMetric action. *
* * @param describeCustomMetricRequest * @return Result of the DescribeCustomMetric 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.DescribeCustomMetric */ DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest); /** ** Describes the default authorizer. *
** Requires permission to access the DescribeDefaultAuthorizer action. *
* * @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); /** ** Gets information about a Device Defender ML Detect mitigation action. *
** Requires permission to access the DescribeDetectMitigationActionsTask action. *
* * @param describeDetectMitigationActionsTaskRequest * @return Result of the DescribeDetectMitigationActionsTask 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.DescribeDetectMitigationActionsTask */ DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask( DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest); /** ** Provides details about a dimension that is defined in your Amazon Web Services accounts. *
** Requires permission to access the DescribeDimension action. *
* * @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. *
** Requires permission to access the DescribeDomainConfiguration action. *
* * @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 Amazon Web Services account making the call. *
** Requires permission to access the DescribeEndpoint action. *
* * @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. *
** Requires permission to access the DescribeEventConfigurations action. *
* * @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); /** ** Gets information about the specified fleet metric. *
** Requires permission to access the DescribeFleetMetric action. *
* * @param describeFleetMetricRequest * @return Result of the DescribeFleetMetric 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.DescribeFleetMetric */ DescribeFleetMetricResult describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest); /** ** Describes a search index. *
** Requires permission to access the DescribeIndex action. *
* * @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. *
** Requires permission to access the DescribeJob action. *
* * @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. *
** Requires permission to access the DescribeJobExecution action. *
* * @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); /** ** Returns information about a job template. *
* * @param describeJobTemplateRequest * @return Result of the DescribeJobTemplate 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.DescribeJobTemplate */ DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest); /** ** View details of a managed job template. *
* * @param describeManagedJobTemplateRequest * @return Result of the DescribeManagedJobTemplate 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 InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @sample AWSIot.DescribeManagedJobTemplate */ DescribeManagedJobTemplateResult describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest); /** ** Gets information about a mitigation action. *
** Requires permission to access the DescribeMitigationAction 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 provisioning template. *
** Requires permission to access the DescribeProvisioningTemplate action. *
* * @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 provisioning template version. *
** Requires permission to access the DescribeProvisioningTemplateVersion action. *
* * @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. *
** Requires permission to access the DescribeRoleAlias action. *
* * @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. *
** Requires permission to access the DescribeScheduledAudit action. *
* * @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. *
** Requires permission to access the DescribeSecurityProfile action. *
* * @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. *
** Requires permission to access the DescribeStream action. *
* * @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. *
** Requires permission to access the DescribeThing action. *
* * @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. *
** Requires permission to access the DescribeThingGroup action. *
* * @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. *
** Requires permission to access the DescribeThingRegistrationTask action. *
* * @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. *
** Requires permission to access the DescribeThingType action. *
* * @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. *
** Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is * detached before it's ready to be deleted. *
** Requires permission to access the DetachPolicy action. *
* * @param detachPolicyRequest * @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 action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use DetachPolicy instead. *
** Requires permission to access the DetachPrincipalPolicy action. *
* * @param detachPrincipalPolicyRequest * The input for the DetachPrincipalPolicy operation. * @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. *
** Requires permission to access the DetachSecurityProfile action. *
* * @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. *
** Requires permission to access the DetachThingPrincipal action. *
* * @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. *
** Requires permission to access the DisableTopicRule action. *
* * @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. *
** Requires permission to access the EnableTopicRule action. *
* * @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 a Device Defender's ML Detect Security Profile training model's status. *
** Requires permission to access the GetBehaviorModelTrainingSummaries action. *
* * @param getBehaviorModelTrainingSummariesRequest * @return Result of the GetBehaviorModelTrainingSummaries 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.GetBehaviorModelTrainingSummaries */ GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest); /** ** Aggregates on indexed data with search queries pertaining to particular fields. *
** Requires permission to access the GetBucketsAggregation action. *
* * @param getBucketsAggregationRequest * @return Result of the GetBucketsAggregation 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.GetBucketsAggregation */ GetBucketsAggregationResult getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest); /** ** Returns the approximate count of unique values that match the query. *
** Requires permission to access the GetCardinality action. *
* * @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 IoT device gateway. *
** Requires permission to access the GetEffectivePolicies action. *
* * @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. *
** Requires permission to access the GetIndexingConfiguration action. *
* * @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. *
** Requires permission to access the GetJobDocument action. *
* * @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.
*
* Requires permission to access the GetLoggingOptions action. *
* * @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. *
** Requires permission to access the GetOTAUpdate action. *
* * @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); /** ** Gets information about the specified software package. *
** Requires permission to access the GetPackage action. *
* * @param getPackageRequest * @return Result of the GetPackage operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ResourceNotFoundException * The specified resource does not exist. * @sample AWSIot.GetPackage */ GetPackageResult getPackage(GetPackageRequest getPackageRequest); /** ** Gets information about the specified software package's configuration. *
** Requires permission to access the GetPackageConfiguration action. *
* * @param getPackageConfigurationRequest * @return Result of the GetPackageConfiguration operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @sample AWSIot.GetPackageConfiguration */ GetPackageConfigurationResult getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest); /** ** Gets information about the specified package version. *
** Requires permission to access the GetPackageVersion action. *
* * @param getPackageVersionRequest * @return Result of the GetPackageVersion operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ResourceNotFoundException * The specified resource does not exist. * @sample AWSIot.GetPackageVersion */ GetPackageVersionResult getPackageVersion(GetPackageVersionRequest getPackageVersionRequest); /** *
* Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
* are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles
. This
* function returns a value for each percentile group specified (or the default percentile groupings). The
* percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
* that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
* five percent of the values that match the query, and so on. The result is an approximation, the more values that
* match the query, the more accurate the percentile values.
*
* Requires permission to access the GetPercentiles action. *
* * @param getPercentilesRequest * @return 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. *
** Requires permission to access the GetPolicy action. *
* * @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. *
** Requires permission to access the GetPolicyVersion action. *
* * @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 IoT. *
** Requires permission to access the GetRegistrationCode action. *
* * @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.
*
* Requires permission to access the GetStatistics action. *
* * @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. *
** Requires permission to access the GetTopicRule action. *
* * @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. *
** Requires permission to access the GetTopicRuleDestination action. *
* * @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. *
** Requires permission to access the GetV2LoggingOptions action. *
* * @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. *
** Requires permission to access the ListActiveViolations action. *
* * @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. *
** Requires permission to access the ListAttachedPolicies action. *
* * @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 90 days.) *
** Requires permission to access the ListAuditFindings action. *
* * @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. *
** Requires permission to access the ListAuditMitigationActionsExecutions action. *
* * @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. *
** Requires permission to access the ListAuditMitigationActionsTasks action. *
* * @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. *
** Requires permission to access the ListAuditSuppressions action. *
* * @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. *
** Requires permission to access the ListAuditTasks action. *
* * @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. *
** Requires permission to access the ListAuthorizers action. *
* * @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. *
** Requires permission to access the ListBillingGroups action. *
* * @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 Amazon Web Services account. *
** The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional * results. *
** Requires permission to access the ListCACertificates action. *
* * @param listCACertificatesRequest * Input for the ListCACertificates operation. * @return 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 Amazon Web Services account. *
** The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional * results. *
** Requires permission to access the ListCertificates action. *
* * @param listCertificatesRequest * The input for the ListCertificates operation. * @return 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. *
** Requires permission to access the ListCertificatesByCA action. *
* * @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); /** ** Lists your Device Defender detect custom metrics. *
** Requires permission to access the ListCustomMetrics action. *
* * @param listCustomMetricsRequest * @return Result of the ListCustomMetrics 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.ListCustomMetrics */ ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest); /** ** Lists mitigation actions executions for a Device Defender ML Detect Security Profile. *
** Requires permission to access the ListDetectMitigationActionsExecutions action. *
* * @param listDetectMitigationActionsExecutionsRequest * @return Result of the ListDetectMitigationActionsExecutions 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.ListDetectMitigationActionsExecutions */ ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions( ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest); /** ** List of Device Defender ML Detect mitigation actions tasks. *
** Requires permission to access the ListDetectMitigationActionsTasks action. *
* * @param listDetectMitigationActionsTasksRequest * @return Result of the ListDetectMitigationActionsTasks 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.ListDetectMitigationActionsTasks */ ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest); /** ** List the set of dimensions that are defined for your Amazon Web Services accounts. *
** Requires permission to access the ListDimensions action. *
* * @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. *
** Requires permission to access the ListDomainConfigurations action. *
* * @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 all your fleet metrics. *
** Requires permission to access the ListFleetMetrics action. *
* * @param listFleetMetricsRequest * @return Result of the ListFleetMetrics 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.ListFleetMetrics */ ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest); /** ** Lists the search indices. *
** Requires permission to access the ListIndices action. *
* * @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. *
** Requires permission to access the ListJobExecutionsForJob action. *
* * @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. *
** Requires permission to access the ListJobExecutionsForThing action. *
* * @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); /** ** Returns a list of job templates. *
** Requires permission to access the ListJobTemplates action. *
* * @param listJobTemplatesRequest * @return Result of the ListJobTemplates 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.ListJobTemplates */ ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest); /** ** Lists jobs. *
** Requires permission to access the ListJobs action. *
* * @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); /** ** Returns a list of managed job templates. *
* * @param listManagedJobTemplatesRequest * @return Result of the ListManagedJobTemplates 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 InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @sample AWSIot.ListManagedJobTemplates */ ListManagedJobTemplatesResult listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest); /** ** Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom * metric) by the given thing during the specified time period. *
* * @param listMetricValuesRequest * @return Result of the ListMetricValues 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.ListMetricValues */ ListMetricValuesResult listMetricValues(ListMetricValuesRequest listMetricValuesRequest); /** ** Gets a list of all mitigation actions that match the specified filter criteria. *
** Requires permission to access the ListMitigationActions action. *
* * @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. *
** Requires permission to access the ListOTAUpdates action. *
* * @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. *
** Requires permission to access the ListOutgoingCertificates action. *
* * @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 the software package versions associated to the account. *
** Requires permission to access the ListPackageVersions action. *
* * @param listPackageVersionsRequest * @return Result of the ListPackageVersions operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @sample AWSIot.ListPackageVersions */ ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest); /** ** Lists the software packages associated to the account. *
** Requires permission to access the ListPackages action. *
* * @param listPackagesRequest * @return Result of the ListPackages operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @sample AWSIot.ListPackages */ ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest); /** ** Lists your policies. *
** Requires permission to access the ListPolicies action. *
* * @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 action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use ListTargetsForPolicy instead. *
** Requires permission to access the ListPolicyPrincipals action. *
* * @param listPolicyPrincipalsRequest * The input for the ListPolicyPrincipals operation. * @return 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. *
** Requires permission to access the ListPolicyVersions action. *
* * @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 action is deprecated and works as expected for backward compatibility, but we won't add * enhancements. Use ListAttachedPolicies instead. *
** Requires permission to access the ListPrincipalPolicies action. *
* * @param listPrincipalPoliciesRequest * The input for the ListPrincipalPolicies operation. * @return 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. *
** Requires permission to access the ListPrincipalThings action. *
* * @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 provisioning template versions. *
** Requires permission to access the ListProvisioningTemplateVersions action. *
* * @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 provisioning templates in your Amazon Web Services account. *
** Requires permission to access the ListProvisioningTemplates action. *
* * @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); /** ** The related resources of an Audit finding. The following resources can be returned from calling this API: *
** DEVICE_CERTIFICATE *
** CA_CERTIFICATE *
** IOT_POLICY *
** COGNITO_IDENTITY_POOL *
** CLIENT_ID *
** ACCOUNT_SETTINGS *
** ROLE_ALIAS *
** IAM_ROLE *
** ISSUER_CERTIFICATE *
** This API is similar to DescribeAuditFinding's RelatedResources but * provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding * for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You * must use this API, ListRelatedResourcesForAuditFinding, to list the certificates. *
** Lists the role aliases registered in your account. *
** Requires permission to access the ListRoleAliases action. *
* * @param listRoleAliasesRequest * @return 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. *
** Requires permission to access the ListScheduledAudits action. *
* * @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've created. You can filter security profiles by dimension or * custom metric. *
** Requires permission to access the ListSecurityProfiles action. *
*
* dimensionName
and metricName
cannot be used in the same request.
*
* Lists the Device Defender security profiles attached to a target (thing group). *
** Requires permission to access the ListSecurityProfilesForTarget action. *
* * @param listSecurityProfilesForTargetRequest * @return 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 Amazon Web Services account. *
** Requires permission to access the ListStreams action. *
* * @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. *
** Requires permission to access the ListTagsForResource action. *
* * @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. *
** Requires permission to access the ListTargetsForPolicy action. *
* * @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. *
** Requires permission to access the ListTargetsForSecurityProfile action. *
* * @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. *
** Requires permission to access the ListThingGroups action. *
* * @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. * @throws ThrottlingException * The rate exceeds the limit. * @sample AWSIot.ListThingGroups */ ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest); /** ** List the thing groups to which the specified thing belongs. *
** Requires permission to access the ListThingGroupsForThing action. *
* * @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. * @throws ThrottlingException * The rate exceeds the limit. * @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. *
** Requires permission to access the ListThingPrincipals action. *
* * @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. *
** Requires permission to access the ListThingRegistrationTasks action. *
* * @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. *
** Requires permission to access the ListThingTypes action. *
* * @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. For more information, see List Things from
* the Amazon Web Services IoT Core Developer Guide.
*
* Requires permission to access the ListThings action. *
*
* You will not be charged for calling this API if an Access denied
error is returned. You will also
* not be charged if no attributes or pagination token was provided in request and no pagination token and no
* results were returned.
*
* Lists the things you have added to the given billing group. *
** Requires permission to access the ListThingsInBillingGroup action. *
* * @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. *
** Requires permission to access the ListThingsInThingGroup action. *
* * @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. * @throws ThrottlingException * The rate exceeds the limit. * @sample AWSIot.ListThingsInThingGroup */ ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest); /** ** Lists all the topic rule destinations in your Amazon Web Services account. *
** Requires permission to access the ListTopicRuleDestinations action. *
* * @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. *
** Requires permission to access the ListTopicRules action. *
* * @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. *
** Requires permission to access the ListV2LoggingLevels action. *
* * @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). *
** Requires permission to access the ListViolationEvents action. *
* * @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); /** ** Set a verification state and provide a description of that verification state on a violation (detect alarm). *
* * @param putVerificationStateOnViolationRequest * @return Result of the PutVerificationStateOnViolation 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.PutVerificationStateOnViolation */ PutVerificationStateOnViolationResult putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest); /** *
* Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates
* you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same
* CA subject field
per Amazon Web Services account.
*
* Requires permission to access the RegisterCACertificate action. *
* * @param registerCACertificateRequest * The input to the RegisterCACertificate operation. * @return Result of the RegisterCACertificate operation returned by the service. * @throws ResourceNotFoundException * The specified resource does not exist. * @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 IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject * field, you must specify the CA certificate that was used to sign the device certificate being registered. *
** Requires permission to access the RegisterCertificate action. *
* * @param registerCertificateRequest * The input to the RegisterCertificate operation. * @return 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). For supported certificates, consult * Certificate signing algorithms supported by IoT. *
* * @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 IoT control plane APIs. These calls might * exceed your account level IoT Throttling * Limits and cause throttle errors. Please contact Amazon * Web Services Customer Support to raise your throttling limits if necessary. *
** Requires permission to access the RegisterThing action. *
* * @param registerThingRequest * @return 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 IoT rejects a certificate transfer, the certificate status changes * from PENDING_TRANSFER to INACTIVE. *
** To check for pending certificate transfers, call ListCertificates to enumerate your certificates. *
** This operation can only be called by the transfer destination. After it is called, the certificate will be * returned to the source's account in the INACTIVE state. *
** Requires permission to access the RejectCertificateTransfer action. *
* * @param rejectCertificateTransferRequest * The input for the RejectCertificateTransfer operation. * @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. *
** Requires permission to access the RemoveThingFromBillingGroup action. *
** This call is asynchronous. It might take several seconds for the detachment to propagate. *
** Remove the specified thing from the specified group. *
*
* You must specify either a thingGroupArn
or a thingGroupName
to identify the thing group
* and either a thingArn
or a thingName
to identify the thing to remove from the thing
* group.
*
* Requires permission to access the RemoveThingFromThingGroup action. *
* * @param removeThingFromThingGroupRequest * @return 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. *
** Requires permission to access the ReplaceTopicRule action. *
* * @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. *
** Requires permission to access the SearchIndex action. *
* * @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. *
** Requires permission to access the SetDefaultAuthorizer action. *
* * @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 ListPrincipalPolicies action. *
** Requires permission to access the SetDefaultPolicyVersion action. *
* * @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.
*
* Requires permission to access the SetLoggingOptions action. *
* * @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. *
** Requires permission to access the SetV2LoggingLevel action. *
* * @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. * @throws LimitExceededException * A limit has been exceeded. * @sample AWSIot.SetV2LoggingLevel */ SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest); /** ** Sets the logging options for the V2 logging service. *
** Requires permission to access the SetV2LoggingOptions action. *
* * @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. *
** Requires permission to access the StartAuditMitigationActionsTask action. *
* * @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 a Device Defender ML Detect mitigation actions task. *
** Requires permission to access the StartDetectMitigationActionsTask action. *
* * @param startDetectMitigationActionsTaskRequest * @return Result of the StartDetectMitigationActionsTask 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.StartDetectMitigationActionsTask */ StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest); /** ** Starts an on-demand Device Defender audit. *
** Requires permission to access the StartOnDemandAuditTask action. *
* * @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. *
** Requires permission to access the StartThingRegistrationTask action. *
* * @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. *
** Requires permission to access the StopThingRegistrationTask action. *
* * @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. *
** Requires permission to access the TagResource action. *
* * @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 IoT action on a specified resource. Use this to test * and debug the authorization behavior of devices that connect to the IoT device gateway. *
** Requires permission to access the TestAuthorization action. *
* * @param testAuthorizationRequest * @return 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 IoT device gateway. *
** Requires permission to access the TestInvokeAuthorizer action. *
* * @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 Amazon Web Services account. *
** Requires permission to access the TransferCertificate action. *
** You can cancel the transfer until it is acknowledged by the recipient. *
** No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer * target. *
** The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate * action to deactivate it. *
** The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach * them. *
* * @param transferCertificateRequest * The input for the TransferCertificate operation. * @return 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. *
** Requires permission to access the UntagResource action. *
* * @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. *
** Requires permission to access the UpdateAccountAuditConfiguration action. *
* * @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. *
** Requires permission to access the UpdateAuthorizer action. *
* * @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. *
** Requires permission to access the UpdateBillingGroup action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the UpdateCACertificate action. *
* * @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. *
** Requires permission to access the UpdateCertificate action. *
** Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT. *
** Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all * devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state * to reconnect. *
* * @param updateCertificateRequest * The input for the UpdateCertificate operation. * @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 a Device Defender detect custom metric. *
** Requires permission to access the UpdateCustomMetric action. *
* * @param updateCustomMetricRequest * @return Result of the UpdateCustomMetric 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.UpdateCustomMetric */ UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest); /** ** Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can * delete it and recreate it). *
** Requires permission to access the UpdateDimension action. *
* * @param updateDimensionRequest * @return 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. *
** Requires permission to access the UpdateDomainConfiguration action. *
* * @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. *
** Requires permission to access the UpdateDynamicThingGroup action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the UpdateEventConfigurations action. *
* * @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 data for a fleet metric. *
** Requires permission to access the UpdateFleetMetric action. *
* * @param updateFleetMetricRequest * @return Result of the UpdateFleetMetric 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 VersionConflictException * An exception thrown when the version of an entity specified with theexpectedVersion
* parameter does not match the latest version in the system.
* @throws IndexNotReadyException
* The index is not ready.
* @sample AWSIot.UpdateFleetMetric
*/
UpdateFleetMetricResult updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest);
/**
* * Updates the search configuration. *
** Requires permission to access the UpdateIndexingConfiguration action. *
* * @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. *
** Requires permission to access the UpdateJob action. *
* * @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. *
** Requires permission to access the UpdateMitigationAction 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 the supported fields for a specific package. *
** Requires permission to access the UpdatePackage and GetIndexingConfiguration actions. *
* * @param updatePackageRequest * @return Result of the UpdatePackage operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ResourceNotFoundException * The specified resource does not exist. * @sample AWSIot.UpdatePackage */ UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest); /** ** Updates the package configuration. *
** Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions. *
* * @param updatePackageConfigurationRequest * @return Result of the UpdatePackageConfiguration operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @sample AWSIot.UpdatePackageConfiguration */ UpdatePackageConfigurationResult updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest); /** ** Updates the supported fields for a specific package version. *
** Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions. *
* * @param updatePackageVersionRequest * @return Result of the UpdatePackageVersion operation returned by the service. * @throws ThrottlingException * The rate exceeds the limit. * @throws InternalServerException * Internal error from the service that indicates an unexpected error or that the service is unavailable. * @throws ValidationException * The request is not valid. * @throws ResourceNotFoundException * The specified resource does not exist. * @sample AWSIot.UpdatePackageVersion */ UpdatePackageVersionResult updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest); /** ** Updates a provisioning template. *
** Requires permission to access the UpdateProvisioningTemplate action. *
* * @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. *
** Requires permission to access the UpdateRoleAlias action. *
* * @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. *
** Requires permission to access the UpdateScheduledAudit action. *
* * @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. *
** Requires permission to access the UpdateSecurityProfile action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the UpdateStream action. *
* * @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. *
** Requires permission to access the UpdateThing action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the UpdateThingGroup action. *
* * @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 theexpectedVersion
* 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. *
** Requires permission to access the UpdateThingGroupsForThing action. *
* * @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. *
** Requires permission to access the UpdateTopicRuleDestination action. *
* * @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. *
** Requires permission to access the ValidateSecurityProfileBehaviors action. *
* * @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); }