feat(client-arc-region-switch): New API to list Route 53 health checks created by ARC region switch for a plan in a specific AWS Region using the Region switch Regional data plane.

Author: awstools

clients/client-arc-region-switch/README.md

@@ -306,6 +306,14 @@ ListRoute53HealthChecks
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/arc-region-switch/command/ListRoute53HealthChecksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-region-switch/Interface/ListRoute53HealthChecksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-region-switch/Interface/ListRoute53HealthChecksCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListRoute53HealthChecksInRegion
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/arc-region-switch/command/ListRoute53HealthChecksInRegionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-region-switch/Interface/ListRoute53HealthChecksInRegionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-region-switch/Interface/ListRoute53HealthChecksInRegionCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-arc-region-switch/src/ARCRegionSwitch.ts

@@ -52,6 +52,11 @@ import {
   ListRoute53HealthChecksCommandInput,
   ListRoute53HealthChecksCommandOutput,
 } from "./commands/ListRoute53HealthChecksCommand";
+import {
+  ListRoute53HealthChecksInRegionCommand,
+  ListRoute53HealthChecksInRegionCommandInput,
+  ListRoute53HealthChecksInRegionCommandOutput,
+} from "./commands/ListRoute53HealthChecksInRegionCommand";
 import {
   ListTagsForResourceCommand,
   ListTagsForResourceCommandInput,
@@ -94,6 +99,7 @@ const commands = {
   ListPlansCommand,
   ListPlansInRegionCommand,
   ListRoute53HealthChecksCommand,
+  ListRoute53HealthChecksInRegionCommand,
   ListTagsForResourceCommand,
   StartPlanExecutionCommand,
   TagResourceCommand,
@@ -300,6 +306,23 @@ export interface ARCRegionSwitch {
     cb: (err: any, data?: ListRoute53HealthChecksCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListRoute53HealthChecksInRegionCommand}
+   */
+  listRoute53HealthChecksInRegion(
+    args: ListRoute53HealthChecksInRegionCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListRoute53HealthChecksInRegionCommandOutput>;
+  listRoute53HealthChecksInRegion(
+    args: ListRoute53HealthChecksInRegionCommandInput,
+    cb: (err: any, data?: ListRoute53HealthChecksInRegionCommandOutput) => void
+  ): void;
+  listRoute53HealthChecksInRegion(
+    args: ListRoute53HealthChecksInRegionCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListRoute53HealthChecksInRegionCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListTagsForResourceCommand}
    */

clients/client-arc-region-switch/src/ARCRegionSwitchClient.ts

@@ -91,6 +91,10 @@ import {
   ListRoute53HealthChecksCommandInput,
   ListRoute53HealthChecksCommandOutput,
 } from "./commands/ListRoute53HealthChecksCommand";
+import {
+  ListRoute53HealthChecksInRegionCommandInput,
+  ListRoute53HealthChecksInRegionCommandOutput,
+} from "./commands/ListRoute53HealthChecksInRegionCommand";
 import {
   ListTagsForResourceCommandInput,
   ListTagsForResourceCommandOutput,
@@ -135,6 +139,7 @@ export type ServiceInputTypes =
   | ListPlansCommandInput
   | ListPlansInRegionCommandInput
   | ListRoute53HealthChecksCommandInput
+  | ListRoute53HealthChecksInRegionCommandInput
   | ListTagsForResourceCommandInput
   | StartPlanExecutionCommandInput
   | TagResourceCommandInput
@@ -160,6 +165,7 @@ export type ServiceOutputTypes =
   | ListPlansCommandOutput
   | ListPlansInRegionCommandOutput
   | ListRoute53HealthChecksCommandOutput
+  | ListRoute53HealthChecksInRegionCommandOutput
   | ListTagsForResourceCommandOutput
   | StartPlanExecutionCommandOutput
   | TagResourceCommandOutput

clients/client-arc-region-switch/src/commands/ListRoute53HealthChecksCommand.ts

@@ -55,6 +55,7 @@ export interface ListRoute53HealthChecksCommandOutput extends ListRoute53HealthC
  * //       hostedZoneId: "STRING_VALUE", // required
  * //       recordName: "STRING_VALUE", // required
  * //       healthCheckId: "STRING_VALUE",
+ * //       status: "healthy" || "unhealthy" || "unknown",
  * //       region: "STRING_VALUE", // required
  * //     },
  * //   ],

clients/client-arc-region-switch/src/commands/ListRoute53HealthChecksInRegionCommand.ts

@@ -0,0 +1,157 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import type {
+  ARCRegionSwitchClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../ARCRegionSwitchClient";
+import { commonParams } from "../endpoint/EndpointParameters";
+import type {
+  ListRoute53HealthChecksInRegionRequest,
+  ListRoute53HealthChecksInRegionResponse,
+} from "../models/models_0";
+import { ListRoute53HealthChecksInRegion$ } from "../schemas/schemas_0";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListRoute53HealthChecksInRegionCommand}.
+ */
+export interface ListRoute53HealthChecksInRegionCommandInput extends ListRoute53HealthChecksInRegionRequest {}
+/**
+ * @public
+ *
+ * The output of {@link ListRoute53HealthChecksInRegionCommand}.
+ */
+export interface ListRoute53HealthChecksInRegionCommandOutput
+  extends ListRoute53HealthChecksInRegionResponse,
+    __MetadataBearer {}
+
+/**
+ * <p>List the Amazon Route 53 health checks in a specific Amazon Web Services Region.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCRegionSwitchClient, ListRoute53HealthChecksInRegionCommand } from "@aws-sdk/client-arc-region-switch"; // ES Modules import
+ * // const { ARCRegionSwitchClient, ListRoute53HealthChecksInRegionCommand } = require("@aws-sdk/client-arc-region-switch"); // CommonJS import
+ * // import type { ARCRegionSwitchClientConfig } from "@aws-sdk/client-arc-region-switch";
+ * const config = {}; // type is ARCRegionSwitchClientConfig
+ * const client = new ARCRegionSwitchClient(config);
+ * const input = { // ListRoute53HealthChecksInRegionRequest
+ *   arn: "STRING_VALUE", // required
+ *   hostedZoneId: "STRING_VALUE",
+ *   recordName: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListRoute53HealthChecksInRegionCommand(input);
+ * const response = await client.send(command);
+ * // { // ListRoute53HealthChecksInRegionResponse
+ * //   healthChecks: [ // Route53HealthCheckList
+ * //     { // Route53HealthCheck
+ * //       hostedZoneId: "STRING_VALUE", // required
+ * //       recordName: "STRING_VALUE", // required
+ * //       healthCheckId: "STRING_VALUE",
+ * //       status: "healthy" || "unhealthy" || "unknown",
+ * //       region: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListRoute53HealthChecksInRegionCommandInput - {@link ListRoute53HealthChecksInRegionCommandInput}
+ * @returns {@link ListRoute53HealthChecksInRegionCommandOutput}
+ * @see {@link ListRoute53HealthChecksInRegionCommandInput} for command's `input` shape.
+ * @see {@link ListRoute53HealthChecksInRegionCommandOutput} 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 IllegalArgumentException} (client fault)
+ *  <p>The request processing has an invalid argument.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>HTTP Status Code: 500</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>
+ *
+ *
+ * @example Example ListRoute53HealthChecksInRegion
+ * ```javascript
+ * //
+ * const input = {
+ *   arn: "arn:aws:arc-region-switch::123456789012:plan/example:000000",
+ *   hostedZoneId: "Z0123456789ABCDEFGHI",
+ *   maxResults: 10,
+ *   nextToken: "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ",
+ *   recordName: "my.record.name"
+ * };
+ * const command = new ListRoute53HealthChecksInRegionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   healthChecks: [
+ *     {
+ *       healthCheckId: "01234567-8901-abcd-efgh-ijklmnop0123",
+ *       hostedZoneId: "Z0123456789ABCDEFGHI",
+ *       recordName: "my.record.name",
+ *       region: "us-west-2",
+ *       status: "healthy"
+ *     },
+ *     {
+ *       healthCheckId: "zyxwvuts-rqpo-9876-5432-10nmlkji0123",
+ *       hostedZoneId: "Z0123456789ABCDEFGHI",
+ *       recordName: "my.record.name",
+ *       region: "us-east-1",
+ *       status: "healthy"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export class ListRoute53HealthChecksInRegionCommand extends $Command
+  .classBuilder<
+    ListRoute53HealthChecksInRegionCommandInput,
+    ListRoute53HealthChecksInRegionCommandOutput,
+    ARCRegionSwitchClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: ARCRegionSwitchClientResolvedConfig, o: any) {
+    return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())];
+  })
+  .s("ArcRegionSwitch", "ListRoute53HealthChecksInRegion", {})
+  .n("ARCRegionSwitchClient", "ListRoute53HealthChecksInRegionCommand")
+  .sc(ListRoute53HealthChecksInRegion$)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: ListRoute53HealthChecksInRegionRequest;
+      output: ListRoute53HealthChecksInRegionResponse;
+    };
+    sdk: {
+      input: ListRoute53HealthChecksInRegionCommandInput;
+      output: ListRoute53HealthChecksInRegionCommandOutput;
+    };
+  };
+}

clients/client-arc-region-switch/src/commands/index.ts

@@ -12,6 +12,7 @@ export * from "./ListPlanExecutionsCommand";
 export * from "./ListPlansCommand";
 export * from "./ListPlansInRegionCommand";
 export * from "./ListRoute53HealthChecksCommand";
+export * from "./ListRoute53HealthChecksInRegionCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./StartPlanExecutionCommand";
 export * from "./TagResourceCommand";

clients/client-arc-region-switch/src/endpoint/ruleset.ts

@@ -11,13 +11,13 @@ x="argv",
 y="ref";
 const a=true,
 b=false,
-c="Boolean",
+c="boolean",
 d="sigv4",
 e="arc-region-switch",
 f="endpoint",
 g="tree",
 h="error",
-i={"required":false,"type":"String"},
+i={"required":false,"type":"string"},
 j={[w]:"isSet",[x]:[{[y]:"UseControlPlaneEndpoint"}]},
 k={[w]:"booleanEquals",[x]:[{[y]:"UseControlPlaneEndpoint"},true]},
 l={[w]:"isSet",[x]:[{[y]:"Region"}]},

clients/client-arc-region-switch/src/models/enums.ts

@@ -321,6 +321,20 @@ export const ExecutionEventType = {
  */
 export type ExecutionEventType = (typeof ExecutionEventType)[keyof typeof ExecutionEventType];
 
+/**
+ * @public
+ * @enum
+ */
+export const Route53HealthCheckStatus = {
+  HEALTHY: "healthy",
+  UNHEALTHY: "unhealthy",
+  UNKNOWN: "unknown",
+} as const;
+/**
+ * @public
+ */
+export type Route53HealthCheckStatus = (typeof Route53HealthCheckStatus)[keyof typeof Route53HealthCheckStatus];
+
 /**
  * @public
  * @enum

clients/client-arc-region-switch/src/models/errors.ts

@@ -64,41 +64,41 @@ export class InternalServerException extends __BaseException {
 }
 
 /**
- * <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>
+ * <p>The request processing has an invalid argument.</p>
  * @public
  */
-export class IllegalStateException extends __BaseException {
-  readonly name = "IllegalStateException" as const;
+export class IllegalArgumentException extends __BaseException {
+  readonly name = "IllegalArgumentException" as const;
   readonly $fault = "client" as const;
   /**
    * @internal
    */
-  constructor(opts: __ExceptionOptionType<IllegalStateException, __BaseException>) {
+  constructor(opts: __ExceptionOptionType<IllegalArgumentException, __BaseException>) {
     super({
-      name: "IllegalStateException",
+      name: "IllegalArgumentException",
       $fault: "client",
       ...opts,
     });
-    Object.setPrototypeOf(this, IllegalStateException.prototype);
+    Object.setPrototypeOf(this, IllegalArgumentException.prototype);
   }
 }
 
 /**
- * <p>The request processing has an invalid argument.</p>
+ * <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>
  * @public
  */
-export class IllegalArgumentException extends __BaseException {
-  readonly name = "IllegalArgumentException" as const;
+export class IllegalStateException extends __BaseException {
+  readonly name = "IllegalStateException" as const;
   readonly $fault = "client" as const;
   /**
    * @internal
    */
-  constructor(opts: __ExceptionOptionType<IllegalArgumentException, __BaseException>) {
+  constructor(opts: __ExceptionOptionType<IllegalStateException, __BaseException>) {
     super({
-      name: "IllegalArgumentException",
+      name: "IllegalStateException",
       $fault: "client",
       ...opts,
     });
-    Object.setPrototypeOf(this, IllegalArgumentException.prototype);
+    Object.setPrototypeOf(this, IllegalStateException.prototype);
   }
 }