import * as mod from "https://aws-api.deno.dev/v0.4/services/apigateway.ts?docs=full";
APIGateway |
AccessLogSettings | Access log settings, including the access log format and access log destination ARN. |
Account | Represents an AWS account that is associated with API Gateway. |
ApiKey | 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. |
ApiKeyIds | The identifier of an ApiKey used in a UsagePlan. |
ApiKeys | Represents a collection of API keys as represented by an ApiKeys resource. |
ApiStage | API stage name of the associated API stage in a usage plan. |
Authorizer | Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. |
Authorizers | Represents a collection of Authorizer resources. |
BasePathMapping | Represents the base path that callers of the API must provide as part of the URL after the domain name. |
BasePathMappings | Represents a collection of BasePathMapping resources. |
CanarySettings | Configuration settings of a canary deployment. |
ClientCertificate | Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint. |
ClientCertificates | Represents a collection of ClientCertificate resources. |
CreateApiKeyRequest | Request to create an ApiKey resource. |
CreateAuthorizerRequest | Request to add a new Authorizer to an existing RestApi resource. |
CreateBasePathMappingRequest | Requests API Gateway to create a new BasePathMapping resource. |
CreateDeploymentRequest | Requests API Gateway to create a Deployment resource. |
CreateDocumentationPartRequest | Creates a new documentation part of a given API. |
CreateDocumentationVersionRequest | Creates a new documentation version of a given API. |
CreateDomainNameRequest | A request to create a new domain name. |
CreateModelRequest | Request to add a new Model to an existing RestApi resource. |
CreateRequestValidatorRequest | Creates a RequestValidator of a given RestApi. |
CreateResourceRequest | Requests API Gateway to create a Resource resource. |
CreateRestApiRequest | The POST Request to add a new RestApi resource to your collection. |
CreateStageRequest | Requests API Gateway to create a Stage resource. |
CreateUsagePlanKeyRequest | The POST request to create a usage plan key for adding an existing API key to a usage plan. |
CreateUsagePlanRequest | 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. |
CreateVpcLinkRequest | 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. |
DeleteApiKeyRequest | A request to delete the ApiKey resource. |
DeleteAuthorizerRequest | Request to delete an existing Authorizer resource. |
DeleteBasePathMappingRequest | A request to delete the BasePathMapping resource. |
DeleteClientCertificateRequest | A request to delete the ClientCertificate resource. |
DeleteDeploymentRequest | Requests API Gateway to delete a Deployment resource. |
DeleteDocumentationPartRequest | Deletes an existing documentation part of an API. |
DeleteDocumentationVersionRequest | Deletes an existing documentation version of an API. |
DeleteDomainNameRequest | A request to delete the DomainName resource. |
DeleteGatewayResponseRequest | Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. |
DeleteIntegrationRequest | Represents a delete integration request. |
DeleteIntegrationResponseRequest | Represents a delete integration response request. |
DeleteMethodRequest | Request to delete an existing Method resource. |
DeleteMethodResponseRequest | A request to delete an existing MethodResponse resource. |
DeleteModelRequest | Request to delete an existing model in an existing RestApi resource. |
DeleteRequestValidatorRequest | Deletes a specified RequestValidator of a given RestApi. |
DeleteResourceRequest | Request to delete a Resource. |
DeleteRestApiRequest | Request to delete the specified API from your collection. |
DeleteStageRequest | Requests API Gateway to delete a Stage resource. |
DeleteUsagePlanKeyRequest | The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan. |
DeleteUsagePlanRequest | The DELETE request to delete a usage plan of a given plan Id. |
DeleteVpcLinkRequest | Deletes an existing VpcLink of a specified identifier. |
Deployment | 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. |
DeploymentCanarySettings | The input configuration for a canary deployment. |
Deployments | 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. |
DocumentationPart | A documentation part for a targeted API entity. |
DocumentationPartIds | A collection of the imported DocumentationPart identifiers. |
DocumentationPartLocation | Specifies the target API entity to which the documentation applies. |
DocumentationParts | The collection of documentation parts of an API. |
DocumentationVersion | A snapshot of the documentation of an API. |
DocumentationVersions | The collection of documentation snapshots of an API. |
DomainName | Represents a custom domain name as a user-friendly host name of an API (RestApi). |
DomainNames | Represents a collection of DomainName resources. |
EndpointConfiguration | The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. |
ExportResponse | The binary blob response to GetExport, which contains the generated SDK. |
FlushStageAuthorizersCacheRequest | Request to flush authorizer cache entries on a specified stage. |
FlushStageCacheRequest | Requests API Gateway to flush a stage's cache. |
GatewayResponse | A gateway response of a given response type and status code, with optional response parameters and mapping templates. |
GatewayResponses | The collection of the GatewayResponse instances of a RestApi as a |
GenerateClientCertificateRequest | A request to generate a ClientCertificate resource. |
GetApiKeyRequest | A request to get information about the current ApiKey resource. |
GetApiKeysRequest | A request to get information about the current ApiKeys resource. |
GetAuthorizerRequest | Request to describe an existing Authorizer resource. |
GetAuthorizersRequest | Request to describe an existing Authorizers resource. |
GetBasePathMappingRequest | Request to describe a BasePathMapping resource. |
GetBasePathMappingsRequest | A request to get information about a collection of BasePathMapping resources. |
GetClientCertificateRequest | A request to get information about the current ClientCertificate resource. |
GetClientCertificatesRequest | A request to get information about a collection of ClientCertificate resources. |
GetDeploymentRequest | Requests API Gateway to get information about a Deployment resource. |
GetDeploymentsRequest | Requests API Gateway to get information about a Deployments collection. |
GetDocumentationPartRequest | Gets a specified documentation part of a given API. |
GetDocumentationPartsRequest | Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets). |
GetDocumentationVersionRequest | Gets a documentation snapshot of an API. |
GetDocumentationVersionsRequest | Gets the documentation versions of an API. |
GetDomainNameRequest | Request to get the name of a DomainName resource. |
GetDomainNamesRequest | Request to describe a collection of DomainName resources. |
GetExportRequest | Request a new export of a RestApi for a particular Stage. |
GetGatewayResponseRequest | Gets a GatewayResponse of a specified response type on the given RestApi. |
GetGatewayResponsesRequest | 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. |
GetIntegrationRequest | Represents a request to get the integration configuration. |
GetIntegrationResponseRequest | Represents a get integration response request. |
GetMethodRequest | Request to describe an existing Method resource. |
GetMethodResponseRequest | Request to describe a MethodResponse resource. |
GetModelRequest | Request to list information about a model in an existing RestApi resource. |
GetModelsRequest | Request to list existing Models defined for a RestApi resource. |
GetModelTemplateRequest | Request to generate a sample mapping template used to transform the payload. |
GetRequestValidatorRequest | Gets a RequestValidator of a given RestApi. |
GetRequestValidatorsRequest | Gets the RequestValidators collection of a given RestApi. |
GetResourceRequest | Request to list information about a resource. |
GetResourcesRequest | Request to list information about a collection of resources. |
GetRestApiRequest | The GET request to list an existing RestApi defined for your collection. |
GetRestApisRequest | The GET request to list existing RestApis defined for your collection. |
GetSdkRequest | Request a new generated client SDK for a RestApi and Stage. |
GetSdkTypeRequest | Get an SdkType instance. |
GetSdkTypesRequest | Get the SdkTypes collection. |
GetStageRequest | Requests API Gateway to get information about a Stage resource. |
GetStagesRequest | Requests API Gateway to get information about one or more Stage resources. |
GetTagsRequest | Gets the Tags collection for a given resource. |
GetUsagePlanKeyRequest | The GET request to get a usage plan key of a given key identifier. |
GetUsagePlanKeysRequest | The GET request to get all the usage plan keys representing the API keys added to a specified usage plan. |
GetUsagePlanRequest | The GET request to get a usage plan of a given plan identifier. |
GetUsagePlansRequest | The GET request to get all the usage plans of the caller's account. |
GetUsageRequest | The GET request to get the usage data of a usage plan in a specified time interval. |
GetVpcLinkRequest | Gets a specified VPC link under the caller's account in a region. |
GetVpcLinksRequest | Gets the VpcLinks collection under the caller's account in a selected region. |
ImportApiKeysRequest | The POST request to import API keys from an external source, such as a CSV-formatted file. |
ImportDocumentationPartsRequest | Import documentation parts from an external (e.g., OpenAPI) definition file. |
ImportRestApiRequest | A POST request to import an API to API Gateway using an input of an API definition file. |
Integration | Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. |
IntegrationResponse | 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. |
Method | 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 the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. |
MethodResponse | 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. |
MethodSetting | Specifies the method setting properties. |
MethodSnapshot | Represents a summary of a Method resource, given a particular date and time. |
Model | Represents the data structure of a method's request or response payload. |
Models | Represents a collection of Model resources. |
MutualTlsAuthentication | 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. |
MutualTlsAuthenticationInput | 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. |
PatchOperation | For more information about supported patch operations, see Patch Operations. |
PutGatewayResponseRequest | Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. |
PutIntegrationRequest | Sets up a method's integration. |
PutIntegrationResponseRequest | Represents a put integration response request. |
PutMethodRequest | Request to add a method to an existing Resource resource. |
PutMethodResponseRequest | Request to add a MethodResponse to an existing Method resource. |
PutRestApiRequest | A PUT request to update an existing API, with external API definitions specified as the request body. |
QuotaSettings | Quotas configured for a usage plan. |
RequestValidator | A set of validation rules for incoming Method requests. |
RequestValidators | A collection of RequestValidator resources of a given RestApi. |
Resource | Represents an API resource. |
Resources | Represents a collection of Resource resources. |
RestApi | Represents a REST API. |
RestApis | 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. |
SdkConfigurationProperty | A configuration property of an SDK type. |
SdkResponse | The binary blob response to GetSdk, which contains the generated SDK. |
SdkType | A type of SDK that API Gateway can generate. |
SdkTypes | The collection of SdkType instances. |
Stage | Represents a unique identifier for a version of a deployed RestApi that is callable by users. |
StageKey | A reference to a unique stage identified in the format |
Stages | A list of Stage resources that are associated with the ApiKey resource. |
TagResourceRequest | Adds or updates a tag on a given resource. |
Tags | The collection of tags. Each tag element is associated with a given resource. |
Template | Represents a mapping template used to transform a payload. |
TestInvokeAuthorizerRequest | Make a request to simulate the invocation of an Authorizer. |
TestInvokeAuthorizerResponse | Represents the response of the test invoke request for a custom Authorizer |
TestInvokeMethodRequest | Make a request to simulate the invocation of a Method. |
TestInvokeMethodResponse | Represents the response of the test invoke request in the HTTP method. |
ThrottleSettings | The API request rate limits. |
TlsConfig | Specifies the TLS configuration for an integration. |
UntagResourceRequest | Removes a tag from a given resource. |
UpdateAccountRequest | Requests API Gateway to change information about the current Account resource. |
UpdateApiKeyRequest | A request to change information about an ApiKey resource. |
UpdateAuthorizerRequest | Request to update an existing Authorizer resource. |
UpdateBasePathMappingRequest | A request to change information about the BasePathMapping resource. |
UpdateClientCertificateRequest | A request to change information about an ClientCertificate resource. |
UpdateDeploymentRequest | Requests API Gateway to change information about a Deployment resource. |
UpdateDocumentationPartRequest | Updates an existing documentation part of a given API. |
UpdateDocumentationVersionRequest | Updates an existing documentation version of an API. |
UpdateDomainNameRequest | A request to change information about the DomainName resource. |
UpdateGatewayResponseRequest | Updates a GatewayResponse of a specified response type on the given RestApi. |
UpdateIntegrationRequest | Represents an update integration request. |
UpdateIntegrationResponseRequest | Represents an update integration response request. |
UpdateMethodRequest | Request to update an existing Method resource. |
UpdateMethodResponseRequest | A request to update an existing MethodResponse resource. |
UpdateModelRequest | Request to update an existing model in an existing RestApi resource. |
UpdateRequestValidatorRequest | Updates a RequestValidator of a given RestApi. |
UpdateResourceRequest | Request to change information about a Resource resource. |
UpdateRestApiRequest | Request to update an existing RestApi resource in your collection. |
UpdateStageRequest | Requests API Gateway to change information about a Stage resource. |
UpdateUsagePlanRequest | The PATCH request to update a usage plan of a given plan Id. |
UpdateUsageRequest | The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key. |
UpdateVpcLinkRequest | Updates an existing VpcLink of a specified identifier. |
Usage | Represents the usage data of a usage plan. |
UsagePlan | 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 Amazon Web Services Budgets to monitor costs and WAF to manage API requests. |
UsagePlanKey | Represents a usage plan key to identify a plan customer. |
UsagePlanKeys | Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys. |
UsagePlans | Represents a collection of usage plans for an AWS account. |
VpcLink | An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). |
VpcLinks | The collection of VPC links under the caller's account in a region. |
ApiKeysFormat | |
ApiKeySourceType | |
AuthorizerType | The authorizer type.
Valid values are |
CacheClusterSize | Returns the size of the CacheCluster. |
CacheClusterStatus | Returns the status of the CacheCluster. |
ConnectionType | |
ContentHandlingStrategy | |
DocumentationPartType | |
DomainNameStatus | |
EndpointType | The endpoint type.
The valid values are |
GatewayResponseType | |
IntegrationType | The integration type.
The valid value is |
LocationStatusType | |
Op | |
PutMode | |
QuotaPeriodType | |
SecurityPolicy | |
UnauthorizedCacheControlHeaderStrategy | |
VpcLinkStatus |