@aws-sdk/client-api-gateway 3.934.0 → 3.936.0

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

@@ -1,16 +1,4 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { APIGatewayServiceException as __BaseException } from "./APIGatewayServiceException";
-/**
- * @public
- * @enum
- */
-export declare const AccessAssociationSourceType: {
-    readonly VPCE: "VPCE";
-};
-/**
- * @public
- */
-export type AccessAssociationSourceType = (typeof AccessAssociationSourceType)[keyof typeof AccessAssociationSourceType];
+import { AccessAssociationSourceType, ApiKeysFormat, ApiKeySourceType, ApiStatus, AuthorizerType, CacheClusterSize, CacheClusterStatus, ConnectionType, ContentHandlingStrategy, DocumentationPartType, DomainNameStatus, EndpointAccessMode, EndpointType, GatewayResponseType, IntegrationType, IpAddressType, LocationStatusType, Op, PutMode, QuotaPeriodType, ResourceOwner, ResponseTransferMode, RoutingMode, SecurityPolicy, UnauthorizedCacheControlHeaderStrategy, VpcLinkStatus } from "./enums";
 /**
  * <p>Access log settings, including the access log format and access log destination ARN.</p>
  * @public
@@ -162,29 +150,6 @@ export interface ApiKeys {
      */
     position?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const ApiKeysFormat: {
-    readonly csv: "csv";
-};
-/**
- * @public
- */
-export type ApiKeysFormat = (typeof ApiKeysFormat)[keyof typeof ApiKeysFormat];
-/**
- * @public
- * @enum
- */
-export declare const ApiKeySourceType: {
-    readonly AUTHORIZER: "AUTHORIZER";
-    readonly HEADER: "HEADER";
-};
-/**
- * @public
- */
-export type ApiKeySourceType = (typeof ApiKeySourceType)[keyof typeof ApiKeySourceType];
 /**
  * <p>API stage name of the associated API stage in a usage plan.</p>
  * @public
@@ -206,19 +171,6 @@ export interface ApiStage {
      */
     throttle?: Record<string, ThrottleSettings> | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const AuthorizerType: {
-    readonly COGNITO_USER_POOLS: "COGNITO_USER_POOLS";
-    readonly REQUEST: "REQUEST";
-    readonly TOKEN: "TOKEN";
-};
-/**
- * @public
- */
-export type AuthorizerType = (typeof AuthorizerType)[keyof typeof AuthorizerType];
 /**
  * <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>
  * @public
@@ -305,30 +257,6 @@ export interface Authorizers {
      */
     position?: string | undefined;
 }
-/**
- * <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
- * @public
- */
-export declare class BadRequestException extends __BaseException {
-    readonly name: "BadRequestException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
-}
-/**
- * <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
- * @public
- */
-export declare class ConflictException extends __BaseException {
-    readonly name: "ConflictException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
-}
 /**
  * <p>A reference to a unique stage identified in the format <code>\{restApiId\}/\{stage\}</code>.</p>
  * @public
@@ -391,56 +319,6 @@ export interface CreateApiKeyRequest {
      */
     tags?: Record<string, string> | undefined;
 }
