UNPKG

@aws-sdk/client-ssm

Version:

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

82 lines (81 loc) 3.43 kB
import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteParameterRequest, DeleteParameterResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DeleteParameterCommand}. */ export interface DeleteParameterCommandInput extends DeleteParameterRequest { } /** * @public * * The output of {@link DeleteParameterCommand}. */ export interface DeleteParameterCommandOutput extends DeleteParameterResult, __MetadataBearer { } declare const DeleteParameterCommand_base: { new (input: DeleteParameterCommandInput): import("@smithy/core/client").CommandImpl<DeleteParameterCommandInput, DeleteParameterCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; new (input: DeleteParameterCommandInput): import("@smithy/core/client").CommandImpl<DeleteParameterCommandInput, DeleteParameterCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * <p>Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds * to create a parameter with the same name.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, DeleteParameterCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, DeleteParameterCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * // import type { SSMClientConfig } from "@aws-sdk/client-ssm"; * const config = {}; // type is SSMClientConfig * const client = new SSMClient(config); * const input = { // DeleteParameterRequest * Name: "STRING_VALUE", // required * }; * const command = new DeleteParameterCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteParameterCommandInput - {@link DeleteParameterCommandInput} * @returns {@link DeleteParameterCommandOutput} * @see {@link DeleteParameterCommandInput} for command's `input` shape. * @see {@link DeleteParameterCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link InternalServerError} (server fault) * <p>An error occurred on the server side.</p> * * @throws {@link ParameterNotFound} (client fault) * <p>The parameter couldn't be found. Verify the name and try again.</p> * <note> * <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the * specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is * <i>not</i> recorded in CloudTrail event logs.</p> * </note> * * @throws {@link SSMServiceException} * <p>Base exception class for all service exceptions from SSM service.</p> * * * @public */ export declare class DeleteParameterCommand extends DeleteParameterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteParameterRequest; output: {}; }; sdk: { input: DeleteParameterCommandInput; output: DeleteParameterCommandOutput; }; }; }