@aws-sdk/client-api-gateway 3.296.0 → 3.297.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { APIGatewayServiceException as __BaseException } from "./APIGatewayServiceException";
 /**
+ * @public
  * <p>Access log settings, including the access log format and access log destination ARN.</p>
  */
 export interface AccessLogSettings {
@@ -14,6 +15,7 @@ export interface AccessLogSettings {
     destinationArn?: string;
 }
 /**
+ * @public
  * <p> The API request rate limits.</p>
  */
 export interface ThrottleSettings {
@@ -27,6 +29,7 @@ export interface ThrottleSettings {
     rateLimit?: number;
 }
 /**
+ * @public
  * <p>Represents an AWS account that is associated with API Gateway.</p>
  */
 export interface Account {
@@ -48,6 +51,7 @@ export interface Account {
     apiKeyVersion?: string;
 }
 /**
+ * @public
  * <p>A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.</p>
  */
 export interface ApiKey {
@@ -93,6 +97,7 @@ export interface ApiKey {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The identifier of an ApiKey used in a UsagePlan.</p>
  */
 export interface ApiKeyIds {
@@ -106,6 +111,7 @@ export interface ApiKeyIds {
     warnings?: string[];
 }
 /**
+ * @public
  * <p>Represents a collection of API keys as represented by an ApiKeys resource.</p>
  */
 export interface ApiKeys {
@@ -122,14 +128,21 @@ export interface ApiKeys {
      */
     position?: string;
 }
+/**
+ * @public
+ */
 export declare enum ApiKeysFormat {
     csv = "csv"
 }
+/**
+ * @public
+ */
 export declare enum ApiKeySourceType {
     AUTHORIZER = "AUTHORIZER",
     HEADER = "HEADER"
 }
 /**
+ * @public
  * <p>API stage name of the associated API stage in a usage plan.</p>
  */
 export interface ApiStage {
@@ -146,12 +159,16 @@ export interface ApiStage {
      */
     throttle?: Record<string, ThrottleSettings>;
 }
+/**
+ * @public
+ */
 export declare enum AuthorizerType {
     COGNITO_USER_POOLS = "COGNITO_USER_POOLS",
     REQUEST = "REQUEST",
     TOKEN = "TOKEN"
 }
 /**
+ * @public
  * <p>Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.</p>
  */
 export interface Authorizer {
@@ -168,7 +185,7 @@ export interface Authorizer {
      */
     type?: AuthorizerType | string;
     /**
-     * <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
+     * <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
      */
     providerARNs?: string[];
     /**
@@ -176,7 +193,7 @@ export interface Authorizer {
      */
     authType?: string;
     /**
-     * <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form  <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
+     * <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:\{account_id\}:function:\{lambda_function_name\}/invocations</code>. In general, the URI has this form  <code>arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}</code>, where <code>\{region\}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
      */
     authorizerUri?: string;
     /**
@@ -211,6 +228,7 @@ export interface Authorizer {
     authorizerResultTtlInSeconds?: number;
 }
 /**
+ * @public
  * <p>Represents a collection of Authorizer resources.</p>
  */
 export interface Authorizers {
@@ -224,6 +242,7 @@ export interface Authorizers {
     position?: string;
 }
 /**
+ * @public
  * <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -235,6 +254,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -246,7 +266,8 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
- * <p>A reference to a unique stage identified in the format <code>{restApiId}/{stage}</code>.</p>
+ * @public
+ * <p>A reference to a unique stage identified in the format <code>\{restApiId\}/\{stage\}</code>.</p>
  */
 export interface StageKey {
     /**
@@ -259,6 +280,7 @@ export interface StageKey {
     stageName?: string;
 }
 /**
+ * @public
  * <p>Request to create an ApiKey resource.</p>
  */
 export interface CreateApiKeyRequest {
@@ -296,6 +318,7 @@ export interface CreateApiKeyRequest {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The request exceeded the rate limit. Retry after the specified time period.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -308,6 +331,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested resource is not found. Make sure that the request URI is correct.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -319,6 +343,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request has reached its throttling limit. Retry after the specified time period.</p>
  */
 export declare class TooManyRequestsException extends __BaseException {
@@ -331,6 +356,7 @@ export declare class TooManyRequestsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request is denied because the caller has insufficient permissions.</p>
  */
 export declare class UnauthorizedException extends __BaseException {
@@ -342,6 +368,7 @@ export declare class UnauthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
 /**
+ * @public
  * <p>Request to add a new Authorizer to an existing RestApi resource.</p>
  */
 export interface CreateAuthorizerRequest {
@@ -358,7 +385,7 @@ export interface CreateAuthorizerRequest {
      */
     type: AuthorizerType | string | undefined;
     /**
-     * <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
+     * <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
      */
     providerARNs?: string[];
     /**
@@ -366,7 +393,7 @@ export interface CreateAuthorizerRequest {
      */
     authType?: string;
     /**
-     * <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form  <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
+     * <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:\{account_id\}:function:\{lambda_function_name\}/invocations</code>. In general, the URI has this form  <code>arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}</code>, where <code>\{region\}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
      */
     authorizerUri?: string;
     /**
@@ -403,6 +430,7 @@ export interface CreateAuthorizerRequest {
     authorizerResultTtlInSeconds?: number;
 }
 /**
+ * @public
  * <p>Represents the base path that callers of the API must provide as part of the URL after the domain name.</p>
  */
 export interface BasePathMapping {
@@ -420,6 +448,7 @@ export interface BasePathMapping {
     stage?: string;
 }
 /**
+ * @public
  * <p>Requests API Gateway to create a new BasePathMapping resource.</p>
  */
 export interface CreateBasePathMappingRequest {
@@ -440,6 +469,9 @@ export interface CreateBasePathMappingRequest {
      */
     stage?: string;
 }
+/**
+ * @public
+ */
 export declare enum CacheClusterSize {
     SIZE_0_POINT_5_GB = "0.5",
     SIZE_118_GB = "118",
@@ -451,6 +483,7 @@ export declare enum CacheClusterSize {
     SIZE_6_POINT_1_GB = "6.1"
 }
 /**
+ * @public
  * <p>The input configuration for a canary deployment.</p>
  */
 export interface DeploymentCanarySettings {
@@ -468,6 +501,7 @@ export interface DeploymentCanarySettings {
     useStageCache?: boolean;
 }
 /**
+ * @public
  * <p>Requests API Gateway to create a Deployment resource.</p>
  */
 export interface CreateDeploymentRequest {
@@ -511,6 +545,7 @@ export interface CreateDeploymentRequest {
     tracingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>Represents a summary of a Method resource, given a particular date and time.</p>
  */
 export interface MethodSnapshot {
@@ -524,6 +559,7 @@ export interface MethodSnapshot {
     apiKeyRequired?: boolean;
 }
 /**
+ * @public
  * <p>An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.</p>
  */
 export interface Deployment {
@@ -545,6 +581,7 @@ export interface Deployment {
     apiSummary?: Record<string, Record<string, MethodSnapshot>>;
 }
 /**
+ * @public
  * <p>The requested service is not available. For details see the accompanying error message. Retry after the specified time period.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -556,6 +593,9 @@ export declare class ServiceUnavailableException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum DocumentationPartType {
     API = "API",
     AUTHORIZER = "AUTHORIZER",
@@ -571,6 +611,7 @@ export declare enum DocumentationPartType {
     RESPONSE_HEADER = "RESPONSE_HEADER"
 }
 /**
+ * @public
  * <p>Specifies the target API entity to which the documentation applies.</p>
  */
 export interface DocumentationPartLocation {
@@ -596,6 +637,7 @@ export interface DocumentationPartLocation {
     name?: string;
 }
 /**
+ * @public
  * <p>Creates a new documentation part of a given API.</p>
  */
 export interface CreateDocumentationPartRequest {
@@ -613,6 +655,7 @@ export interface CreateDocumentationPartRequest {
     properties: string | undefined;
 }
 /**
+ * @public
  * <p>A documentation part for a targeted API entity.</p>
  */
 export interface DocumentationPart {
@@ -625,11 +668,12 @@ export interface DocumentationPart {
      */
     location?: DocumentationPartLocation;
     /**
-     * <p>A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., <code>"{ \"description\": \"The API does ...\" }"</code>.  Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of <code>x-amazon-apigateway-documentation</code>.</p>
+     * <p>A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., <code>"\{ \"description\": \"The API does ...\" \}"</code>.  Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of <code>x-amazon-apigateway-documentation</code>.</p>
      */
     properties?: string;
 }
 /**
+ * @public
  * <p>Creates a new documentation version of a given API.</p>
  */
 export interface CreateDocumentationVersionRequest {
@@ -651,6 +695,7 @@ export interface CreateDocumentationVersionRequest {
     description?: string;
 }
 /**
+ * @public
  * <p>A snapshot of the documentation of an API.</p>
  */
 export interface DocumentationVersion {
@@ -667,12 +712,16 @@ export interface DocumentationVersion {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export declare enum EndpointType {
     EDGE = "EDGE",
     PRIVATE = "PRIVATE",
     REGIONAL = "REGIONAL"
 }
 /**
+ * @public
  * <p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. </p>
  */
 export interface EndpointConfiguration {
@@ -686,6 +735,7 @@ export interface EndpointConfiguration {
     vpcEndpointIds?: string[];
 }
 /**
+ * @public
  * <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
  *       performs two-way authentication between the client and the server. Clients must present a
  *       trusted certificate to access your API.</p>
@@ -704,11 +754,15 @@ export interface MutualTlsAuthenticationInput {
      */
     truststoreVersion?: string;
 }
+/**
+ * @public
+ */
 export declare enum SecurityPolicy {
     TLS_1_0 = "TLS_1_0",
     TLS_1_2 = "TLS_1_2"
 }
 /**
+ * @public
  * <p>A request to create a new domain name.</p>
  */
 export interface CreateDomainNameRequest {
@@ -769,6 +823,9 @@ export interface CreateDomainNameRequest {
      */
     ownershipVerificationCertificateArn?: string;
 }
+/**
+ * @public
+ */
 export declare enum DomainNameStatus {
     AVAILABLE = "AVAILABLE",
     PENDING = "PENDING",
@@ -777,6 +834,7 @@ export declare enum DomainNameStatus {
     UPDATING = "UPDATING"
 }
 /**
+ * @public
  * <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
  *       performs two-way authentication between the client and the server. Clients must present a
  *       trusted certificate to access your API.</p>
@@ -803,6 +861,7 @@ export interface MutualTlsAuthentication {
     truststoreWarnings?: string[];
 }
 /**
+ * @public
  * <p>Represents a custom domain name as a user-friendly host name of an API (RestApi).</p>
  */
 export interface DomainName {
@@ -880,6 +939,7 @@ export interface DomainName {
     ownershipVerificationCertificateArn?: string;
 }
 /**
+ * @public
  * <p>Request to add a new Model to an existing RestApi resource.</p>
  */
 export interface CreateModelRequest {
@@ -905,6 +965,7 @@ export interface CreateModelRequest {
     contentType: string | undefined;
 }
 /**
+ * @public
  * <p>Represents the data structure of a method's request or response payload.</p>
  */
 export interface Model {
@@ -930,6 +991,7 @@ export interface Model {
     contentType?: string;
 }
 /**
+ * @public
  * <p>Creates a RequestValidator of a given RestApi.</p>
  */
 export interface CreateRequestValidatorRequest {
@@ -951,6 +1013,7 @@ export interface CreateRequestValidatorRequest {
     validateRequestParameters?: boolean;
 }
 /**
+ * @public
  * <p>A set of validation rules for incoming Method requests.</p>
  */
 export interface RequestValidator {
@@ -972,6 +1035,7 @@ export interface RequestValidator {
     validateRequestParameters?: boolean;
 }
 /**
+ * @public
  * <p>Requests API Gateway to create a Resource resource.</p>
  */
 export interface CreateResourceRequest {
@@ -988,15 +1052,22 @@ export interface CreateResourceRequest {
      */
     pathPart: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ConnectionType {
     INTERNET = "INTERNET",
     VPC_LINK = "VPC_LINK"
 }
+/**
+ * @public
+ */
 export declare enum ContentHandlingStrategy {
     CONVERT_TO_BINARY = "CONVERT_TO_BINARY",
     CONVERT_TO_TEXT = "CONVERT_TO_TEXT"
 }
 /**
+ * @public
  * <p>Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.</p>
  */
 export interface IntegrationResponse {
@@ -1010,7 +1081,7 @@ export interface IntegrationResponse {
     selectionPattern?: string;
     /**
      * <p>A key-value map specifying response parameters that are passed to the method response from the back end.
-     *             The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> is a valid and unique response header name and <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.</p>
+     *             The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.\{name\}</code> or <code>integration.response.body.\{JSON-expression\}</code>, where <code>name</code> is a valid and unique response header name and <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.</p>
      */
     responseParameters?: Record<string, string>;
     /**
@@ -1024,6 +1095,7 @@ export interface IntegrationResponse {
     contentHandling?: ContentHandlingStrategy | string;
 }
 /**
+ * @public
  * <p>Specifies the TLS configuration for an integration.</p>
  */
 export interface TlsConfig {
@@ -1042,6 +1114,9 @@ export interface TlsConfig {
      */
     insecureSkipVerification?: boolean;
 }
+/**
+ * @public
+ */
 export declare enum IntegrationType {
     AWS = "AWS",
     AWS_PROXY = "AWS_PROXY",
@@ -1050,6 +1125,7 @@ export declare enum IntegrationType {
     MOCK = "MOCK"
 }
 /**
+ * @public
  * <p>Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.</p>
  */
 export interface Integration {
@@ -1068,17 +1144,17 @@ export interface Integration {
      *       according to the RFC-3986 specification, for either standard integration, where <code>connectionType</code>
      *       is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP
      *       integration, the URI is not used for routing. For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of
-     *       the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>.
-     *       Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the
-     *       integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by
+     *       the form <code>arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}</code>.
+     *       Here, \{Region\} is the API Gateway region (e.g., us-east-1); \{service\} is the name of the
+     *       integrated Amazon Web Services service (e.g., s3); and \{subdomain\} is a designated subdomain supported by
      *       certain Amazon Web Services  service for fast host-name lookup. action can be used for an Amazon Web Services  service
-     *       action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing
-     *       {service_api} refers to a supported action {name} plus any required input parameters.
+     *       action-based API, using an Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}... query string. The ensuing
+     *       \{service_api\} refers to a supported action \{name\} plus any required input parameters.
      *       Alternatively, path can be used for an AWS service path-based API. The ensuing service_api
      *       refers to the path to an Amazon Web Services  service resource, including the region of the integrated Amazon Web Services
      *       service, if applicable. For example, for integration with the S3 API of GetObject, the uri can
-     *       be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or
-     *       <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code>
+     *       be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}</code> or
+     *       <code>arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}</code>
      *          </p>
      */
     uri?: string;
@@ -1095,7 +1171,7 @@ export interface Integration {
      */
     credentials?: string;
     /**
-     * <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of  <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
+     * <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of  <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
      */
     requestParameters?: Record<string, string>;
     /**
@@ -1147,6 +1223,7 @@ export interface Integration {
     tlsConfig?: TlsConfig;
 }
 /**
+ * @public
  * <p>Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. </p>
  */
 export interface MethodResponse {
@@ -1155,7 +1232,7 @@ export interface MethodResponse {
      */
     statusCode?: string;
     /**
-     * <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
+     * <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in <code>integration.response.header.\{name\}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.\{JSON-expression\}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
      */
     responseParameters?: Record<string, boolean>;
     /**
@@ -1164,6 +1241,7 @@ export interface MethodResponse {
     responseModels?: Record<string, string>;
 }
 /**
+ * @public
  * <p>
  *             Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is
  *             integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes
@@ -1199,7 +1277,7 @@ export interface Method {
      */
     operationName?: string;
     /**
-     * <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of  <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>).  The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.</p>
+     * <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of  <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>).  The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.</p>
      */
     requestParameters?: Record<string, boolean>;
     /**
@@ -1220,6 +1298,7 @@ export interface Method {
     authorizationScopes?: string[];
 }
 /**
+ * @public
  * <p>Represents an API resource.</p>
  */
 export interface Resource {
@@ -1245,6 +1324,7 @@ export interface Resource {
     resourceMethods?: Record<string, Method>;
 }
 /**
+ * @public
  * <p>The POST Request to add a new RestApi resource to your collection.</p>
  */
 export interface CreateRestApiRequest {
@@ -1294,12 +1374,13 @@ export interface CreateRestApiRequest {
     /**
      * <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
      *       By default, clients can invoke your API with the default
-     *       <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a
+     *       <code>https://\{api_id\}.execute-api.\{region\}.amazonaws.com</code> endpoint. To require that clients use a
      *       custom domain name to invoke your API, disable the default endpoint</p>
      */
     disableExecuteApiEndpoint?: boolean;
 }
 /**
+ * @public
  * <p>Represents a REST API.</p>
  */
 export interface RestApi {
@@ -1357,12 +1438,13 @@ export interface RestApi {
     /**
      * <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
      *       By default, clients can invoke your API with the default
-     *       <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a
+     *       <code>https://\{api_id\}.execute-api.\{region\}.amazonaws.com</code> endpoint. To require that clients use a
      *       custom domain name to invoke your API, disable the default endpoint.</p>
      */
     disableExecuteApiEndpoint?: boolean;
 }
 /**
+ * @public
  * <p>Configuration settings of a canary deployment.</p>
  */
 export interface CanarySettings {
@@ -1384,6 +1466,7 @@ export interface CanarySettings {
     useStageCache?: boolean;
 }
 /**
+ * @public
  * <p>Requests API Gateway to create a Stage resource.</p>
  */
 export interface CreateStageRequest {
@@ -1434,6 +1517,9 @@ export interface CreateStageRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum CacheClusterStatus {
     AVAILABLE = "AVAILABLE",
     CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
@@ -1441,57 +1527,62 @@ export declare enum CacheClusterStatus {
     FLUSH_IN_PROGRESS = "FLUSH_IN_PROGRESS",
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
+/**
+ * @public
+ */
 export declare enum UnauthorizedCacheControlHeaderStrategy {
     FAIL_WITH_403 = "FAIL_WITH_403",
     SUCCEED_WITHOUT_RESPONSE_HEADER = "SUCCEED_WITHOUT_RESPONSE_HEADER",
     SUCCEED_WITH_RESPONSE_HEADER = "SUCCEED_WITH_RESPONSE_HEADER"
 }
 /**
+ * @public
  * <p>Specifies the method setting properties.</p>
  */
 export interface MethodSetting {
     /**
-     * <p>Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is <code>/{method_setting_key}/metrics/enabled</code>, and the value is a Boolean.</p>
+     * <p>Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is <code>/\{method_setting_key\}/metrics/enabled</code>, and the value is a Boolean.</p>
      */
     metricsEnabled?: boolean;
     /**
-     * <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>
+     * <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/\{method_setting_key\}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>
      */
     loggingLevel?: string;
     /**
-     * <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/dataTrace</code>, and the value is a Boolean.</p>
+     * <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/\{method_setting_key\}/logging/dataTrace</code>, and the value is a Boolean.</p>
      */
     dataTraceEnabled?: boolean;
     /**
-     * <p>Specifies the throttling burst limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/burstLimit</code>, and the value is an integer.</p>
+     * <p>Specifies the throttling burst limit. The PATCH path for this setting is <code>/\{method_setting_key\}/throttling/burstLimit</code>, and the value is an integer.</p>
      */
     throttlingBurstLimit?: number;
     /**
-     * <p>Specifies the throttling rate limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/rateLimit</code>, and the value is a double.</p>
+     * <p>Specifies the throttling rate limit. The PATCH path for this setting is <code>/\{method_setting_key\}/throttling/rateLimit</code>, and the value is a double.</p>
      */
     throttlingRateLimit?: number;
     /**
-     * <p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/enabled</code>, and the value is a Boolean.</p>
+     * <p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/enabled</code>, and the value is a Boolean.</p>
      */
     cachingEnabled?: boolean;
     /**
-     * <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/ttlInSeconds</code>, and the value is an integer.</p>
+     * <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/ttlInSeconds</code>, and the value is an integer.</p>
      */
     cacheTtlInSeconds?: number;
     /**
-     * <p>Specifies whether the cached responses are encrypted. The PATCH path for this setting is <code>/{method_setting_key}/caching/dataEncrypted</code>, and the value is a Boolean.</p>
+     * <p>Specifies whether the cached responses are encrypted. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/dataEncrypted</code>, and the value is a Boolean.</p>
      */
     cacheDataEncrypted?: boolean;
     /**
-     * <p>Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is <code>/{method_setting_key}/caching/requireAuthorizationForCacheControl</code>, and the value is a Boolean.</p>
+     * <p>Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/requireAuthorizationForCacheControl</code>, and the value is a Boolean.</p>
      */
     requireAuthorizationForCacheControl?: boolean;
     /**
-     * <p>Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is <code>/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy</code>, and the available values are <code>FAIL_WITH_403</code>, <code>SUCCEED_WITH_RESPONSE_HEADER</code>, <code>SUCCEED_WITHOUT_RESPONSE_HEADER</code>.</p>
+     * <p>Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/unauthorizedCacheControlHeaderStrategy</code>, and the available values are <code>FAIL_WITH_403</code>, <code>SUCCEED_WITH_RESPONSE_HEADER</code>, <code>SUCCEED_WITHOUT_RESPONSE_HEADER</code>.</p>
      */
     unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | string;
 }
 /**
+ * @public
  * <p>Represents a unique identifier for a version of a deployed RestApi that is callable by users.</p>
  */
 export interface Stage {
@@ -1524,7 +1615,7 @@ export interface Stage {
      */
     cacheClusterStatus?: CacheClusterStatus | string;
     /**
-     * <p>A map that defines the method settings for a Stage resource. Keys (designated as <code>/{method_setting_key</code> below) are method paths defined as <code>{resource_path}/{http_method}</code> for an individual method override, or <code>/\*\/\*</code> for overriding all methods in the stage.  </p>
+     * <p>A map that defines the method settings for a Stage resource. Keys (designated as <code>/\{method_setting_key</code> below) are method paths defined as <code>\{resource_path\}/\{http_method\}</code> for an individual method override, or <code>/\*\/\*</code> for overriding all methods in the stage.  </p>
      */
     methodSettings?: Record<string, MethodSetting>;
     /**
@@ -1565,12 +1656,16 @@ export interface Stage {
      */
     lastUpdatedDate?: Date;
 }
+/**
+ * @public
+ */
 export declare enum QuotaPeriodType {
     DAY = "DAY",
     MONTH = "MONTH",
     WEEK = "WEEK"
 }
 /**
+ * @public
  * <p>Quotas configured for a usage plan.</p>
  */
 export interface QuotaSettings {
@@ -1588,6 +1683,7 @@ export interface QuotaSettings {
     period?: QuotaPeriodType | string;
 }
 /**
+ * @public
  * <p>The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.</p>
  */
 export interface CreateUsagePlanRequest {
@@ -1617,6 +1713,7 @@ export interface CreateUsagePlanRequest {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set.
  *         In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs.
  *         Consider using <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html">Amazon Web Services Budgets</a> to monitor costs
@@ -1657,6 +1754,7 @@ export interface UsagePlan {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The POST request to create a usage plan key for adding an existing API key to a usage plan.</p>
  */
 export interface CreateUsagePlanKeyRequest {
@@ -1674,6 +1772,7 @@ export interface CreateUsagePlanKeyRequest {
     keyType: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a usage plan key to identify a plan customer.</p>
  */
 export interface UsagePlanKey {
@@ -1695,6 +1794,7 @@ export interface UsagePlanKey {
     name?: string;
 }
 /**
+ * @public
  * <p>Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.</p>
  */
 export interface CreateVpcLinkRequest {
@@ -1715,6 +1815,9 @@ export interface CreateVpcLinkRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum VpcLinkStatus {
     AVAILABLE = "AVAILABLE",
     DELETING = "DELETING",
@@ -1722,6 +1825,7 @@ export declare enum VpcLinkStatus {
     PENDING = "PENDING"
 }
 /**
+ * @public
  * <p>An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).</p>
  */
 export interface VpcLink {
@@ -1755,6 +1859,7 @@ export interface VpcLink {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>A request to delete the ApiKey resource.</p>
  */
 export interface DeleteApiKeyRequest {
@@ -1764,6 +1869,7 @@ export interface DeleteApiKeyRequest {
     apiKey: string | undefined;
 }
 /**
+ * @public
  * <p>Request to delete an existing Authorizer resource.</p>
  */
 export interface DeleteAuthorizerRequest {
@@ -1777,6 +1883,7 @@ export interface DeleteAuthorizerRequest {
     authorizerId: string | undefined;
 }
 /**
+ * @public
  * <p>A request to delete the BasePathMapping resource.</p>
  */
 export interface DeleteBasePathMappingRequest {
@@ -1791,6 +1898,7 @@ export interface DeleteBasePathMappingRequest {
     basePath: string | undefined;
 }
 /**
+ * @public
  * <p>A request to delete the ClientCertificate resource.</p>
  */
 export interface DeleteClientCertificateRequest {
@@ -1800,6 +1908,7 @@ export interface DeleteClientCertificateRequest {
     clientCertificateId: string | undefined;
 }
 /**
+ * @public
  * <p>Requests API Gateway to delete a Deployment resource.</p>
  */
 export interface DeleteDeploymentRequest {
@@ -1813,6 +1922,7 @@ export interface DeleteDeploymentRequest {
     deploymentId: string | undefined;
 }
 /**
+ * @public
  * <p>Deletes an existing documentation part of an API.</p>
  */
 export interface DeleteDocumentationPartRequest {
@@ -1826,6 +1936,7 @@ export interface DeleteDocumentationPartRequest {
     documentationPartId: string | undefined;
 }
 /**
+ * @public
  * <p>Deletes an existing documentation version of an API.</p>
  */
 export interface DeleteDocumentationVersionRequest {
@@ -1839,6 +1950,7 @@ export interface DeleteDocumentationVersionRequest {
     documentationVersion: string | undefined;
 }
 /**
+ * @public
  * <p>A request to delete the DomainName resource.</p>
  */
 export interface DeleteDomainNameRequest {
@@ -1847,6 +1959,9 @@ export interface DeleteDomainNameRequest {
      */
     domainName: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum GatewayResponseType {
     ACCESS_DENIED = "ACCESS_DENIED",
     API_CONFIGURATION_ERROR = "API_CONFIGURATION_ERROR",
@@ -1871,6 +1986,7 @@ export declare enum GatewayResponseType {
     WAF_FILTERED = "WAF_FILTERED"
 }
 /**
+ * @public
  * <p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>
  */
 export interface DeleteGatewayResponseRequest {
@@ -1884,6 +2000,7 @@ export interface DeleteGatewayResponseRequest {
     responseType: GatewayResponseType | string | undefined;
 }
 /**
+ * @public
  * <p>Represents a delete integration request.</p>
  */
 export interface DeleteIntegrationRequest {
@@ -1901,6 +2018,7 @@ export interface DeleteIntegrationRequest {
     httpMethod: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a delete integration response request.</p>
  */
 export interface DeleteIntegrationResponseRequest {
@@ -1922,6 +2040,7 @@ export interface DeleteIntegrationResponseRequest {
     statusCode: string | undefined;
 }
 /**
+ * @public
  * <p>Request to delete an existing Method resource.</p>
  */
 export interface DeleteMethodRequest {
@@ -1939,6 +2058,7 @@ export interface DeleteMethodRequest {
     httpMethod: string | undefined;
 }
 /**
+ * @public
  * <p>A request to delete an existing MethodResponse resource.</p>
  */
 export interface DeleteMethodResponseRequest {
@@ -1960,6 +2080,7 @@ export interface DeleteMethodResponseRequest {
     statusCode: string | undefined;
 }
 /**
+ * @public
  * <p>Request to delete an existing model in an existing RestApi resource.</p>
  */
 export interface DeleteModelRequest {
@@ -1973,6 +2094,7 @@ export interface DeleteModelRequest {
     modelName: string | undefined;
 }
 /**
+ * @public
  * <p>Deletes a specified RequestValidator of a given RestApi.</p>
  */
 export interface DeleteRequestValidatorRequest {
@@ -1986,6 +2108,7 @@ export interface DeleteRequestValidatorRequest {
     requestValidatorId: string | undefined;
 }
 /**
+ * @public
  * <p>Request to delete a Resource.</p>
  */
 export interface DeleteResourceRequest {
@@ -1999,6 +2122,7 @@ export interface DeleteResourceRequest {
     resourceId: string | undefined;
 }
 /**
+ * @public
  * <p>Request to delete the specified API from your collection.</p>
  */
 export interface DeleteRestApiRequest {
@@ -2008,6 +2132,7 @@ export interface DeleteRestApiRequest {
     restApiId: string | undefined;
 }
 /**
+ * @public
  * <p>Requests API Gateway to delete a Stage resource.</p>
  */
 export interface DeleteStageRequest {
@@ -2021,6 +2146,7 @@ export interface DeleteStageRequest {
     stageName: string | undefined;
 }
 /**
+ * @public
  * <p>The DELETE request to delete a usage plan of a given plan Id.</p>
  */
 export interface DeleteUsagePlanRequest {
@@ -2030,6 +2156,7 @@ export interface DeleteUsagePlanRequest {
     usagePlanId: string | undefined;
 }
 /**
+ * @public
  * <p>The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.</p>
  */
 export interface DeleteUsagePlanKeyRequest {
@@ -2043,6 +2170,7 @@ export interface DeleteUsagePlanKeyRequest {
     keyId: string | undefined;
 }
 /**
+ * @public
  * <p>Deletes an existing VpcLink of a specified identifier.</p>
  */
 export interface DeleteVpcLinkRequest {
@@ -2052,6 +2180,7 @@ export interface DeleteVpcLinkRequest {
     vpcLinkId: string | undefined;
 }
 /**
+ * @public
  * <p>Request to flush authorizer cache entries on a specified stage.</p>
  */
 export interface FlushStageAuthorizersCacheRequest {
@@ -2065,6 +2194,7 @@ export interface FlushStageAuthorizersCacheRequest {
     stageName: string | undefined;
 }
 /**
+ * @public
  * <p>Requests API Gateway to flush a stage's cache.</p>
  */
 export interface FlushStageCacheRequest {
@@ -2078,6 +2208,7 @@ export interface FlushStageCacheRequest {
     stageName: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.</p>
  */
 export interface ClientCertificate {
@@ -2107,6 +2238,7 @@ export interface ClientCertificate {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>A request to generate a ClientCertificate resource.</p>
  */
 export interface GenerateClientCertificateRequest {
@@ -2120,11 +2252,13 @@ export interface GenerateClientCertificateRequest {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Requests API Gateway to get information about the current Account resource.</p>
  */
 export interface GetAccountRequest {
 }
 /**
+ * @public
  * <p>A request to get information about the current ApiKey resource.</p>
  */
 export interface GetApiKeyRequest {
@@ -2138,6 +2272,7 @@ export interface GetApiKeyRequest {
     includeValue?: boolean;
 }
 /**
+ * @public
  * <p>A request to get information about the current ApiKeys resource.</p>
  */
 export interface GetApiKeysRequest {
@@ -2163,6 +2298,7 @@ export interface GetApiKeysRequest {
     includeValues?: boolean;
 }
 /**
+ * @public
  * <p>Request to describe an existing Authorizer resource.</p>
  */
 export interface GetAuthorizerRequest {
@@ -2176,6 +2312,7 @@ export interface GetAuthorizerRequest {
     authorizerId: string | undefined;
 }
 /**
+ * @public
  * <p>Request to describe an existing Authorizers resource.</p>
  */
 export interface GetAuthorizersRequest {
@@ -2193,6 +2330,7 @@ export interface GetAuthorizersRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Request to describe a BasePathMapping resource.</p>
  */
 export interface GetBasePathMappingRequest {
@@ -2206,6 +2344,7 @@ export interface GetBasePathMappingRequest {
     basePath: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a collection of BasePathMapping resources.</p>
  */
 export interface BasePathMappings {
@@ -2219,6 +2358,7 @@ export interface BasePathMappings {
     position?: string;
 }
 /**
+ * @public
  * <p>A request to get information about a collection of BasePathMapping resources.</p>
  */
 export interface GetBasePathMappingsRequest {
@@ -2236,6 +2376,7 @@ export interface GetBasePathMappingsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>A request to get information about the current ClientCertificate resource.</p>
  */
 export interface GetClientCertificateRequest {
@@ -2245,6 +2386,7 @@ export interface GetClientCertificateRequest {
     clientCertificateId: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a collection of ClientCertificate resources.</p>
  */
 export interface ClientCertificates {
@@ -2258,6 +2400,7 @@ export interface ClientCertificates {
     position?: string;
 }
 /**
+ * @public
  * <p>A request to get information about a collection of ClientCertificate resources.</p>
  */
 export interface GetClientCertificatesRequest {
@@ -2271,6 +2414,7 @@ export interface GetClientCertificatesRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Requests API Gateway to get information about a Deployment resource.</p>
  */
 export interface GetDeploymentRequest {
@@ -2283,11 +2427,12 @@ export interface GetDeploymentRequest {
      */
     deploymentId: string | undefined;
     /**
-     * <p>A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in  <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>"apisummary"</code> string.  For example, <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary</code>.</p>
+     * <p>A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in  <code>GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>"apisummary"</code> string.  For example, <code>GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=apisummary</code>.</p>
      */
     embed?: string[];
 }
 /**
+ * @public
  * <p>Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p>
  */
 export interface Deployments {
@@ -2301,6 +2446,7 @@ export interface Deployments {
     position?: string;
 }
 /**
+ * @public
  * <p>Requests API Gateway to get information about a Deployments collection.</p>
  */
 export interface GetDeploymentsRequest {
@@ -2318,6 +2464,7 @@ export interface GetDeploymentsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Gets a specified documentation part of a given API.</p>
  */
 export interface GetDocumentationPartRequest {
@@ -2331,6 +2478,7 @@ export interface GetDocumentationPartRequest {
     documentationPartId: string | undefined;
 }
 /**
+ * @public
  * <p>The collection of documentation parts of an API.</p>
  */
 export interface DocumentationParts {
@@ -2343,11 +2491,15 @@ export interface DocumentationParts {
      */
     position?: string;
 }
+/**
+ * @public
+ */
 export declare enum LocationStatusType {
     DOCUMENTED = "DOCUMENTED",
     UNDOCUMENTED = "UNDOCUMENTED"
 }
 /**
+ * @public
  * <p>Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).</p>
  */
 export interface GetDocumentationPartsRequest {
@@ -2381,6 +2533,7 @@ export interface GetDocumentationPartsRequest {
     locationStatus?: LocationStatusType | string;
 }
 /**
+ * @public
  * <p>Gets a documentation snapshot of an API.</p>
  */
 export interface GetDocumentationVersionRequest {
@@ -2394,6 +2547,7 @@ export interface GetDocumentationVersionRequest {
     documentationVersion: string | undefined;
 }
 /**
+ * @public
  * <p>The collection of documentation snapshots of an API. </p>
  */
 export interface DocumentationVersions {
@@ -2407,6 +2561,7 @@ export interface DocumentationVersions {
     position?: string;
 }
 /**
+ * @public
  * <p>Gets the documentation versions of an API.</p>
  */
 export interface GetDocumentationVersionsRequest {
@@ -2424,6 +2579,7 @@ export interface GetDocumentationVersionsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Request to get the name of a DomainName resource.</p>
  */
 export interface GetDomainNameRequest {
@@ -2433,6 +2589,7 @@ export interface GetDomainNameRequest {
     domainName: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a collection of DomainName resources.</p>
  */
 export interface DomainNames {
@@ -2446,6 +2603,7 @@ export interface DomainNames {
     position?: string;
 }
 /**
+ * @public
  * <p>Request to describe a collection of DomainName resources.</p>
  */
 export interface GetDomainNamesRequest {
@@ -2459,6 +2617,7 @@ export interface GetDomainNamesRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>The binary blob response to GetExport, which contains the generated SDK.</p>
  */
 export interface ExportResponse {
@@ -2476,6 +2635,7 @@ export interface ExportResponse {
     body?: Uint8Array;
 }
 /**
+ * @public
  * <p>Request a new export of a RestApi for a particular Stage.</p>
  */
 export interface GetExportRequest {
@@ -2502,6 +2662,7 @@ export interface GetExportRequest {
     accepts?: string;
 }
 /**
+ * @public
  * <p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p>
  */
 export interface GatewayResponse {
@@ -2528,6 +2689,7 @@ export interface GatewayResponse {
     defaultResponse?: boolean;
 }
 /**
+ * @public
  * <p>Gets a GatewayResponse of a specified response type on the given RestApi.</p>
  */
 export interface GetGatewayResponseRequest {
@@ -2541,6 +2703,7 @@ export interface GetGatewayResponseRequest {
     responseType: GatewayResponseType | string | undefined;
 }
 /**
+ * @public
  * <p>The collection of the GatewayResponse instances of a RestApi as a <code>responseType</code>-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.</p>
  */
 export interface GatewayResponses {
@@ -2554,6 +2717,7 @@ export interface GatewayResponses {
     position?: string;
 }
 /**
+ * @public
  * <p>Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.</p>
  */
 export interface GetGatewayResponsesRequest {
@@ -2571,6 +2735,7 @@ export interface GetGatewayResponsesRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Represents a request to get the integration configuration.</p>
  */
 export interface GetIntegrationRequest {
@@ -2588,6 +2753,7 @@ export interface GetIntegrationRequest {
     httpMethod: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a get integration response request.</p>
  */
 export interface GetIntegrationResponseRequest {
@@ -2609,6 +2775,7 @@ export interface GetIntegrationResponseRequest {
     statusCode: string | undefined;
 }
 /**
+ * @public
  * <p>Request to describe an existing Method resource.</p>
  */
 export interface GetMethodRequest {
@@ -2626,6 +2793,7 @@ export interface GetMethodRequest {
     httpMethod: string | undefined;
 }
 /**
+ * @public
  * <p>Request to describe a MethodResponse resource.</p>
  */
 export interface GetMethodResponseRequest {
@@ -2647,6 +2815,7 @@ export interface GetMethodResponseRequest {
     statusCode: string | undefined;
 }
 /**
+ * @public
  * <p>Request to list information about a model in an existing RestApi resource.</p>
  */
 export interface GetModelRequest {
@@ -2664,6 +2833,7 @@ export interface GetModelRequest {
     flatten?: boolean;
 }
 /**
+ * @public
  * <p>Request to list existing Models defined for a RestApi resource.</p>
  */
 export interface GetModelsRequest {
@@ -2681,6 +2851,7 @@ export interface GetModelsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Represents a collection of Model resources.</p>
  */
 export interface Models {
@@ -2694,6 +2865,7 @@ export interface Models {
     position?: string;
 }
 /**
+ * @public
  * <p>Request to generate a sample mapping template used to transform the payload.</p>
  */
 export interface GetModelTemplateRequest {
@@ -2707,6 +2879,7 @@ export interface GetModelTemplateRequest {
     modelName: string | undefined;
 }
 /**
+ * @public
  * <p>Represents a mapping template used to transform a payload.</p>
  */
 export interface Template {
@@ -2716,6 +2889,7 @@ export interface Template {
     value?: string;
 }
 /**
+ * @public
  * <p>Gets a RequestValidator of a given RestApi.</p>
  */
 export interface GetRequestValidatorRequest {
@@ -2729,6 +2903,7 @@ export interface GetRequestValidatorRequest {
     requestValidatorId: string | undefined;
 }
 /**
+ * @public
  * <p>Gets the RequestValidators collection of a given RestApi.</p>
  */
 export interface GetRequestValidatorsRequest {
@@ -2746,6 +2921,7 @@ export interface GetRequestValidatorsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>A collection of RequestValidator resources of a given RestApi.</p>
  */
 export interface RequestValidators {
@@ -2759,6 +2935,7 @@ export interface RequestValidators {
     position?: string;
 }
 /**
+ * @public
  * <p>Request to list information about a resource.</p>
  */
 export interface GetResourceRequest {
@@ -2771,11 +2948,12 @@ export interface GetResourceRequest {
      */
     resourceId: string | undefined;
     /**
-     * <p>A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods</code>.</p>
+     * <p>A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods</code>.</p>
      */
     embed?: string[];
 }
 /**
+ * @public
  * <p>Request to list information about a collection of resources.</p>
  */
 export interface GetResourcesRequest {
@@ -2792,11 +2970,12 @@ export interface GetResourcesRequest {
      */
     limit?: number;
     /**
-     * <p>A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.  This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.</p>
+     * <p>A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.  This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/\{restapi_id\}/resources?embed=methods</code>.</p>
      */
     embed?: string[];
 }
 /**
+ * @public
  * <p>Represents a collection of Resource resources.</p>
  */
 export interface Resources {
@@ -2810,6 +2989,7 @@ export interface Resources {
     position?: string;
 }
 /**
+ * @public
  * <p>The GET request to list an existing RestApi defined for your collection. </p>
  */
 export interface GetRestApiRequest {
@@ -2819,6 +2999,7 @@ export interface GetRestApiRequest {
     restApiId: string | undefined;
 }
 /**
+ * @public
  * <p>The GET request to list existing RestApis defined for your collection.</p>
  */
 export interface GetRestApisRequest {
@@ -2832,6 +3013,7 @@ export interface GetRestApisRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.</p>
  */
 export interface RestApis {
@@ -2845,6 +3027,7 @@ export interface RestApis {
     position?: string;
 }
 /**
+ * @public
  * <p>Request a new generated client SDK for a RestApi and Stage.</p>
  */
 export interface GetSdkRequest {
@@ -2866,6 +3049,7 @@ export interface GetSdkRequest {
     parameters?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The binary blob response to GetSdk, which contains the generated SDK.</p>
  */
 export interface SdkResponse {
@@ -2883,6 +3067,7 @@ export interface SdkResponse {
     body?: Uint8Array;
 }
 /**
+ * @public
  * <p>Get an SdkType instance.</p>
  */
 export interface GetSdkTypeRequest {
@@ -2892,6 +3077,7 @@ export interface GetSdkTypeRequest {
     id: string | undefined;
 }
 /**
+ * @public
  * <p>A configuration property of an SDK type.</p>
  */
 export interface SdkConfigurationProperty {
@@ -2917,6 +3103,7 @@ export interface SdkConfigurationProperty {
     defaultValue?: string;
 }
 /**
+ * @public
  * <p>A type of SDK that API Gateway can generate.</p>
  */
 export interface SdkType {
@@ -2938,6 +3125,7 @@ export interface SdkType {
     configurationProperties?: SdkConfigurationProperty[];
 }
 /**
+ * @public
  * <p>Get the SdkTypes collection.</p>
  */
 export interface GetSdkTypesRequest {
@@ -2951,6 +3139,7 @@ export interface GetSdkTypesRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>The collection of SdkType instances.</p>
  */
 export interface SdkTypes {
@@ -2960,6 +3149,7 @@ export interface SdkTypes {
     items?: SdkType[];
 }
 /**
+ * @public
  * <p>Requests API Gateway to get information about a Stage resource.</p>
  */
 export interface GetStageRequest {
@@ -2973,6 +3163,7 @@ export interface GetStageRequest {
     stageName: string | undefined;
 }
 /**
+ * @public
  * <p>Requests API Gateway to get information about one or more Stage resources.</p>
  */
 export interface GetStagesRequest {
@@ -2986,6 +3177,7 @@ export interface GetStagesRequest {
     deploymentId?: string;
 }
 /**
+ * @public
  * <p>A list of Stage resources that are associated with the ApiKey resource.</p>
  */
 export interface Stages {
@@ -2995,6 +3187,7 @@ export interface Stages {
     item?: Stage[];
 }
 /**
+ * @public
  * <p>Gets the Tags collection for a given resource.</p>
  */
 export interface GetTagsRequest {
@@ -3012,6 +3205,7 @@ export interface GetTagsRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>The collection of tags. Each tag element is associated with a given resource.</p>
  */
 export interface Tags {
@@ -3021,6 +3215,7 @@ export interface Tags {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The GET request to get the usage data of a usage plan in a specified time interval.</p>
  */
 export interface GetUsageRequest {
@@ -3050,6 +3245,7 @@ export interface GetUsageRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Represents the usage data of a usage plan.</p>
  */
 export interface Usage {
@@ -3066,7 +3262,7 @@ export interface Usage {
      */
     endDate?: string;
     /**
-     * <p>The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}</code>, where <code>{api_key}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>.</p>
+     * <p>The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>\{..., "values" : \{ "\{api_key\}" : [ [0, 100], [10, 90], [100, 10]]\}</code>, where <code>\{api_key\}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>.</p>
      */
     items?: Record<string, number[][]>;
     /**
@@ -3075,6 +3271,7 @@ export interface Usage {
     position?: string;
 }
 /**
+ * @public
  * <p>The GET request to get a usage plan of a given plan identifier.</p>
  */
 export interface GetUsagePlanRequest {
@@ -3084,6 +3281,7 @@ export interface GetUsagePlanRequest {
     usagePlanId: string | undefined;
 }
 /**
+ * @public
  * <p>The GET request to get a usage plan key of a given key identifier.</p>
  */
 export interface GetUsagePlanKeyRequest {
@@ -3097,6 +3295,7 @@ export interface GetUsagePlanKeyRequest {
     keyId: string | undefined;
 }
 /**
+ * @public
  * <p>The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.</p>
  */
 export interface GetUsagePlanKeysRequest {
@@ -3118,6 +3317,7 @@ export interface GetUsagePlanKeysRequest {
     nameQuery?: string;
 }
 /**
+ * @public
  * <p>Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.</p>
  */
 export interface UsagePlanKeys {
@@ -3131,6 +3331,7 @@ export interface UsagePlanKeys {
     position?: string;
 }
 /**
+ * @public
  * <p>The GET request to get all the usage plans of the caller's account.</p>
  */
 export interface GetUsagePlansRequest {
@@ -3148,6 +3349,7 @@ export interface GetUsagePlansRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>Represents a collection of usage plans for an AWS account.</p>
  */
 export interface UsagePlans {
@@ -3161,6 +3363,7 @@ export interface UsagePlans {
     position?: string;
 }
 /**
+ * @public
  * <p>Gets a specified VPC link under the caller's account in a region.</p>
  */
 export interface GetVpcLinkRequest {
@@ -3170,6 +3373,7 @@ export interface GetVpcLinkRequest {
     vpcLinkId: string | undefined;
 }
 /**
+ * @public
  * <p>Gets the VpcLinks collection under the caller's account in a selected region.</p>
  */
 export interface GetVpcLinksRequest {
@@ -3183,6 +3387,7 @@ export interface GetVpcLinksRequest {
     limit?: number;
 }
 /**
+ * @public
  * <p>The collection of VPC links under the caller's account in a region.</p>
  */
 export interface VpcLinks {
@@ -3196,6 +3401,7 @@ export interface VpcLinks {
     position?: string;
 }
 /**
+ * @public
  * <p>The POST request to import API keys from an external source, such as a CSV-formatted file.</p>
  */
 export interface ImportApiKeysRequest {
@@ -3213,6 +3419,7 @@ export interface ImportApiKeysRequest {
     failOnWarnings?: boolean;
 }
 /**
+ * @public
  * <p>A collection of the imported  DocumentationPart identifiers.</p>
  */
 export interface DocumentationPartIds {
@@ -3225,11 +3432,15 @@ export interface DocumentationPartIds {
      */
     warnings?: string[];
 }
+/**
+ * @public
+ */
 export declare enum PutMode {
     Merge = "merge",
     Overwrite = "overwrite"
 }
 /**
+ * @public
  * <p>Import documentation parts from an external (e.g., OpenAPI) definition file. </p>
  */
 export interface ImportDocumentationPartsRequest {
@@ -3251,6 +3462,7 @@ export interface ImportDocumentationPartsRequest {
     body: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>A POST request to import an API to API Gateway using an input of an API definition file.</p>
  */
 export interface ImportRestApiRequest {
@@ -3274,6 +3486,7 @@ export interface ImportRestApiRequest {
     body: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.</p>
  */
 export interface PutGatewayResponseRequest {
@@ -3299,6 +3512,7 @@ export interface PutGatewayResponseRequest {
     responseTemplates?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Sets up a method's integration.</p>
  */
 export interface PutIntegrationRequest {
@@ -3328,17 +3542,17 @@ export interface PutIntegrationRequest {
      *       RFC-3986 specification, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>,
      *       or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the
      *       URI is not used for routing. For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form
-     *       <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api</code>}. Here,
-     *       {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated
-     *       Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services
+     *       <code>arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api</code>\}. Here,
+     *       \{Region\} is the API Gateway region (e.g., us-east-1); \{service\} is the name of the integrated
+     *       Amazon Web Services service (e.g., s3); and \{subdomain\} is a designated subdomain supported by certain Amazon Web Services
      *       service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API,
-     *       using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to
-     *       a supported action {name} plus any required input parameters. Alternatively, path can be used
+     *       using an Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}... query string. The ensuing \{service_api\} refers to
+     *       a supported action \{name\} plus any required input parameters. Alternatively, path can be used
      *       for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services
      *       service resource, including the region of the integrated Amazon Web Services service, if applicable. For
      *       example, for integration with the S3 API of <code>GetObject</code>, the <code>uri</code> can be either
-     *       <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or
-     *       <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code>.</p>
+     *       <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}</code> or
+     *       <code>arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}</code>.</p>
      */
     uri?: string;
     /**
@@ -3354,7 +3568,7 @@ export interface PutIntegrationRequest {
      */
     credentials?: string;
     /**
-     * <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of  <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
+     * <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of  <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
      */
     requestParameters?: Record<string, string>;
     /**
@@ -3389,6 +3603,7 @@ export interface PutIntegrationRequest {
     tlsConfig?: TlsConfig;
 }
 /**
+ * @public
  * <p>Represents a put integration response request.</p>
  */
 export interface PutIntegrationResponseRequest {
@@ -3414,7 +3629,7 @@ export interface PutIntegrationResponseRequest {
     selectionPattern?: string;
     /**
      * <p>A key-value map specifying response parameters that are passed to the method response from the back end.
-     *             The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.</p>
+     *             The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.\{name\}</code> or <code>integration.response.body.\{JSON-expression\}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.</p>
      */
     responseParameters?: Record<string, string>;
     /**
@@ -3428,6 +3643,7 @@ export interface PutIntegrationResponseRequest {
     contentHandling?: ContentHandlingStrategy | string;
 }
 /**
+ * @public
  * <p>Request to add a method to an existing Resource resource.</p>
  */
 export interface PutMethodRequest {
@@ -3460,7 +3676,7 @@ export interface PutMethodRequest {
      */
     operationName?: string;
     /**
-     * <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of  <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>).  The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
+     * <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of  <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>).  The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
      */
     requestParameters?: Record<string, boolean>;
     /**
@@ -3477,6 +3693,7 @@ export interface PutMethodRequest {
     authorizationScopes?: string[];
 }
 /**
+ * @public
  * <p>Request to add a MethodResponse to an existing Method resource.</p>
  */
 export interface PutMethodResponseRequest {
@@ -3497,7 +3714,7 @@ export interface PutMethodResponseRequest {
      */
     statusCode: string | undefined;
     /**
-     * <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
+     * <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.\{name\}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.\{JSON-expression\}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
      */
     responseParameters?: Record<string, boolean>;
     /**
@@ -3506,6 +3723,7 @@ export interface PutMethodResponseRequest {
     responseModels?: Record<string, string>;
 }
 /**
+ * @public
  * <p>A PUT request to update an existing API, with external API definitions specified as the request body.</p>
  */
 export interface PutRestApiRequest {
@@ -3533,6 +3751,7 @@ export interface PutRestApiRequest {
     body: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>Adds or updates a tag on a given resource.</p>
  */
 export interface TagResourceRequest {
@@ -3546,6 +3765,7 @@ export interface TagResourceRequest {
     tags: Record<string, string> | undefined;
 }
 /**
+ * @public
  * <p>Make a request to simulate the invocation of an Authorizer.</p>
  */
 export interface TestInvokeAuthorizerRequest {
@@ -3583,6 +3803,7 @@ export interface TestInvokeAuthorizerRequest {
     additionalContext?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Represents the response of the test invoke request for a custom Authorizer</p>
  */
 export interface TestInvokeAuthorizerResponse {
@@ -3616,6 +3837,7 @@ export interface TestInvokeAuthorizerResponse {
     claims?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Make a request to simulate the invocation of a Method.</p>
  */
 export interface TestInvokeMethodRequest {
@@ -3657,6 +3879,7 @@ export interface TestInvokeMethodRequest {
     stageVariables?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Represents the response of the test invoke request in the HTTP method.</p>
  */
 export interface TestInvokeMethodResponse {
@@ -3686,6 +3909,7 @@ export interface TestInvokeMethodResponse {
     latency?: number;
 }
 /**
+ * @public
  * <p>Removes a tag from a given resource.</p>
  */
 export interface UntagResourceRequest {
@@ -3698,6 +3922,9 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum Op {
     add = "add",
     copy = "copy",
@@ -3707,6 +3934,7 @@ export declare enum Op {
     test = "test"
 }
 /**
+ * @public
  * <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
  */
 export interface PatchOperation {
@@ -3720,8 +3948,8 @@ export interface PatchOperation {
     /**
      * <p>The op operation's target, as identified by a JSON Pointer value that references a
      *             location within the targeted resource. For example, if the target resource has an
-     *             updateable property of {"name":"value"}, the path for this property is /name. If the
-     *             name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}),
+     *             updateable property of \{"name":"value"\}, the path for this property is /name. If the
+     *             name property value is a JSON object (e.g., \{"name": \{"child/name": "child-value"\}\}),
      *             the path for the child/name property will be /name/child~1name. Any slash ("/")
      *             character appearing in path names must be escaped with "~1", as shown in the example
      *             above. Each op operation can have only one path associated with it.</p>
@@ -3730,7 +3958,7 @@ export interface PatchOperation {
     /**
      * <p>The new target value of the update operation. It is applicable for the add or replace
      *             operation. When using AWS CLI to update a property of a JSON value, enclose the JSON
-     *             object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'.</p>
+     *             object with a pair of single quotes in a Linux shell, e.g., '\{"a": ...\}'.</p>
      */
     value?: string;
     /**
@@ -3743,6 +3971,7 @@ export interface PatchOperation {
     from?: string;
 }
 /**
+ * @public
  * <p>Requests API Gateway to change information about the current Account resource.</p>
  */
 export interface UpdateAccountRequest {
@@ -3752,6 +3981,7 @@ export interface UpdateAccountRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>A request to change information about an ApiKey resource.</p>
  */
 export interface UpdateApiKeyRequest {
@@ -3765,6 +3995,7 @@ export interface UpdateApiKeyRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Request to update an existing Authorizer resource.</p>
  */
 export interface UpdateAuthorizerRequest {
@@ -3782,6 +4013,7 @@ export interface UpdateAuthorizerRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>A request to change information about the BasePathMapping resource.</p>
  */
 export interface UpdateBasePathMappingRequest {
@@ -3800,6 +4032,7 @@ export interface UpdateBasePathMappingRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>A request to change information about an ClientCertificate resource.</p>
  */
 export interface UpdateClientCertificateRequest {
@@ -3813,6 +4046,7 @@ export interface UpdateClientCertificateRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Requests API Gateway to change information about a Deployment resource.</p>
  */
 export interface UpdateDeploymentRequest {
@@ -3830,6 +4064,7 @@ export interface UpdateDeploymentRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Updates an existing documentation part of a given API.</p>
  */
 export interface UpdateDocumentationPartRequest {
@@ -3847,6 +4082,7 @@ export interface UpdateDocumentationPartRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Updates an existing documentation version of an API.</p>
  */
 export interface UpdateDocumentationVersionRequest {
@@ -3864,6 +4100,7 @@ export interface UpdateDocumentationVersionRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>A request to change information about the DomainName resource.</p>
  */
 export interface UpdateDomainNameRequest {
@@ -3877,6 +4114,7 @@ export interface UpdateDomainNameRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Updates a GatewayResponse of a specified response type on the given RestApi.</p>
  */
 export interface UpdateGatewayResponseRequest {
@@ -3894,6 +4132,7 @@ export interface UpdateGatewayResponseRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Represents an update integration request.</p>
  */
 export interface UpdateIntegrationRequest {
@@ -3915,6 +4154,7 @@ export interface UpdateIntegrationRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Represents an update integration response request.</p>
  */
 export interface UpdateIntegrationResponseRequest {
@@ -3940,6 +4180,7 @@ export interface UpdateIntegrationResponseRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Request to update an existing Method resource.</p>
  */
 export interface UpdateMethodRequest {
@@ -3961,6 +4202,7 @@ export interface UpdateMethodRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>A request to update an existing MethodResponse resource.</p>
  */
 export interface UpdateMethodResponseRequest {
@@ -3986,6 +4228,7 @@ export interface UpdateMethodResponseRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Request to update an existing model in an existing RestApi resource.</p>
  */
 export interface UpdateModelRequest {
@@ -4003,6 +4246,7 @@ export interface UpdateModelRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Updates a RequestValidator of a given RestApi.</p>
  */
 export interface UpdateRequestValidatorRequest {
@@ -4020,6 +4264,7 @@ export interface UpdateRequestValidatorRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Request to change information about a Resource resource.</p>
  */
 export interface UpdateResourceRequest {
@@ -4037,6 +4282,7 @@ export interface UpdateResourceRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Request to update an existing RestApi resource in your collection.</p>
  */
 export interface UpdateRestApiRequest {
@@ -4050,6 +4296,7 @@ export interface UpdateRestApiRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Requests API Gateway to change information about a Stage resource.</p>
  */
 export interface UpdateStageRequest {
@@ -4067,6 +4314,7 @@ export interface UpdateStageRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.</p>
  */
 export interface UpdateUsageRequest {
@@ -4084,6 +4332,7 @@ export interface UpdateUsageRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>The PATCH request to update a usage plan of a given plan Id.</p>
  */
 export interface UpdateUsagePlanRequest {
@@ -4097,6 +4346,7 @@ export interface UpdateUsagePlanRequest {
     patchOperations?: PatchOperation[];
 }
 /**
+ * @public
  * <p>Updates an existing VpcLink of a specified identifier.</p>
  */
 export interface UpdateVpcLinkRequest {