@aws-sdk/client-apigatewayv2 3.821.0 → 3.823.0

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

@@ -8,6 +8,7 @@ export * from "./CreateIntegrationResponseCommand";
 export * from "./CreateModelCommand";
 export * from "./CreateRouteCommand";
 export * from "./CreateRouteResponseCommand";
+export * from "./CreateRoutingRuleCommand";
 export * from "./CreateStageCommand";
 export * from "./CreateVpcLinkCommand";
 export * from "./DeleteAccessLogSettingsCommand";
@@ -24,6 +25,7 @@ export * from "./DeleteRouteCommand";
 export * from "./DeleteRouteRequestParameterCommand";
 export * from "./DeleteRouteResponseCommand";
 export * from "./DeleteRouteSettingsCommand";
+export * from "./DeleteRoutingRuleCommand";
 export * from "./DeleteStageCommand";
 export * from "./DeleteVpcLinkCommand";
 export * from "./ExportApiCommand";
@@ -48,12 +50,15 @@ export * from "./GetRouteCommand";
 export * from "./GetRouteResponseCommand";
 export * from "./GetRouteResponsesCommand";
 export * from "./GetRoutesCommand";
+export * from "./GetRoutingRuleCommand";
 export * from "./GetStageCommand";
 export * from "./GetStagesCommand";
 export * from "./GetTagsCommand";
 export * from "./GetVpcLinkCommand";
 export * from "./GetVpcLinksCommand";
 export * from "./ImportApiCommand";
+export * from "./ListRoutingRulesCommand";
+export * from "./PutRoutingRuleCommand";
 export * from "./ReimportApiCommand";
 export * from "./ResetAuthorizersCacheCommand";
 export * from "./TagResourceCommand";

package/dist-types/index.d.ts