-/**
- * <p>The request exceeded the rate limit. Retry after the specified time period.</p>
- * @public
- */
-export declare class LimitExceededException extends __BaseException {
-    readonly name: "LimitExceededException";
-    readonly $fault: "client";
-    retryAfterSeconds?: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
-}
-/**
- * <p>The requested resource is not found. Make sure that the request URI is correct.</p>
- * @public
- */
-export declare class NotFoundException extends __BaseException {
-    readonly name: "NotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
-}
-/**
- * <p>The request has reached its throttling limit. Retry after the specified time period.</p>
- * @public
- */
-export declare class TooManyRequestsException extends __BaseException {
-    readonly name: "TooManyRequestsException";
-    readonly $fault: "client";
-    retryAfterSeconds?: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
-}
-/**
- * <p>The request is denied because the caller has insufficient permissions.</p>
- * @public
- */
-export declare class UnauthorizedException extends __BaseException {
-    readonly name: "UnauthorizedException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
-}
 /**
  * <p>Request to add a new Authorizer to an existing RestApi resource.</p>
  * @public
@@ -565,24 +443,6 @@ export interface CreateBasePathMappingRequest {
      */
     stage?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const CacheClusterSize: {
-    readonly SIZE_0_POINT_5_GB: "0.5";
-    readonly SIZE_118_GB: "118";
-    readonly SIZE_13_POINT_5_GB: "13.5";
-    readonly SIZE_1_POINT_6_GB: "1.6";
-    readonly SIZE_237_GB: "237";
-    readonly SIZE_28_POINT_4_GB: "28.4";
-    readonly SIZE_58_POINT_2_GB: "58.2";
-    readonly SIZE_6_POINT_1_GB: "6.1";
-};
-/**
- * @public
- */
-export type CacheClusterSize = (typeof CacheClusterSize)[keyof typeof CacheClusterSize];
 /**
  * <p>The input configuration for a canary deployment.</p>
  * @public
@@ -699,41 +559,6 @@ export interface Deployment {
      */
     apiSummary?: Record<string, Record<string, MethodSnapshot>> | undefined;
 }
