@aws-sdk/client-api-gateway 3.300.0 → 3.303.0

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

@@ -130,17 +130,27 @@ export interface ApiKeys {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ApiKeysFormat {
-    csv = "csv"
-}
+export declare const ApiKeysFormat: {
+    readonly csv: "csv";
+};
 /**
  * @public
  */
-export declare enum ApiKeySourceType {
-    AUTHORIZER = "AUTHORIZER",
-    HEADER = "HEADER"
-}
+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];
 /**
  * @public
  * <p>API stage name of the associated API stage in a usage plan.</p>
@@ -161,12 +171,17 @@ export interface ApiStage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum AuthorizerType {
-    COGNITO_USER_POOLS = "COGNITO_USER_POOLS",
-    REQUEST = "REQUEST",
-    TOKEN = "TOKEN"
-}
+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];
 /**
  * @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>
@@ -471,17 +486,22 @@ export interface CreateBasePathMappingRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum CacheClusterSize {
-    SIZE_0_POINT_5_GB = "0.5",
-    SIZE_118_GB = "118",
-    SIZE_13_POINT_5_GB = "13.5",
-    SIZE_1_POINT_6_GB = "1.6",
-    SIZE_237_GB = "237",
-    SIZE_28_POINT_4_GB = "28.4",
-    SIZE_58_POINT_2_GB = "58.2",
-    SIZE_6_POINT_1_GB = "6.1"
-}
+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];
 /**
  * @public
  * <p>The input configuration for a canary deployment.</p>
@@ -595,21 +615,26 @@ export declare class ServiceUnavailableException extends __BaseException {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum DocumentationPartType {
-    API = "API",
-    AUTHORIZER = "AUTHORIZER",
-    METHOD = "METHOD",
-    MODEL = "MODEL",
-    PATH_PARAMETER = "PATH_PARAMETER",
-    QUERY_PARAMETER = "QUERY_PARAMETER",
-    REQUEST_BODY = "REQUEST_BODY",
-    REQUEST_HEADER = "REQUEST_HEADER",
-    RESOURCE = "RESOURCE",
-    RESPONSE = "RESPONSE",
-    RESPONSE_BODY = "RESPONSE_BODY",
-    RESPONSE_HEADER = "RESPONSE_HEADER"
-}
+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];
 /**
  * @public
  * <p>Specifies the target API entity to which the documentation applies.</p>
@@ -714,12 +739,17 @@ export interface DocumentationVersion {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum EndpointType {
-    EDGE = "EDGE",
-    PRIVATE = "PRIVATE",
-    REGIONAL = "REGIONAL"
-}
+export declare const EndpointType: {
+    readonly EDGE: "EDGE";
+    readonly PRIVATE: "PRIVATE";
+    readonly REGIONAL: "REGIONAL";
+};
+/**
+ * @public
+ */
+export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
 /**
  * @public
  * <p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. </p>
@@ -756,11 +786,16 @@ export interface MutualTlsAuthenticationInput {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum SecurityPolicy {
-    TLS_1_0 = "TLS_1_0",
-    TLS_1_2 = "TLS_1_2"
-}
+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];
 /**
  * @public
  * <p>A request to create a new domain name.</p>
@@ -825,14 +860,19 @@ export interface CreateDomainNameRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum DomainNameStatus {
-    AVAILABLE = "AVAILABLE",
-    PENDING = "PENDING",
-    PENDING_CERTIFICATE_REIMPORT = "PENDING_CERTIFICATE_REIMPORT",
-    PENDING_OWNERSHIP_VERIFICATION = "PENDING_OWNERSHIP_VERIFICATION",
-    UPDATING = "UPDATING"
-}
+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];
 /**
  * @public
  * <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
@@ -1054,18 +1094,28 @@ export interface CreateResourceRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ConnectionType {
-    INTERNET = "INTERNET",
-    VPC_LINK = "VPC_LINK"
-}
+export declare const ConnectionType: {
+    readonly INTERNET: "INTERNET";
+    readonly VPC_LINK: "VPC_LINK";
+};
 /**
  * @public
  */
