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

package/dist-types/auth/httpAuthExtensionConfiguration.d.ts

@@ -0,0 +1,29 @@
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
+import { ARCRegionSwitchHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
+/**
+ * @internal
+ */
+export interface HttpAuthExtensionConfiguration {
+    setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
+    httpAuthSchemes(): HttpAuthScheme[];
+    setHttpAuthSchemeProvider(httpAuthSchemeProvider: ARCRegionSwitchHttpAuthSchemeProvider): void;
+    httpAuthSchemeProvider(): ARCRegionSwitchHttpAuthSchemeProvider;
+    setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
+    credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
+}
+/**
+ * @internal
+ */
+export type HttpAuthRuntimeConfig = Partial<{
+    httpAuthSchemes: HttpAuthScheme[];
+    httpAuthSchemeProvider: ARCRegionSwitchHttpAuthSchemeProvider;
+    credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+}>;
+/**
+ * @internal
+ */
+export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -0,0 +1,75 @@
+import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
+import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
+import { ARCRegionSwitchClientResolvedConfig } from "../ARCRegionSwitchClient";
+/**
+ * @internal
+ */
+export interface ARCRegionSwitchHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
+    region?: string;
+}
+/**
+ * @internal
+ */
+export interface ARCRegionSwitchHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<ARCRegionSwitchClientResolvedConfig, HandlerExecutionContext, ARCRegionSwitchHttpAuthSchemeParameters, object> {
+}
+/**
+ * @internal
+ */
+export declare const defaultARCRegionSwitchHttpAuthSchemeParametersProvider: (config: ARCRegionSwitchClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<ARCRegionSwitchHttpAuthSchemeParameters>;
+/**
+ * @internal
+ */
+export interface ARCRegionSwitchHttpAuthSchemeProvider extends HttpAuthSchemeProvider<ARCRegionSwitchHttpAuthSchemeParameters> {
+}
+/**
+ * @internal
+ */
+export declare const defaultARCRegionSwitchHttpAuthSchemeProvider: ARCRegionSwitchHttpAuthSchemeProvider;
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    authSchemePreference?: string[] | Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    httpAuthSchemes?: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    httpAuthSchemeProvider?: ARCRegionSwitchHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    readonly authSchemePreference: Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    readonly httpAuthSchemes: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    readonly httpAuthSchemeProvider: ARCRegionSwitchHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;

package/dist-types/commands/ApprovePlanExecutionStepCommand.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 { ApprovePlanExecutionStepRequest, ApprovePlanExecutionStepResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ApprovePlanExecutionStepCommand}.
+ */
+export interface ApprovePlanExecutionStepCommandInput extends ApprovePlanExecutionStepRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ApprovePlanExecutionStepCommand}.
+ */
+export interface ApprovePlanExecutionStepCommandOutput extends ApprovePlanExecutionStepResponse, __MetadataBearer {
+}
+declare const ApprovePlanExecutionStepCommand_base: {
+    new (input: ApprovePlanExecutionStepCommandInput): import("@smithy/smithy-client").CommandImpl<ApprovePlanExecutionStepCommandInput, ApprovePlanExecutionStepCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ApprovePlanExecutionStepCommandInput): import("@smithy/smithy-client").CommandImpl<ApprovePlanExecutionStepCommandInput, ApprovePlanExecutionStepCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.</p> <p>You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCRegionSwitchClient, ApprovePlanExecutionStepCommand } from "@aws-sdk/client-arc-region-switch"; // ES Modules import
+ * // const { ARCRegionSwitchClient, ApprovePlanExecutionStepCommand } = require("@aws-sdk/client-arc-region-switch"); // CommonJS import
+ * const client = new ARCRegionSwitchClient(config);
+ * const input = { // ApprovePlanExecutionStepRequest
+ *   planArn: "STRING_VALUE", // required
+ *   executionId: "STRING_VALUE", // required
+ *   stepName: "STRING_VALUE", // required
+ *   approval: "approve" || "decline", // required
+ *   comment: "STRING_VALUE",
+ * };
+ * const command = new ApprovePlanExecutionStepCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param ApprovePlanExecutionStepCommandInput - {@link ApprovePlanExecutionStepCommandInput}
+ * @returns {@link ApprovePlanExecutionStepCommandOutput}
+ * @see {@link ApprovePlanExecutionStepCommandInput} for command's `input` shape.
+ * @see {@link ApprovePlanExecutionStepCommandOutput} 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 ApprovePlanExecutionStepCommand extends ApprovePlanExecutionStepCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ApprovePlanExecutionStepRequest;
+            output: {};
+        };
+        sdk: {
+            input: ApprovePlanExecutionStepCommandInput;
+            output: ApprovePlanExecutionStepCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,78 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCRegionSwitchClient";
+import { CancelPlanExecutionRequest, CancelPlanExecutionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CancelPlanExecutionCommand}.
+ */
+export interface CancelPlanExecutionCommandInput extends CancelPlanExecutionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CancelPlanExecutionCommand}.
+ */
+export interface CancelPlanExecutionCommandOutput extends CancelPlanExecutionResponse, __MetadataBearer {
+}
+declare const CancelPlanExecutionCommand_base: {
+    new (input: CancelPlanExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<CancelPlanExecutionCommandInput, CancelPlanExecutionCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CancelPlanExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<CancelPlanExecutionCommandInput, CancelPlanExecutionCommandOutput, ARCRegionSwitchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.</p> <p>You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCRegionSwitchClient, CancelPlanExecutionCommand } from "@aws-sdk/client-arc-region-switch"; // ES Modules import
+ * // const { ARCRegionSwitchClient, CancelPlanExecutionCommand } = require("@aws-sdk/client-arc-region-switch"); // CommonJS import
+ * const client = new ARCRegionSwitchClient(config);
+ * const input = { // CancelPlanExecutionRequest
+ *   planArn: "STRING_VALUE", // required
+ *   executionId: "STRING_VALUE", // required
+ *   comment: "STRING_VALUE",
+ * };
+ * const command = new CancelPlanExecutionCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param CancelPlanExecutionCommandInput - {@link CancelPlanExecutionCommandInput}
+ * @returns {@link CancelPlanExecutionCommandOutput}
+ * @see {@link CancelPlanExecutionCommandInput} for command's `input` shape.
+ * @see {@link CancelPlanExecutionCommandOutput} 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 CancelPlanExecutionCommand extends CancelPlanExecutionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CancelPlanExecutionRequest;
+            output: {};
+        };
+        sdk: {
+            input: CancelPlanExecutionCommandInput;
+            output: CancelPlanExecutionCommandOutput;
+        };
+    };
+}