-/**
- * <p>The requested service is not available. For details see the accompanying error message. Retry after the specified time period.</p>
- * @public
- */
-export declare class ServiceUnavailableException extends __BaseException {
-    readonly name: "ServiceUnavailableException";
-    readonly $fault: "server";
-    retryAfterSeconds?: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-export declare const DocumentationPartType: {
-    readonly API: "API";
-    readonly AUTHORIZER: "AUTHORIZER";
-    readonly METHOD: "METHOD";
-    readonly MODEL: "MODEL";
-    readonly PATH_PARAMETER: "PATH_PARAMETER";
-    readonly QUERY_PARAMETER: "QUERY_PARAMETER";
-    readonly REQUEST_BODY: "REQUEST_BODY";
-    readonly REQUEST_HEADER: "REQUEST_HEADER";
-    readonly RESOURCE: "RESOURCE";
-    readonly RESPONSE: "RESPONSE";
-    readonly RESPONSE_BODY: "RESPONSE_BODY";
-    readonly RESPONSE_HEADER: "RESPONSE_HEADER";
-};
-/**
- * @public
- */
-export type DocumentationPartType = (typeof DocumentationPartType)[keyof typeof DocumentationPartType];
 /**
  * <p>Specifies the target API entity to which the documentation applies.</p>
  * @public
@@ -854,31 +679,6 @@ export interface DocumentationVersion {
      */
     description?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const IpAddressType: {
-    readonly dualstack: "dualstack";
-    readonly ipv4: "ipv4";
-};
-/**
- * @public
- */
-export type IpAddressType = (typeof IpAddressType)[keyof typeof IpAddressType];
-/**
- * @public
- * @enum
- */
-export declare const EndpointType: {
-    readonly EDGE: "EDGE";
-    readonly PRIVATE: "PRIVATE";
-    readonly REGIONAL: "REGIONAL";
-};
-/**
- * @public
- */
-export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
 /**
  * <p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it. </p>
  * @public
@@ -924,31 +724,6 @@ export interface MutualTlsAuthenticationInput {
      */
     truststoreVersion?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const RoutingMode: {
-    readonly BASE_PATH_MAPPING_ONLY: "BASE_PATH_MAPPING_ONLY";
-    readonly ROUTING_RULE_ONLY: "ROUTING_RULE_ONLY";
-    readonly ROUTING_RULE_THEN_BASE_PATH_MAPPING: "ROUTING_RULE_THEN_BASE_PATH_MAPPING";
-};
-/**
- * @public
- */
-export type RoutingMode = (typeof RoutingMode)[keyof typeof RoutingMode];
-/**
- * @public
- * @enum
- */
-export declare const SecurityPolicy: {
-    readonly TLS_1_0: "TLS_1_0";
-    readonly TLS_1_2: "TLS_1_2";
-};
-/**
- * @public
- */
-export type SecurityPolicy = (typeof SecurityPolicy)[keyof typeof SecurityPolicy];
 /**
  * <p>A request to create a new domain name.</p>
  * @public
@@ -1005,10 +780,17 @@ export interface CreateDomainNameRequest {
      */
     tags?: Record<string, string> | undefined;
     /**
-     * <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p>
+     * <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName.</p>
      * @public
      */
     securityPolicy?: SecurityPolicy | undefined;
+    /**
+     * <p>
+     * The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with <code>SecurityPolicy_</code>.
+     * </p>
+     * @public
+     */
+    endpointAccessMode?: EndpointAccessMode | undefined;
     /**
      * <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
@@ -1038,21 +820,6 @@ export interface CreateDomainNameRequest {
      */
     routingMode?: RoutingMode | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const DomainNameStatus: {
-    readonly AVAILABLE: "AVAILABLE";
-    readonly PENDING: "PENDING";
-    readonly PENDING_CERTIFICATE_REIMPORT: "PENDING_CERTIFICATE_REIMPORT";
-    readonly PENDING_OWNERSHIP_VERIFICATION: "PENDING_OWNERSHIP_VERIFICATION";
-    readonly UPDATING: "UPDATING";
-};
-/**
- * @public
- */
-export type DomainNameStatus = (typeof DomainNameStatus)[keyof typeof DomainNameStatus];
 /**
  * <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
@@ -1165,10 +932,17 @@ export interface DomainName {
      */
     domainNameStatusMessage?: string | undefined;
     /**
-     * <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p>
+     * <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName.</p>
      * @public
      */
     securityPolicy?: SecurityPolicy | undefined;
+    /**
+     * <p>
+     * The endpoint access mode of the DomainName.
+     * </p>
+     * @public
+     */
+    endpointAccessMode?: EndpointAccessMode | undefined;
     /**
      * <p>The collection of tags. Each tag element is associated with a given resource.</p>
      * @public
@@ -1411,30 +1185,6 @@ export interface CreateResourceRequest {
      */
     pathPart: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const ConnectionType: {
-    readonly INTERNET: "INTERNET";
-    readonly VPC_LINK: "VPC_LINK";
-};
-/**
- * @public
- */
-export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
-/**
- * @public
- * @enum
- */
-export declare const ContentHandlingStrategy: {
-    readonly CONVERT_TO_BINARY: "CONVERT_TO_BINARY";
-    readonly CONVERT_TO_TEXT: "CONVERT_TO_TEXT";
-};
-/**
- * @public
- */
-export type ContentHandlingStrategy = (typeof ContentHandlingStrategy)[keyof typeof ContentHandlingStrategy];
 /**
  * <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>
  * @public
@@ -1489,21 +1239,6 @@ export interface TlsConfig {
      */
     insecureSkipVerification?: boolean | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const IntegrationType: {
-    readonly AWS: "AWS";
-    readonly AWS_PROXY: "AWS_PROXY";
-    readonly HTTP: "HTTP";
-    readonly HTTP_PROXY: "HTTP_PROXY";
-    readonly MOCK: "MOCK";
-};
-/**
- * @public
- */
-export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationType];
 /**
  * <p>Represents an <code>HTTP</code>, <code>HTTP_PROXY</code>, <code>AWS</code>, <code>AWS_PROXY</code>, or Mock integration.</p>
  * @public
@@ -1615,6 +1350,13 @@ export interface Integration {
      * @public
      */
     tlsConfig?: TlsConfig | undefined;
+    /**
+     * <p>
+     * The response transfer mode of the integration.
+     * </p>
+     * @public
+     */
+    responseTransferMode?: ResponseTransferMode | undefined;
 }
 /**
  * <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>
@@ -1802,6 +1544,19 @@ export interface CreateRestApiRequest {
      * @public
      */
     disableExecuteApiEndpoint?: boolean | undefined;