-export declare enum ContentHandlingStrategy {
-    CONVERT_TO_BINARY = "CONVERT_TO_BINARY",
-    CONVERT_TO_TEXT = "CONVERT_TO_TEXT"
-}
+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];
 /**
  * @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>
@@ -1116,14 +1166,19 @@ export interface TlsConfig {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum IntegrationType {
-    AWS = "AWS",
-    AWS_PROXY = "AWS_PROXY",
-    HTTP = "HTTP",
-    HTTP_PROXY = "HTTP_PROXY",
-    MOCK = "MOCK"
-}
+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];
 /**
  * @public
  * <p>Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.</p>
@@ -1519,22 +1574,32 @@ export interface CreateStageRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum CacheClusterStatus {
-    AVAILABLE = "AVAILABLE",
-    CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
-    DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS",
-    FLUSH_IN_PROGRESS = "FLUSH_IN_PROGRESS",
-    NOT_AVAILABLE = "NOT_AVAILABLE"
-}
+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 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"
-}
+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];
 /**
  * @public
  * <p>Specifies the method setting properties.</p>
@@ -1658,12 +1723,17 @@ export interface Stage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum QuotaPeriodType {
-    DAY = "DAY",
-    MONTH = "MONTH",
-    WEEK = "WEEK"
-}
+export declare const QuotaPeriodType: {
+    readonly DAY: "DAY";
+    readonly MONTH: "MONTH";
+    readonly WEEK: "WEEK";
+};
+/**
+ * @public
+ */
+export type QuotaPeriodType = (typeof QuotaPeriodType)[keyof typeof QuotaPeriodType];
 /**
  * @public
  * <p>Quotas configured for a usage plan.</p>
@@ -1817,13 +1887,18 @@ export interface CreateVpcLinkRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum VpcLinkStatus {
-    AVAILABLE = "AVAILABLE",
-    DELETING = "DELETING",
-    FAILED = "FAILED",
-    PENDING = "PENDING"
-}
+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];
 /**
  * @public
  * <p>An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).</p>
@@ -1961,30 +2036,35 @@ export interface DeleteDomainNameRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum GatewayResponseType {
-    ACCESS_DENIED = "ACCESS_DENIED",
-    API_CONFIGURATION_ERROR = "API_CONFIGURATION_ERROR",
-    AUTHORIZER_CONFIGURATION_ERROR = "AUTHORIZER_CONFIGURATION_ERROR",
-    AUTHORIZER_FAILURE = "AUTHORIZER_FAILURE",
-    BAD_REQUEST_BODY = "BAD_REQUEST_BODY",
-    BAD_REQUEST_PARAMETERS = "BAD_REQUEST_PARAMETERS",
-    DEFAULT_4XX = "DEFAULT_4XX",
-    DEFAULT_5XX = "DEFAULT_5XX",
-    EXPIRED_TOKEN = "EXPIRED_TOKEN",
-    INTEGRATION_FAILURE = "INTEGRATION_FAILURE",
-    INTEGRATION_TIMEOUT = "INTEGRATION_TIMEOUT",
-    INVALID_API_KEY = "INVALID_API_KEY",
-    INVALID_SIGNATURE = "INVALID_SIGNATURE",
-    MISSING_AUTHENTICATION_TOKEN = "MISSING_AUTHENTICATION_TOKEN",
-    QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
-    REQUEST_TOO_LARGE = "REQUEST_TOO_LARGE",
-    RESOURCE_NOT_FOUND = "RESOURCE_NOT_FOUND",
-    THROTTLED = "THROTTLED",
-    UNAUTHORIZED = "UNAUTHORIZED",
-    UNSUPPORTED_MEDIA_TYPE = "UNSUPPORTED_MEDIA_TYPE",
-    WAF_FILTERED = "WAF_FILTERED"
-}
+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];
 /**
  * @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>
@@ -2493,11 +2573,16 @@ export interface DocumentationParts {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum LocationStatusType {
-    DOCUMENTED = "DOCUMENTED",
-    UNDOCUMENTED = "UNDOCUMENTED"
-}
+export declare const LocationStatusType: {
+    readonly DOCUMENTED: "DOCUMENTED";
+    readonly UNDOCUMENTED: "UNDOCUMENTED";
+};
+/**
+ * @public
+ */
+export type LocationStatusType = (typeof LocationStatusType)[keyof typeof LocationStatusType];
 /**
  * @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>
@@ -3434,11 +3519,16 @@ export interface DocumentationPartIds {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum PutMode {
-    Merge = "merge",
-    Overwrite = "overwrite"
-}
+export declare const PutMode: {
+    readonly Merge: "merge";
+    readonly Overwrite: "overwrite";
+};
+/**
+ * @public
+ */
+export type PutMode = (typeof PutMode)[keyof typeof PutMode];
 /**
  * @public
  * <p>Import documentation parts from an external (e.g., OpenAPI) definition file. </p>
@@ -3924,15 +4014,20 @@ export interface UntagResourceRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum Op {
-    add = "add",
-    copy = "copy",
-    move = "move",
-    remove = "remove",
-    replace = "replace",
-    test = "test"
-}
+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];
 /**
  * @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>