@aws-sdk/client-arc-region-switch 3.859.0

package/dist-types/commands/UpdatePlanExecutionCommand.d.ts

@@ -0,0 +1,82 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCRegionSwitchClient";
+import { UpdatePlanExecutionRequest, UpdatePlanExecutionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdatePlanExecutionCommand}.
+ */
+export interface UpdatePlanExecutionCommandInput extends UpdatePlanExecutionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdatePlanExecutionCommand}.
+ */
+export interface UpdatePlanExecutionCommandOutput extends UpdatePlanExecutionResponse, __MetadataBearer {
+}
+declare const UpdatePlanExecutionCommand_base: {
+    new (input: UpdatePlanExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePlanExecutionCommandInput, UpdatePlanExecutionCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdatePlanExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePlanExecutionCommandInput, UpdatePlanExecutionCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCRegionSwitchClient, UpdatePlanExecutionCommand } from "@aws-sdk/client-arc-region-switch"; // ES Modules import
+ * // const { ARCRegionSwitchClient, UpdatePlanExecutionCommand } = require("@aws-sdk/client-arc-region-switch"); // CommonJS import
+ * const client = new ARCRegionSwitchClient(config);
+ * const input = { // UpdatePlanExecutionRequest
+ *   planArn: "STRING_VALUE", // required
+ *   executionId: "STRING_VALUE", // required
+ *   action: "switchToGraceful" || "switchToUngraceful" || "pause" || "resume", // required
+ *   comment: "STRING_VALUE",
+ * };
+ * const command = new UpdatePlanExecutionCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdatePlanExecutionCommandInput - {@link UpdatePlanExecutionCommandInput}
+ * @returns {@link UpdatePlanExecutionCommandOutput}
+ * @see {@link UpdatePlanExecutionCommandInput} for command's `input` shape.
+ * @see {@link UpdatePlanExecutionCommandOutput} for command's `response` shape.
+ * @see {@link ARCRegionSwitchClientResolvedConfig | config} for ARCRegionSwitchClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
+ *
+ * @throws {@link IllegalStateException} (client fault)
+ *  <p>The operation failed because the current state of the resource doesn't allow the operation to proceed.</p> <p>HTTP Status Code: 400</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
+ *
+ * @throws {@link ARCRegionSwitchServiceException}
+ * <p>Base exception class for all service exceptions from ARCRegionSwitch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdatePlanExecutionCommand extends UpdatePlanExecutionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdatePlanExecutionRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdatePlanExecutionCommandInput;
+            output: UpdatePlanExecutionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdatePlanExecutionStepCommand.d.ts

@@ -0,0 +1,80 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCRegionSwitchClient";
+import { UpdatePlanExecutionStepRequest, UpdatePlanExecutionStepResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdatePlanExecutionStepCommand}.
+ */
+export interface UpdatePlanExecutionStepCommandInput extends UpdatePlanExecutionStepRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdatePlanExecutionStepCommand}.
+ */
+export interface UpdatePlanExecutionStepCommandOutput extends UpdatePlanExecutionStepResponse, __MetadataBearer {
+}
+declare const UpdatePlanExecutionStepCommand_base: {
+    new (input: UpdatePlanExecutionStepCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePlanExecutionStepCommandInput, UpdatePlanExecutionStepCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdatePlanExecutionStepCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePlanExecutionStepCommandInput, UpdatePlanExecutionStepCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCRegionSwitchClient, UpdatePlanExecutionStepCommand } from "@aws-sdk/client-arc-region-switch"; // ES Modules import
+ * // const { ARCRegionSwitchClient, UpdatePlanExecutionStepCommand } = require("@aws-sdk/client-arc-region-switch"); // CommonJS import
+ * const client = new ARCRegionSwitchClient(config);
+ * const input = { // UpdatePlanExecutionStepRequest
+ *   planArn: "STRING_VALUE", // required
+ *   executionId: "STRING_VALUE", // required
+ *   comment: "STRING_VALUE", // required
+ *   stepName: "STRING_VALUE", // required
+ *   actionToTake: "switchToUngraceful" || "skip", // required
+ * };
+ * const command = new UpdatePlanExecutionStepCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdatePlanExecutionStepCommandInput - {@link UpdatePlanExecutionStepCommandInput}
+ * @returns {@link UpdatePlanExecutionStepCommandOutput}
+ * @see {@link UpdatePlanExecutionStepCommandInput} for command's `input` shape.
+ * @see {@link UpdatePlanExecutionStepCommandOutput} for command's `response` shape.
+ * @see {@link ARCRegionSwitchClientResolvedConfig | config} for ARCRegionSwitchClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
+ *
+ * @throws {@link ARCRegionSwitchServiceException}
+ * <p>Base exception class for all service exceptions from ARCRegionSwitch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdatePlanExecutionStepCommand extends UpdatePlanExecutionStepCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdatePlanExecutionStepRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdatePlanExecutionStepCommandInput;
+            output: UpdatePlanExecutionStepCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./ApprovePlanExecutionStepCommand";
+export * from "./CancelPlanExecutionCommand";
+export * from "./CreatePlanCommand";
+export * from "./DeletePlanCommand";
+export * from "./GetPlanCommand";
+export * from "./GetPlanEvaluationStatusCommand";
+export * from "./GetPlanExecutionCommand";
+export * from "./GetPlanInRegionCommand";
+export * from "./ListPlanExecutionEventsCommand";
+export * from "./ListPlanExecutionsCommand";
+export * from "./ListPlansCommand";
+export * from "./ListPlansInRegionCommand";
+export * from "./ListRoute53HealthChecksCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./StartPlanExecutionCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdatePlanCommand";
+export * from "./UpdatePlanExecutionCommand";
+export * from "./UpdatePlanExecutionStepCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,33 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | undefined | Provider<string | undefined>;
+}
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+    Region?: string | undefined;
+    UseControlPlaneEndpoint?: boolean | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface ARCRegionSwitchExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * <p>Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.</p> <p>Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./ARCRegionSwitchClient";
+export * from "./ARCRegionSwitch";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { ARCRegionSwitchExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./waiters";
+export * from "./models";
+export { ARCRegionSwitchServiceException } from "./models/ARCRegionSwitchServiceException";

package/dist-types/models/ARCRegionSwitchServiceException.d.ts

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from ARCRegionSwitch service.
+ */
+export declare class ARCRegionSwitchServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";