+    /**
+     * <p>
+     * The Transport Layer Security (TLS) version + cipher suite for this RestApi.
+     * </p>
+     * @public
+     */
+    securityPolicy?: SecurityPolicy | undefined;
+    /**
+     * <p>
+     * The endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with <code>SecurityPolicy_</code>.</p>
+     * @public
+     */
+    endpointAccessMode?: EndpointAccessMode | undefined;
 }
 /**
  * <p>Represents a REST API.</p>
@@ -1884,6 +1639,33 @@ export interface RestApi {
      * @public
      */
     rootResourceId?: string | undefined;
+    /**
+     * <p>
+     * The Transport Layer Security (TLS) version + cipher suite for this RestApi.
+     * </p>
+     * @public
+     */
+    securityPolicy?: SecurityPolicy | undefined;
+    /**
+     * <p>
+     * The endpoint access mode of the RestApi.
+     * </p>
+     * @public
+     */
+    endpointAccessMode?: EndpointAccessMode | undefined;
+    /**
+     * <p>The ApiStatus of the RestApi.
+     * </p>
+     * @public
+     */
+    apiStatus?: ApiStatus | undefined;
+    /**
+     * <p>
+     * The status message of the RestApi. When the status message is <code>UPDATING</code> you can still invoke it.
+     * </p>
+     * @public
+     */
+    apiStatusMessage?: string | undefined;
 }
 /**
  * <p>Configuration settings of a canary deployment.</p>
@@ -1974,34 +1756,6 @@ export interface CreateStageRequest {
      */
     tags?: Record<string, string> | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const CacheClusterStatus: {
-    readonly AVAILABLE: "AVAILABLE";
-    readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
-    readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
-    readonly FLUSH_IN_PROGRESS: "FLUSH_IN_PROGRESS";
-    readonly NOT_AVAILABLE: "NOT_AVAILABLE";
-};
-/**
- * @public
- */
-export type CacheClusterStatus = (typeof CacheClusterStatus)[keyof typeof CacheClusterStatus];
-/**
- * @public
- * @enum
- */
-export declare const UnauthorizedCacheControlHeaderStrategy: {
-    readonly FAIL_WITH_403: "FAIL_WITH_403";
-    readonly SUCCEED_WITHOUT_RESPONSE_HEADER: "SUCCEED_WITHOUT_RESPONSE_HEADER";
-    readonly SUCCEED_WITH_RESPONSE_HEADER: "SUCCEED_WITH_RESPONSE_HEADER";
-};
-/**
- * @public
- */
-export type UnauthorizedCacheControlHeaderStrategy = (typeof UnauthorizedCacheControlHeaderStrategy)[keyof typeof UnauthorizedCacheControlHeaderStrategy];
 /**
  * <p>Specifies the method setting properties.</p>
  * @public
@@ -2150,19 +1904,6 @@ export interface Stage {
      */
     lastUpdatedDate?: Date | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const QuotaPeriodType: {
-    readonly DAY: "DAY";
-    readonly MONTH: "MONTH";
-    readonly WEEK: "WEEK";
-};
-/**
- * @public
- */
-export type QuotaPeriodType = (typeof QuotaPeriodType)[keyof typeof QuotaPeriodType];
 /**
  * <p>Quotas configured for a usage plan.</p>
  * @public
@@ -2342,20 +2083,6 @@ export interface CreateVpcLinkRequest {
      */
     tags?: Record<string, string> | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const VpcLinkStatus: {
-    readonly AVAILABLE: "AVAILABLE";
-    readonly DELETING: "DELETING";
-    readonly FAILED: "FAILED";
-    readonly PENDING: "PENDING";
-};
-/**
- * @public
- */
-export type VpcLinkStatus = (typeof VpcLinkStatus)[keyof typeof VpcLinkStatus];
 /**
  * <p>An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).</p>
  * @public
@@ -2536,37 +2263,6 @@ export interface DeleteDomainNameAccessAssociationRequest {
      */
     domainNameAccessAssociationArn: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const GatewayResponseType: {
-    readonly ACCESS_DENIED: "ACCESS_DENIED";
-    readonly API_CONFIGURATION_ERROR: "API_CONFIGURATION_ERROR";
-    readonly AUTHORIZER_CONFIGURATION_ERROR: "AUTHORIZER_CONFIGURATION_ERROR";
-    readonly AUTHORIZER_FAILURE: "AUTHORIZER_FAILURE";
-    readonly BAD_REQUEST_BODY: "BAD_REQUEST_BODY";
-    readonly BAD_REQUEST_PARAMETERS: "BAD_REQUEST_PARAMETERS";
-    readonly DEFAULT_4XX: "DEFAULT_4XX";
-    readonly DEFAULT_5XX: "DEFAULT_5XX";
-    readonly EXPIRED_TOKEN: "EXPIRED_TOKEN";
-    readonly INTEGRATION_FAILURE: "INTEGRATION_FAILURE";
-    readonly INTEGRATION_TIMEOUT: "INTEGRATION_TIMEOUT";
-    readonly INVALID_API_KEY: "INVALID_API_KEY";
-    readonly INVALID_SIGNATURE: "INVALID_SIGNATURE";
-    readonly MISSING_AUTHENTICATION_TOKEN: "MISSING_AUTHENTICATION_TOKEN";
-    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
-    readonly REQUEST_TOO_LARGE: "REQUEST_TOO_LARGE";
-    readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
-    readonly THROTTLED: "THROTTLED";
-    readonly UNAUTHORIZED: "UNAUTHORIZED";
-    readonly UNSUPPORTED_MEDIA_TYPE: "UNSUPPORTED_MEDIA_TYPE";
-    readonly WAF_FILTERED: "WAF_FILTERED";
-};
-/**
- * @public
- */
-export type GatewayResponseType = (typeof GatewayResponseType)[keyof typeof GatewayResponseType];
 /**
  * <p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>
  * @public
@@ -3163,18 +2859,6 @@ export interface DocumentationParts {
      */
     position?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const LocationStatusType: {
-    readonly DOCUMENTED: "DOCUMENTED";
-    readonly UNDOCUMENTED: "UNDOCUMENTED";
-};
-/**
- * @public
- */
-export type LocationStatusType = (typeof LocationStatusType)[keyof typeof LocationStatusType];
 /**
  * <p>Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).</p>
  * @public
@@ -3305,18 +2989,6 @@ export interface DomainNameAccessAssociations {
      */
     position?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const ResourceOwner: {
-    readonly OTHER_ACCOUNTS: "OTHER_ACCOUNTS";
-    readonly SELF: "SELF";
-};
-/**
- * @public
- */
-export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner];
 /**
  * @public
  */
