@aws-sdk/client-ecs 3.1152.0 → 3.1154.0

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

@@ -0,0 +1,160 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DescribeGatewayRouteRequest, DescribeGatewayRouteResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link DescribeGatewayRouteCommand}.
+ */
+export interface DescribeGatewayRouteCommandInput extends DescribeGatewayRouteRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeGatewayRouteCommand}.
+ */
+export interface DescribeGatewayRouteCommandOutput extends DescribeGatewayRouteResponse, __MetadataBearer {
+}
+declare const DescribeGatewayRouteCommand_base: {
+    new (input: DescribeGatewayRouteCommandInput): import("@smithy/core/client").CommandImpl<DescribeGatewayRouteCommandInput, DescribeGatewayRouteCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: DescribeGatewayRouteCommandInput): import("@smithy/core/client").CommandImpl<DescribeGatewayRouteCommandInput, DescribeGatewayRouteCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Describes a gateway route, including its status, the service it routes traffic to, and the service-specific infrastructure, such as target groups and listener rules, that the gateway manages for it.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECSClient, DescribeGatewayRouteCommand } from "@aws-sdk/client-ecs"; // ES Modules import
+ * // const { ECSClient, DescribeGatewayRouteCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
+ * // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
+ * const config = {}; // type is ECSClientConfig
+ * const client = new ECSClient(config);
+ * const input = { // DescribeGatewayRouteRequest
+ *   gatewayRouteArn: "STRING_VALUE", // required
+ * };
+ * const command = new DescribeGatewayRouteCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeGatewayRouteResponse
+ * //   gatewayRoute: { // GatewayRoute
+ * //     gatewayRouteArn: "STRING_VALUE",
+ * //     serviceArn: "STRING_VALUE",
+ * //     serviceContainerPortName: "STRING_VALUE",
+ * //     status: "ACTIVE" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
+ * //     serviceUrl: "STRING_VALUE",
+ * //     resources: { // GatewayRouteResources Union: only one key present
+ * //       hostSharedAlb: [ // GatewayRouteAlbResourcesList
+ * //         { // GatewayRouteAlbResources
+ * //           acmCertificateArn: "STRING_VALUE",
+ * //           loadBalancerArn: "STRING_VALUE",
+ * //           listenerArn: "STRING_VALUE",
+ * //           listenerRuleArn: "STRING_VALUE",
+ * //           testListenerRuleArns: [ // StringList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           loadBalancerSecurityGroups: [ // GatewayRouteLoadBalancerSecurityGroupList
+ * //             { // GatewayRouteLoadBalancerSecurityGroup
+ * //               arn: "STRING_VALUE",
+ * //               ruleArns: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //           ],
+ * //           serviceSecurityGroupArn: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeGatewayRouteCommandInput - {@link DescribeGatewayRouteCommandInput}
+ * @returns {@link DescribeGatewayRouteCommandOutput}
+ * @see {@link DescribeGatewayRouteCommandInput} for command's `input` shape.
+ * @see {@link DescribeGatewayRouteCommandOutput} for command's `response` shape.
+ * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have authorization to perform the requested action.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource wasn't found.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server issue.</p>
+ *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
+ *
+ *
+ * @example To describe a gateway route
+ * ```javascript
+ * // This example describes the specified gateway route, including the service URL and the load balancer resources that the gateway manages for the route.
+ * const input = {
+ *   gatewayRouteArn: "arn:aws:ecs:us-east-1:123456789012:gateway-route/my-gateway/a1b2c3d4e5f6478890abcdef12345678/f0e1d2c3b4a5968778695a4b3c2d1e0f"
+ * };
+ * const command = new DescribeGatewayRouteCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   gatewayRoute: {
+ *     gatewayRouteArn: "arn:aws:ecs:us-east-1:123456789012:gateway-route/my-gateway/a1b2c3d4e5f6478890abcdef12345678/f0e1d2c3b4a5968778695a4b3c2d1e0f",
+ *     resources: {
+ *       hostSharedAlb: [
+ *         {
+ *           acmCertificateArn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-90ab-cdef-1234-567890abcdef",
+ *           listenerArn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/ecs-gateway-alb-1/50dc6c495c0c9188/f2f7dc8efc522ab2",
+ *           listenerRuleArn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/ecs-gateway-alb-1/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee",
+ *           loadBalancerArn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/ecs-gateway-alb-1/50dc6c495c0c9188",
+ *           loadBalancerSecurityGroups: [
+ *             {
+ *               arn: "arn:aws:ec2:us-east-1:123456789012:security-group/sg-0123456789abcdef0",
+ *               ruleArns: [
+ *                 "arn:aws:ec2:us-east-1:123456789012:security-group-rule/sgr-0123456789abcdef0"
+ *               ]
+ *             }
+ *           ],
+ *           serviceSecurityGroupArn: "arn:aws:ec2:us-east-1:123456789012:security-group/sg-0fedcba9876543210",
+ *           testListenerRuleArns: [
+ *             "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/ecs-gateway-alb-1/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cc1d2"
+ *           ]
+ *         }
+ *       ]
+ *     },
+ *     serviceArn: "arn:aws:ecs:us-east-1:123456789012:service/my-cluster/my-web-service",
+ *     serviceContainerPortName: "web",
+ *     serviceUrl: "https://my-web-service.example.com",
+ *     status: "ACTIVE"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class DescribeGatewayRouteCommand extends DescribeGatewayRouteCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeGatewayRouteRequest;
+            output: DescribeGatewayRouteResponse;
+        };
+        sdk: {
+            input: DescribeGatewayRouteCommandInput;
+            output: DescribeGatewayRouteCommandOutput;
+        };
+    };
+}

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

@@ -1,6 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { DescribeServiceRevisionsRequest } from "../models/models_0";
-import type { DescribeServiceRevisionsResponse } from "../models/models_1";
+import type { DescribeServiceRevisionsRequest, DescribeServiceRevisionsResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -150,6 +149,11 @@ declare const DescribeServiceRevisionsCommand_base: {
  * //           format: "TEXT" || "JSON", // required
  * //           includeQueryParameters: "DISABLED" || "ENABLED",
  * //         },
+ * //         containerConfigurations: [ // ServiceConnectContainerConfigurations
+ * //           { // ServiceConnectContainerConfiguration Union: only one key present
+ * //             logLevel: "debug" || "info",
+ * //           },
+ * //         ],
  * //       },
  * //       volumeConfigurations: [ // ServiceVolumeConfigurations
  * //         { // ServiceVolumeConfiguration
@@ -314,12 +318,59 @@ declare const DescribeServiceRevisionsCommand_base: {
  * //             logGroupName: "STRING_VALUE", // required
  * //           },
  * //         ],
+ * //         gatewayConnections: [ // GatewayConnectionList
+ * //           { // GatewayConnection
+ * //             gatewayArn: "STRING_VALUE",
+ * //             gatewayRouteArn: "STRING_VALUE",
+ * //             portName: "STRING_VALUE",
+ * //             serviceUrl: "STRING_VALUE",
+ * //             accessType: "PUBLIC" || "PRIVATE",
+ * //             status: "ACTIVE" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
+ * //             resources: { // GatewayConnectionResources Union: only one key present
+ * //               hostSharedAlb: [ // GatewayConnectionAlbResourcesList
+ * //                 { // GatewayConnectionAlbResources
+ * //                   acmCertificateArn: "STRING_VALUE",
+ * //                   loadBalancerArn: "STRING_VALUE",
+ * //                   loadBalancerSecurityGroupArns: "<StringList>",
+ * //                   listenerArn: "STRING_VALUE",
+ * //                   listenerRuleArn: "STRING_VALUE",
+ * //                   testListenerRuleArn: "STRING_VALUE",
+ * //                   targetGroupArn: "STRING_VALUE",
+ * //                   alternateTargetGroupArn: "STRING_VALUE",
+ * //                 },
+ * //               ],
+ * //             },
+ * //           },
+ * //         ],
  * //       },
  * //       overrides: { // ServiceRevisionOverrides
  * //         runtimePlatform: { // RuntimePlatformOverride
  * //           cpuArchitecture: "STRING_VALUE",
  * //         },
  * //       },
+ * //       gatewayConnectors: [ // GatewayConnectorList
+ * //         { // GatewayConnector
+ * //           portName: "STRING_VALUE", // required
+ * //           healthCheck: { // GatewayConnectorHealthCheck
+ * //             healthCheckProtocol: "HTTP" || "HTTPS",
+ * //             healthCheckPort: Number("int"),
+ * //             healthCheckPath: "STRING_VALUE",
+ * //             healthCheckTimeoutSeconds: Number("int"),
+ * //             healthCheckIntervalSeconds: Number("int"),
+ * //             healthyThresholdCount: Number("int"),
+ * //             unhealthyThresholdCount: Number("int"),
+ * //             matcher: { // GatewayConnectorHealthCheckMatcher
+ * //               httpCode: "STRING_VALUE",
+ * //               grpcCode: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //           filters: { // GatewayConnectorFilters
+ * //             accessTypes: [ // AccessTypeList
+ * //               "PUBLIC" || "PRIVATE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       ],
  * //       monitoring: { // MonitoringConfiguration
  * //         metricConfigurations: [ // MetricConfigurationList
  * //           { // MetricConfiguration

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { DescribeServicesRequest, DescribeServicesResponse } from "../models/models_0";
+import type { DescribeServicesRequest, DescribeServicesResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -297,6 +297,11 @@ declare const DescribeServicesCommand_base: {
  * //               format: "TEXT" || "JSON", // required
  * //               includeQueryParameters: "DISABLED" || "ENABLED",
  * //             },
+ * //             containerConfigurations: [ // ServiceConnectContainerConfigurations
+ * //               { // ServiceConnectContainerConfiguration Union: only one key present
+ * //                 logLevel: "debug" || "info",
+ * //               },
+ * //             ],
  * //           },
  * //           serviceConnectResources: [ // ServiceConnectServiceResourceList
  * //             { // ServiceConnectServiceResource

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

@@ -0,0 +1,116 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DisassociateGatewayFromClusterRequest, DisassociateGatewayFromClusterResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link DisassociateGatewayFromClusterCommand}.
+ */
+export interface DisassociateGatewayFromClusterCommandInput extends DisassociateGatewayFromClusterRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DisassociateGatewayFromClusterCommand}.
+ */
+export interface DisassociateGatewayFromClusterCommandOutput extends DisassociateGatewayFromClusterResponse, __MetadataBearer {
+}
+declare const DisassociateGatewayFromClusterCommand_base: {
+    new (input: DisassociateGatewayFromClusterCommandInput): import("@smithy/core/client").CommandImpl<DisassociateGatewayFromClusterCommandInput, DisassociateGatewayFromClusterCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: DisassociateGatewayFromClusterCommandInput): import("@smithy/core/client").CommandImpl<DisassociateGatewayFromClusterCommandInput, DisassociateGatewayFromClusterCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Removes the association between a gateway and an Amazon ECS cluster. The association remains in the <code>DISASSOCIATING</code> state until you remove all of the gateway routes for the cluster by updating the associated services. You can use <code>ListGatewayRoutes</code> with a cluster filter to determine which routes are preventing disassociation. No infrastructure changes are made until the affected services are updated.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECSClient, DisassociateGatewayFromClusterCommand } from "@aws-sdk/client-ecs"; // ES Modules import
+ * // const { ECSClient, DisassociateGatewayFromClusterCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
+ * // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
+ * const config = {}; // type is ECSClientConfig
+ * const client = new ECSClient(config);
+ * const input = { // DisassociateGatewayFromClusterRequest
+ *   gateway: "STRING_VALUE", // required
+ *   cluster: "STRING_VALUE", // required
+ * };
+ * const command = new DisassociateGatewayFromClusterCommand(input);
+ * const response = await client.send(command);
+ * // { // DisassociateGatewayFromClusterResponse
+ * //   gatewayArn: "STRING_VALUE",
+ * //   clusterArn: "STRING_VALUE",
+ * //   status: "ACTIVE" || "DISASSOCIATING" || "INACTIVE",
+ * // };
+ *
+ * ```
+ *
+ * @param DisassociateGatewayFromClusterCommandInput - {@link DisassociateGatewayFromClusterCommandInput}
+ * @returns {@link DisassociateGatewayFromClusterCommandOutput}
+ * @see {@link DisassociateGatewayFromClusterCommandInput} for command's `input` shape.
+ * @see {@link DisassociateGatewayFromClusterCommandOutput} for command's `response` shape.
+ * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have authorization to perform the requested action.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *
+ * @throws {@link ClusterNotFoundException} (client fault)
+ *  <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
+ *
+ * @throws {@link GatewayNotFoundException} (client fault)
+ *  <p>The specified gateway wasn't found. Check that the gateway name or ARN is correct and that the gateway exists in your account and Region.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource wasn't found.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server issue.</p>
+ *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
+ *
+ *
+ * @example To disassociate a gateway from a cluster
+ * ```javascript
+ * // This example removes the association between the gateway named my-gateway and the cluster named my-cluster. The association remains in the DISASSOCIATING state until all gateway routes for the cluster are removed.
+ * const input = {
+ *   cluster: "my-cluster",
+ *   gateway: "my-gateway"
+ * };
+ * const command = new DisassociateGatewayFromClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster",
+ *   gatewayArn: "arn:aws:ecs:us-east-1:123456789012:gateway/my-gateway/a1b2c3d4e5f6478890abcdef12345678",
+ *   status: "DISASSOCIATING"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class DisassociateGatewayFromClusterCommand extends DisassociateGatewayFromClusterCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DisassociateGatewayFromClusterRequest;
+            output: DisassociateGatewayFromClusterResponse;
+        };
+        sdk: {
+            input: DisassociateGatewayFromClusterCommandInput;
+            output: DisassociateGatewayFromClusterCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,125 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListGatewayClusterAssociationsRequest, ListGatewayClusterAssociationsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListGatewayClusterAssociationsCommand}.
+ */
+export interface ListGatewayClusterAssociationsCommandInput extends ListGatewayClusterAssociationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListGatewayClusterAssociationsCommand}.
+ */
+export interface ListGatewayClusterAssociationsCommandOutput extends ListGatewayClusterAssociationsResponse, __MetadataBearer {
+}
+declare const ListGatewayClusterAssociationsCommand_base: {
+    new (input: ListGatewayClusterAssociationsCommandInput): import("@smithy/core/client").CommandImpl<ListGatewayClusterAssociationsCommandInput, ListGatewayClusterAssociationsCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (...[input]: [] | [ListGatewayClusterAssociationsCommandInput]): import("@smithy/core/client").CommandImpl<ListGatewayClusterAssociationsCommandInput, ListGatewayClusterAssociationsCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of the associations between gateways and clusters. You can filter the results by gateway, cluster, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECSClient, ListGatewayClusterAssociationsCommand } from "@aws-sdk/client-ecs"; // ES Modules import
+ * // const { ECSClient, ListGatewayClusterAssociationsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
+ * // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
+ * const config = {}; // type is ECSClientConfig
+ * const client = new ECSClient(config);
+ * const input = { // ListGatewayClusterAssociationsRequest
+ *   gateway: "STRING_VALUE",
+ *   cluster: "STRING_VALUE",
+ *   status: [ // GatewayClusterAssociationStatusList
+ *     "ACTIVE" || "DISASSOCIATING" || "INACTIVE",
+ *   ],
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListGatewayClusterAssociationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListGatewayClusterAssociationsResponse
+ * //   gatewayClusterAssociations: [ // GatewayClusterAssociationSummaryList
+ * //     { // GatewayClusterAssociationSummary
+ * //       gatewayArn: "STRING_VALUE",
+ * //       clusterArn: "STRING_VALUE",
+ * //       status: "ACTIVE" || "DISASSOCIATING" || "INACTIVE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListGatewayClusterAssociationsCommandInput - {@link ListGatewayClusterAssociationsCommandInput}
+ * @returns {@link ListGatewayClusterAssociationsCommandOutput}
+ * @see {@link ListGatewayClusterAssociationsCommandInput} for command's `input` shape.
+ * @see {@link ListGatewayClusterAssociationsCommandOutput} for command's `response` shape.
+ * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have authorization to perform the requested action.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server issue.</p>
+ *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
+ *
+ *
+ * @example To list the clusters associated with a gateway
+ * ```javascript
+ * // This example lists the clusters that are associated with the gateway named my-gateway.
+ * const input = {
+ *   gateway: "my-gateway"
+ * };
+ * const command = new ListGatewayClusterAssociationsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   gatewayClusterAssociations: [
+ *     {
+ *       clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster",
+ *       gatewayArn: "arn:aws:ecs:us-east-1:123456789012:gateway/my-gateway/a1b2c3d4e5f6478890abcdef12345678",
+ *       status: "ACTIVE"
+ *     },
+ *     {
+ *       clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/my-staging-cluster",
+ *       gatewayArn: "arn:aws:ecs:us-east-1:123456789012:gateway/my-gateway/a1b2c3d4e5f6478890abcdef12345678",
+ *       status: "ACTIVE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListGatewayClusterAssociationsCommand extends ListGatewayClusterAssociationsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListGatewayClusterAssociationsRequest;
+            output: ListGatewayClusterAssociationsResponse;
+        };
+        sdk: {
+            input: ListGatewayClusterAssociationsCommandInput;
+            output: ListGatewayClusterAssociationsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,132 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListGatewayRoutesRequest, ListGatewayRoutesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListGatewayRoutesCommand}.
+ */
+export interface ListGatewayRoutesCommandInput extends ListGatewayRoutesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListGatewayRoutesCommand}.
+ */
+export interface ListGatewayRoutesCommandOutput extends ListGatewayRoutesResponse, __MetadataBearer {
+}
+declare const ListGatewayRoutesCommand_base: {
+    new (input: ListGatewayRoutesCommandInput): import("@smithy/core/client").CommandImpl<ListGatewayRoutesCommandInput, ListGatewayRoutesCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (...[input]: [] | [ListGatewayRoutesCommandInput]): import("@smithy/core/client").CommandImpl<ListGatewayRoutesCommandInput, ListGatewayRoutesCommandOutput, import("..").ECSClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of gateway routes. A gateway route represents the association between a service and a gateway and the service-specific infrastructure the gateway manages for it. You can filter the results by gateway, cluster, service, container port name, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECSClient, ListGatewayRoutesCommand } from "@aws-sdk/client-ecs"; // ES Modules import
+ * // const { ECSClient, ListGatewayRoutesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
+ * // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
+ * const config = {}; // type is ECSClientConfig
+ * const client = new ECSClient(config);
+ * const input = { // ListGatewayRoutesRequest
+ *   gateway: "STRING_VALUE",
+ *   cluster: "STRING_VALUE",
+ *   service: "STRING_VALUE",
+ *   serviceContainerPortName: "STRING_VALUE",
+ *   status: [ // GatewayRouteStatusList
+ *     "ACTIVE" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
+ *   ],
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListGatewayRoutesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListGatewayRoutesResponse
+ * //   gatewayRoutes: [ // GatewayRouteSummaryList
+ * //     { // GatewayRouteSummary
+ * //       gatewayRouteArn: "STRING_VALUE",
+ * //       gatewayArn: "STRING_VALUE",
+ * //       clusterArn: "STRING_VALUE",
+ * //       serviceArn: "STRING_VALUE",
+ * //       serviceContainerPortName: "STRING_VALUE",
+ * //       status: "ACTIVE" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListGatewayRoutesCommandInput - {@link ListGatewayRoutesCommandInput}
+ * @returns {@link ListGatewayRoutesCommandOutput}
+ * @see {@link ListGatewayRoutesCommandInput} for command's `input` shape.
+ * @see {@link ListGatewayRoutesCommandOutput} for command's `response` shape.
+ * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have authorization to perform the requested action.</p>
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
+ *
+ * @throws {@link GatewayNotFoundException} (client fault)
+ *  <p>The specified gateway wasn't found. Check that the gateway name or ARN is correct and that the gateway exists in your account and Region.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server issue.</p>
+ *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
+ *
+ *
+ * @example To list the gateway routes for a gateway
+ * ```javascript
+ * // This example lists the gateway routes for the gateway named my-gateway in the cluster named my-cluster.
+ * const input = {
+ *   cluster: "my-cluster",
+ *   gateway: "my-gateway"
+ * };
+ * const command = new ListGatewayRoutesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   gatewayRoutes: [
+ *     {
+ *       clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster",
+ *       gatewayArn: "arn:aws:ecs:us-east-1:123456789012:gateway/my-gateway/a1b2c3d4e5f6478890abcdef12345678",
+ *       gatewayRouteArn: "arn:aws:ecs:us-east-1:123456789012:gateway-route/my-gateway/a1b2c3d4e5f6478890abcdef12345678/f0e1d2c3b4a5968778695a4b3c2d1e0f",
+ *       serviceArn: "arn:aws:ecs:us-east-1:123456789012:service/my-cluster/my-web-service",
+ *       serviceContainerPortName: "web",
+ *       status: "ACTIVE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListGatewayRoutesCommand extends ListGatewayRoutesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListGatewayRoutesRequest;
+            output: ListGatewayRoutesResponse;
+        };
+        sdk: {
+            input: ListGatewayRoutesCommandInput;
+            output: ListGatewayRoutesCommandOutput;
+        };
+    };
+}