UNPKG

@aws-sdk/client-iot

Version:

AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native

112 lines (111 loc) 4.66 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { CreateAuditSuppressionRequest, CreateAuditSuppressionResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateAuditSuppressionCommand}. */ export interface CreateAuditSuppressionCommandInput extends CreateAuditSuppressionRequest { } /** * @public * * The output of {@link CreateAuditSuppressionCommand}. */ export interface CreateAuditSuppressionCommandOutput extends CreateAuditSuppressionResponse, __MetadataBearer { } declare const CreateAuditSuppressionCommand_base: { new (input: CreateAuditSuppressionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAuditSuppressionCommandInput, CreateAuditSuppressionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: CreateAuditSuppressionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAuditSuppressionCommandInput, CreateAuditSuppressionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p> * Creates a Device Defender audit suppression. * </p> * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateAuditSuppression</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, CreateAuditSuppressionCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, CreateAuditSuppressionCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // CreateAuditSuppressionRequest * checkName: "STRING_VALUE", // required * resourceIdentifier: { // ResourceIdentifier * deviceCertificateId: "STRING_VALUE", * caCertificateId: "STRING_VALUE", * cognitoIdentityPoolId: "STRING_VALUE", * clientId: "STRING_VALUE", * policyVersionIdentifier: { // PolicyVersionIdentifier * policyName: "STRING_VALUE", * policyVersionId: "STRING_VALUE", * }, * account: "STRING_VALUE", * iamRoleArn: "STRING_VALUE", * roleAliasArn: "STRING_VALUE", * issuerCertificateIdentifier: { // IssuerCertificateIdentifier * issuerCertificateSubject: "STRING_VALUE", * issuerId: "STRING_VALUE", * issuerCertificateSerialNumber: "STRING_VALUE", * }, * deviceCertificateArn: "STRING_VALUE", * }, * expirationDate: new Date("TIMESTAMP"), * suppressIndefinitely: true || false, * description: "STRING_VALUE", * clientRequestToken: "STRING_VALUE", // required * }; * const command = new CreateAuditSuppressionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param CreateAuditSuppressionCommandInput - {@link CreateAuditSuppressionCommandInput} * @returns {@link CreateAuditSuppressionCommandOutput} * @see {@link CreateAuditSuppressionCommandInput} for command's `input` shape. * @see {@link CreateAuditSuppressionCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link InternalFailureException} (server fault) * <p>An unexpected error has occurred.</p> * * @throws {@link InvalidRequestException} (client fault) * <p>The request is not valid.</p> * * @throws {@link LimitExceededException} (client fault) * <p>A limit has been exceeded.</p> * * @throws {@link ResourceAlreadyExistsException} (client fault) * <p>The resource already exists.</p> * * @throws {@link ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * * @public */ export declare class CreateAuditSuppressionCommand extends CreateAuditSuppressionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateAuditSuppressionRequest; output: {}; }; sdk: { input: CreateAuditSuppressionCommandInput; output: CreateAuditSuppressionCommandOutput; }; }; }