@@ -4325,18 +3997,6 @@ export interface DocumentationPartIds {
      */
     warnings?: string[] | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const PutMode: {
-    readonly Merge: "merge";
-    readonly Overwrite: "overwrite";
-};
-/**
- * @public
- */
-export type PutMode = (typeof PutMode)[keyof typeof PutMode];
 /**
  * <p>Import documentation parts from an external (e.g., OpenAPI) definition file. </p>
  * @public
@@ -4526,6 +4186,13 @@ export interface PutIntegrationRequest {
      * @public
      */
     tlsConfig?: TlsConfig | undefined;
+    /**
+     * <p>
+     * The response transfer mode of the integration.
+     * </p>
+     * @public
+     */
+    responseTransferMode?: ResponseTransferMode | undefined;
 }
 /**
  * <p>Represents a put integration response request.</p>
@@ -4929,22 +4596,6 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const Op: {
-    readonly add: "add";
-    readonly copy: "copy";
-    readonly move: "move";
-    readonly remove: "remove";
-    readonly replace: "replace";
-    readonly test: "test";
-};
-/**
- * @public
- */
-export type Op = (typeof Op)[keyof typeof Op];
 /**
  * <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>
  * @public

package/dist-types/ts3.4/index.d.ts

@@ -5,5 +5,7 @@ export { RuntimeExtension } from "./runtimeExtensions";
 export { APIGatewayExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
-export * from "./models";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
 export { APIGatewayServiceException } from "./models/APIGatewayServiceException";