UNPKG

@aws-sdk/client-account

Version:

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

95 lines (94 loc) 3.98 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccountClient"; import { DisableRegionRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DisableRegionCommand}. */ export interface DisableRegionCommandInput extends DisableRegionRequest { } /** * @public * * The output of {@link DisableRegionCommand}. */ export interface DisableRegionCommandOutput extends __MetadataBearer { } declare const DisableRegionCommand_base: { new (input: DisableRegionCommandInput): import("@smithy/smithy-client").CommandImpl<DisableRegionCommandInput, DisableRegionCommandOutput, AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: DisableRegionCommandInput): import("@smithy/smithy-client").CommandImpl<DisableRegionCommandInput, DisableRegionCommandOutput, AccountClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Disables (opts-out) a particular Region for an account.</p> * <note> * <p>The act of disabling a Region will remove all IAM access to any resources that * reside in that Region.</p> * </note> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { AccountClient, DisableRegionCommand } from "@aws-sdk/client-account"; // ES Modules import * // const { AccountClient, DisableRegionCommand } = require("@aws-sdk/client-account"); // CommonJS import * const client = new AccountClient(config); * const input = { // DisableRegionRequest * AccountId: "STRING_VALUE", * RegionName: "STRING_VALUE", // required * }; * const command = new DisableRegionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DisableRegionCommandInput - {@link DisableRegionCommandInput} * @returns {@link DisableRegionCommandOutput} * @see {@link DisableRegionCommandInput} for command's `input` shape. * @see {@link DisableRegionCommandOutput} for command's `response` shape. * @see {@link AccountClientResolvedConfig | config} for AccountClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) * <p>The operation failed because the calling identity doesn't have the minimum required * permissions.</p> * * @throws {@link ConflictException} (client fault) * <p>The request could not be processed because of a conflict in the current status of the * resource. For example, this happens if you try to enable a Region that is currently being disabled * (in a status of DISABLING).</p> * * @throws {@link InternalServerException} (server fault) * <p>The operation failed because of an error internal to Amazon Web Services. Try your operation again * later.</p> * * @throws {@link TooManyRequestsException} (client fault) * <p>The operation failed because it was called too frequently and exceeded a throttle * limit.</p> * * @throws {@link ValidationException} (client fault) * <p>The operation failed because one of the input parameters was invalid.</p> * * @throws {@link AccountServiceException} * <p>Base exception class for all service exceptions from Account service.</p> * * @public */ export declare class DisableRegionCommand extends DisableRegionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DisableRegionRequest; output: {}; }; sdk: { input: DisableRegionCommandInput; output: DisableRegionCommandOutput; }; }; }