@@ -9,5 +9,6 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export type { RuntimeExtension } from "./runtimeExtensions";
 export type { ApiGatewayV2ExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
+export * from "./pagination";
 export * from "./models";
 export { ApiGatewayV2ServiceException } from "./models/ApiGatewayV2ServiceException";

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

@@ -436,6 +436,19 @@ export interface MutualTlsAuthentication {
      */
     TruststoreWarnings?: string[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const RoutingMode: {
+    readonly API_MAPPING_ONLY: "API_MAPPING_ONLY";
+    readonly ROUTING_RULE_ONLY: "ROUTING_RULE_ONLY";
+    readonly ROUTING_RULE_THEN_API_MAPPING: "ROUTING_RULE_THEN_API_MAPPING";
+};
+/**
+ * @public
+ */
+export type RoutingMode = (typeof RoutingMode)[keyof typeof RoutingMode];
 /**
  * <p>Represents a domain name.</p>
  * @public
@@ -451,6 +464,11 @@ export interface DomainName {
      * @public
      */
     DomainName: string | undefined;
+    /**
+     * <p>Represents an Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    DomainNameArn?: string | undefined;
     /**
      * <p>The domain name configurations.</p>
      * @public
@@ -461,6 +479,11 @@ export interface DomainName {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
     /**
      * <p>The collection of tags associated with a domain name.</p>
      * @public
@@ -835,6 +858,123 @@ export interface RouteResponse {
      */
     RouteResponseKey: string | undefined;
 }
+/**
+ * <p>Represents an InvokeApi action.</p>
+ * @public
+ */
+export interface RoutingRuleActionInvokeApi {
+    /**
+     * <p>The identifier.</p>
+     * @public
+     */
+    ApiId: string | undefined;
+    /**
+     * <p>A string with a length between [1-128].</p>
+     * @public
+     */
+    Stage: string | undefined;
+    /**
+     * <p>The strip base path setting.</p>
+     * @public
+     */
+    StripBasePath?: boolean | undefined;
+}
+/**
+ * <p>The routing rule action.</p>
+ * @public
+ */
+export interface RoutingRuleAction {
+    /**
+     * <p>Represents an InvokeApi action.</p>
+     * @public
+     */
+    InvokeApi: RoutingRuleActionInvokeApi | undefined;
+}
+/**
+ * <p>Represents a MatchBasePaths condition.</p>
+ * @public
+ */
+export interface RoutingRuleMatchBasePaths {
+    /**
+     * The string of the case sensitive base path to be matched.
+     * @public
+     */
+    AnyOf: string[] | undefined;
+}
+/**
+ * <p>Represents a MatchHeaderValue.</p>
+ * @public
+ */
+export interface RoutingRuleMatchHeaderValue {
+    /**
+     * <p>After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.</p>
+     * @public
+     */
+    Header: string | undefined;
+    /**
+     * <p>An expression used to extract information at runtime. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for more information.</p>
+     * @public
+     */
+    ValueGlob: string | undefined;
+}
+/**
+ * <p>Represents a MatchHeaders condition.</p>
+ * @public
+ */
+export interface RoutingRuleMatchHeaders {
+    /**
+     * <p>The header name and header value glob to be matched. The matchHeaders condition is matched if any of the header name and header value globs are matched.</p>
+     * @public
+     */
+    AnyOf: RoutingRuleMatchHeaderValue[] | undefined;
+}
+/**
+ * <p>Represents a routing rule condition.</p>
+ * @public
+ */
+export interface RoutingRuleCondition {
+    /**
+     * <p>The base path to be matched.</p>
+     * @public
+     */
+    MatchBasePaths?: RoutingRuleMatchBasePaths | undefined;
+    /**
+     * <p>The headers to be matched.</p>
+     * @public
+     */
+    MatchHeaders?: RoutingRuleMatchHeaders | undefined;
+}
+/**
+ * <p>Represents a routing rule.</p>
+ * @public
+ */
+export interface RoutingRule {
+    /**
+     * <p>The routing rule action.</p>
+     * @public
+     */
+    Actions?: RoutingRuleAction[] | undefined;
+    /**
+     * <p>The routing rule condition.</p>
+     * @public
+     */
+    Conditions?: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>The routing rule priority.</p>
+     * @public
+     */
+    Priority?: number | undefined;
+    /**
+     * <p>The routing rule ARN.</p>
+     * @public
+     */
+    RoutingRuleArn?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId?: string | undefined;
+}
 /**
  * <p>Settings for logging access in a stage.</p>
  * @public
@@ -1569,6 +1709,11 @@ export interface CreateDomainNameRequest {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthenticationInput | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
     /**
      * <p>The collection of tags associated with a domain name.</p>
      * @public
@@ -1589,6 +1734,11 @@ export interface CreateDomainNameResponse {
      * @public
      */
     DomainName?: string | undefined;
+    /**
+     * <p>Represents an Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    DomainNameArn?: string | undefined;
     /**
      * <p>The domain name configurations.</p>
      * @public
@@ -1599,6 +1749,11 @@ export interface CreateDomainNameResponse {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
     /**
      * <p>The collection of tags associated with a domain name.</p>
      * @public
@@ -2166,6 +2321,66 @@ export interface CreateRouteResponseResponse {
      */
     RouteResponseKey?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateRoutingRuleRequest {
+    /**
+     * <p>Represents a routing rule action. The only supported action is invokeApi.</p>
+     * @public
+     */
+    Actions: RoutingRuleAction[] | undefined;
+    /**
+     * <p>Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.</p>
+     * @public
+     */
+    Conditions: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>The domain name.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The domain name ID.</p>
+     * @public
+     */
+    DomainNameId?: string | undefined;
+    /**
+     * Represents the priority of the routing rule.
+     * @public
+     */
+    Priority: number | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateRoutingRuleResponse {
+    /**
+     * <p>Represents a routing rule action. The only supported action is invokeApi.</p>
+     * @public
+     */
+    Actions?: RoutingRuleAction[] | undefined;
+    /**
+     * <p>Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.</p>
+     * @public
+     */
+    Conditions?: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>Represents the priority of the routing rule.<p>
+     * @public
+     */
+    Priority?: number | undefined;
+    /**
+     * <p>The ARN of the domain name.<p>
+     * @public
+     */
+    RoutingRuleArn?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId?: string | undefined;
+}
 /**
  * <p>Creates a new Stage resource to represent a stage.</p>
  * @public
@@ -2593,6 +2808,26 @@ export interface DeleteRouteSettingsRequest {
      */
     StageName: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteRoutingRuleRequest {
+    /**
+     * <p>The domain name.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The domain name ID.</p>
+     * @public
+     */
+    DomainNameId?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId: string | undefined;
+}
 /**
  * @public
  */
@@ -3093,6 +3328,11 @@ export interface GetDomainNameResponse {
      * @public
      */
     DomainName?: string | undefined;
+    /**
+     * <p>Represents an Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    DomainNameArn?: string | undefined;
     /**
      * <p>The domain name configurations.</p>
      * @public
@@ -3103,6 +3343,11 @@ export interface GetDomainNameResponse {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
     /**
      * <p>The collection of tags associated with a domain name.</p>
      * @public
@@ -3709,6 +3954,56 @@ export interface GetRoutesResponse {
      */
     NextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetRoutingRuleRequest {
+    /**
+     * <p>The domain name.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The domain name ID.</p>
+     * @public
+     */
+    DomainNameId?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetRoutingRuleResponse {
+    /**
+     * <p>The resulting action based on matching a routing rules condition. Only InvokeApi is supported.</p>
+     * @public
+     */
+    Actions?: RoutingRuleAction[] | undefined;
+    /**
+     * <p>The conditions of the routing rule.</p>
+     * @public
+     */
+    Conditions?: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value.</p>
+     * @public
+     */
+    Priority?: number | undefined;
+    /**
+     * <p>The routing rule ARN.</p>
+     * @public
+     */
+    RoutingRuleArn?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId?: string | undefined;
+}
 /**
  * @public
  */
@@ -4055,6 +4350,111 @@ export interface ImportApiResponse {
      */
     Warnings?: string[] | undefined;
 }
+/**
+ * @public
+ */
+export interface ListRoutingRulesRequest {
+    /**
+     * <p>The domain name.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The domain name ID.</p>
+     * @public
+     */
+    DomainNameId?: string | undefined;
+    /**
+     * <p>The maximum number of elements to be returned for this resource.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRoutingRulesResponse {
+    /**
+     * <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The routing rules.<p>
+     * @public
+     */
+    RoutingRules?: RoutingRule[] | undefined;
+}
+/**
+ * @public
+ */
+export interface PutRoutingRuleRequest {
+    /**
+     * <p>The routing rule action.</p>
+     * @public
+     */
+    Actions: RoutingRuleAction[] | undefined;
+    /**
+     * <p>The routing rule condition.</p>
+     * @public
+     */
+    Conditions: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>The domain name.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The domain name ID.</p>
+     * @public
+     */
+    DomainNameId?: string | undefined;
+    /**
+     * <p>The routing rule priority.</p>
+     * @public
+     */
+    Priority: number | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PutRoutingRuleResponse {
+    /**
+     * <p>The routing rule action.</p>
+     * @public
+     */
+    Actions?: RoutingRuleAction[] | undefined;
+    /**
+     * <p>The conditions of the routing rule.</p>
+     * @public
+     */
+    Conditions?: RoutingRuleCondition[] | undefined;
+    /**
+     * <p>The routing rule priority.</p>
+     * @public
+     */
+    Priority?: number | undefined;
+    /**
+     * <p>The routing rule ARN.</p>
+     * @public
+     */
+    RoutingRuleArn?: string | undefined;
+    /**
+     * <p>The routing rule ID.</p>
+     * @public
+     */
+    RoutingRuleId?: string | undefined;
+}
 /**
  * <p></p>
  * @public
@@ -4643,6 +5043,11 @@ export interface UpdateDomainNameRequest {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthenticationInput | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
 }
 /**
  * @public
@@ -4658,6 +5063,11 @@ export interface UpdateDomainNameResponse {
      * @public
      */
     DomainName?: string | undefined;
+    /**
+     * <p>Represents an Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    DomainNameArn?: string | undefined;
     /**
      * <p>The domain name configurations.</p>
      * @public
@@ -4668,6 +5078,11 @@ export interface UpdateDomainNameResponse {
      * @public
      */
     MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
+    /**
+     * <p>The routing mode.</p>
+     * @public
+     */
+    RoutingMode?: RoutingMode | undefined;
     /**
      * <p>The collection of tags associated with a domain name.</p>
      * @public

package/dist-types/pagination/Interfaces.d.ts

@@ -0,0 +1,8 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { ApiGatewayV2Client } from "../ApiGatewayV2Client";
+/**
+ * @public
+ */
+export interface ApiGatewayV2PaginationConfiguration extends PaginationConfiguration {
+    client: ApiGatewayV2Client;
+}

package/dist-types/pagination/ListRoutingRulesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListRoutingRulesCommandInput, ListRoutingRulesCommandOutput } from "../commands/ListRoutingRulesCommand";
+import { ApiGatewayV2PaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListRoutingRules: (config: ApiGatewayV2PaginationConfiguration, input: ListRoutingRulesCommandInput, ...rest: any[]) => Paginator<ListRoutingRulesCommandOutput>;

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

@@ -0,0 +1,2 @@
+export * from "./Interfaces";
+export * from "./ListRoutingRulesPaginator";