Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ApiGatewayV2

import { ApiGatewayV2 } from "https://aws-api.deno.dev/v0.3/services/apigatewayv2.ts?docs=full";
class ApiGatewayV2 {
constructor(apiFactory: client.ApiFactory);
async createApi(params: CreateApiRequest, opts?: client.RequestOptions): Promise<CreateApiResponse>;
async createApiMapping(params: CreateApiMappingRequest, opts?: client.RequestOptions): Promise<CreateApiMappingResponse>;
async createAuthorizer(params: CreateAuthorizerRequest, opts?: client.RequestOptions): Promise<CreateAuthorizerResponse>;
async createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<CreateDeploymentResponse>;
async createDomainName(params: CreateDomainNameRequest, opts?: client.RequestOptions): Promise<CreateDomainNameResponse>;
async createIntegration(params: CreateIntegrationRequest, opts?: client.RequestOptions): Promise<CreateIntegrationResult>;
async createIntegrationResponse(params: CreateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<CreateIntegrationResponseResponse>;
async createModel(params: CreateModelRequest, opts?: client.RequestOptions): Promise<CreateModelResponse>;
async createRoute(params: CreateRouteRequest, opts?: client.RequestOptions): Promise<CreateRouteResult>;
async createRouteResponse(params: CreateRouteResponseRequest, opts?: client.RequestOptions): Promise<CreateRouteResponseResponse>;
async createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResponse>;
async createVpcLink(params: CreateVpcLinkRequest, opts?: client.RequestOptions): Promise<CreateVpcLinkResponse>;
async deleteAccessLogSettings(params: DeleteAccessLogSettingsRequest, opts?: client.RequestOptions): Promise<void>;
async deleteApi(params: DeleteApiRequest, opts?: client.RequestOptions): Promise<void>;
async deleteApiMapping(params: DeleteApiMappingRequest, opts?: client.RequestOptions): Promise<void>;
async deleteAuthorizer(params: DeleteAuthorizerRequest, opts?: client.RequestOptions): Promise<void>;
async deleteCorsConfiguration(params: DeleteCorsConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDeployment(params: DeleteDeploymentRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>;
async deleteIntegration(params: DeleteIntegrationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteIntegrationResponse(params: DeleteIntegrationResponseRequest, opts?: client.RequestOptions): Promise<void>;
async deleteModel(params: DeleteModelRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRoute(params: DeleteRouteRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRouteRequestParameter(params: DeleteRouteRequestParameterRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRouteResponse(params: DeleteRouteResponseRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRouteSettings(params: DeleteRouteSettingsRequest, opts?: client.RequestOptions): Promise<void>;
async deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>;
async deleteVpcLink(params: DeleteVpcLinkRequest, opts?: client.RequestOptions): Promise<void>;
async exportApi(params: ExportApiRequest, opts?: client.RequestOptions): Promise<ExportApiResponse>;
async getApi(params: GetApiRequest, opts?: client.RequestOptions): Promise<GetApiResponse>;
async getApiMapping(params: GetApiMappingRequest, opts?: client.RequestOptions): Promise<GetApiMappingResponse>;
async getApiMappings(params: GetApiMappingsRequest, opts?: client.RequestOptions): Promise<GetApiMappingsResponse>;
async getApis(params?: GetApisRequest, opts?: client.RequestOptions): Promise<GetApisResponse>;
async getAuthorizer(params: GetAuthorizerRequest, opts?: client.RequestOptions): Promise<GetAuthorizerResponse>;
async getAuthorizers(params: GetAuthorizersRequest, opts?: client.RequestOptions): Promise<GetAuthorizersResponse>;
async getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<GetDeploymentResponse>;
async getDeployments(params: GetDeploymentsRequest, opts?: client.RequestOptions): Promise<GetDeploymentsResponse>;
async getDomainName(params: GetDomainNameRequest, opts?: client.RequestOptions): Promise<GetDomainNameResponse>;
async getDomainNames(params?: GetDomainNamesRequest, opts?: client.RequestOptions): Promise<GetDomainNamesResponse>;
async getIntegration(params: GetIntegrationRequest, opts?: client.RequestOptions): Promise<GetIntegrationResult>;
async getIntegrationResponse(params: GetIntegrationResponseRequest, opts?: client.RequestOptions): Promise<GetIntegrationResponseResponse>;
async getIntegrationResponses(params: GetIntegrationResponsesRequest, opts?: client.RequestOptions): Promise<GetIntegrationResponsesResponse>;
async getIntegrations(params: GetIntegrationsRequest, opts?: client.RequestOptions): Promise<GetIntegrationsResponse>;
async getModel(params: GetModelRequest, opts?: client.RequestOptions): Promise<GetModelResponse>;
async getModels(params: GetModelsRequest, opts?: client.RequestOptions): Promise<GetModelsResponse>;
async getModelTemplate(params: GetModelTemplateRequest, opts?: client.RequestOptions): Promise<GetModelTemplateResponse>;
async getRoute(params: GetRouteRequest, opts?: client.RequestOptions): Promise<GetRouteResult>;
async getRouteResponse(params: GetRouteResponseRequest, opts?: client.RequestOptions): Promise<GetRouteResponseResponse>;
async getRouteResponses(params: GetRouteResponsesRequest, opts?: client.RequestOptions): Promise<GetRouteResponsesResponse>;
async getRoutes(params: GetRoutesRequest, opts?: client.RequestOptions): Promise<GetRoutesResponse>;
async getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResponse>;
async getStages(params: GetStagesRequest, opts?: client.RequestOptions): Promise<GetStagesResponse>;
async getTags(params: GetTagsRequest, opts?: client.RequestOptions): Promise<GetTagsResponse>;
async getVpcLink(params: GetVpcLinkRequest, opts?: client.RequestOptions): Promise<GetVpcLinkResponse>;
async getVpcLinks(params?: GetVpcLinksRequest, opts?: client.RequestOptions): Promise<GetVpcLinksResponse>;
async importApi(params: ImportApiRequest, opts?: client.RequestOptions): Promise<ImportApiResponse>;
async reimportApi(params: ReimportApiRequest, opts?: client.RequestOptions): Promise<ReimportApiResponse>;
async resetAuthorizersCache(params: ResetAuthorizersCacheRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateApi(params: UpdateApiRequest, opts?: client.RequestOptions): Promise<UpdateApiResponse>;
async updateApiMapping(params: UpdateApiMappingRequest, opts?: client.RequestOptions): Promise<UpdateApiMappingResponse>;
async updateAuthorizer(params: UpdateAuthorizerRequest, opts?: client.RequestOptions): Promise<UpdateAuthorizerResponse>;
async updateDeployment(params: UpdateDeploymentRequest, opts?: client.RequestOptions): Promise<UpdateDeploymentResponse>;
async updateDomainName(params: UpdateDomainNameRequest, opts?: client.RequestOptions): Promise<UpdateDomainNameResponse>;
async updateIntegration(params: UpdateIntegrationRequest, opts?: client.RequestOptions): Promise<UpdateIntegrationResult>;
async updateIntegrationResponse(params: UpdateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<UpdateIntegrationResponseResponse>;
async updateModel(params: UpdateModelRequest, opts?: client.RequestOptions): Promise<UpdateModelResponse>;
async updateRoute(params: UpdateRouteRequest, opts?: client.RequestOptions): Promise<UpdateRouteResult>;
async updateRouteResponse(params: UpdateRouteResponseRequest, opts?: client.RequestOptions): Promise<UpdateRouteResponseResponse>;
async updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResponse>;
async updateVpcLink(params: UpdateVpcLinkRequest, opts?: client.RequestOptions): Promise<UpdateVpcLinkResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ApiGatewayV2(apiFactory: client.ApiFactory)
[src]

§Methods

§
createApi(params: CreateApiRequest, opts?: client.RequestOptions): Promise<CreateApiResponse>
[src]

Creates an Api resource.

§
createApiMapping(params: CreateApiMappingRequest, opts?: client.RequestOptions): Promise<CreateApiMappingResponse>
[src]

Creates an API mapping.

§
createAuthorizer(params: CreateAuthorizerRequest, opts?: client.RequestOptions): Promise<CreateAuthorizerResponse>
[src]

Creates an Authorizer for an API.

§
createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<CreateDeploymentResponse>
[src]

Creates a Deployment for an API.

§
createDomainName(params: CreateDomainNameRequest, opts?: client.RequestOptions): Promise<CreateDomainNameResponse>
[src]

Creates a domain name.

§
createIntegration(params: CreateIntegrationRequest, opts?: client.RequestOptions): Promise<CreateIntegrationResult>
[src]

Creates an Integration.

§
createIntegrationResponse(params: CreateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<CreateIntegrationResponseResponse>
[src]

Creates an IntegrationResponses.

§
createModel(params: CreateModelRequest, opts?: client.RequestOptions): Promise<CreateModelResponse>
[src]

Creates a Model for an API.

§
createRoute(params: CreateRouteRequest, opts?: client.RequestOptions): Promise<CreateRouteResult>
[src]

Creates a Route for an API.

§
createRouteResponse(params: CreateRouteResponseRequest, opts?: client.RequestOptions): Promise<CreateRouteResponseResponse>
[src]

Creates a RouteResponse for a Route.

§
createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResponse>
[src]

Creates a Stage for an API.

§
deleteAccessLogSettings(params: DeleteAccessLogSettingsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

§
deleteApi(params: DeleteApiRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an Api resource.

§
deleteApiMapping(params: DeleteApiMappingRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an API mapping.

§
deleteAuthorizer(params: DeleteAuthorizerRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an Authorizer.

§
deleteCorsConfiguration(params: DeleteCorsConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a CORS configuration.

§
deleteDeployment(params: DeleteDeploymentRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Deployment.

§
deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a domain name.

§
deleteIntegration(params: DeleteIntegrationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an Integration.

§
deleteIntegrationResponse(params: DeleteIntegrationResponseRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an IntegrationResponses.

§
deleteModel(params: DeleteModelRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Model.

§
deleteRoute(params: DeleteRouteRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Route.

§
deleteRouteRequestParameter(params: DeleteRouteRequestParameterRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a route request parameter.

§
deleteRouteResponse(params: DeleteRouteResponseRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a RouteResponse.

§
deleteRouteSettings(params: DeleteRouteSettingsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the RouteSettings for a stage.

§
deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Stage.

§
getApi(params: GetApiRequest, opts?: client.RequestOptions): Promise<GetApiResponse>
[src]

Gets an Api resource.

§
getApiMapping(params: GetApiMappingRequest, opts?: client.RequestOptions): Promise<GetApiMappingResponse>
[src]

Gets an API mapping.

§
getApiMappings(params: GetApiMappingsRequest, opts?: client.RequestOptions): Promise<GetApiMappingsResponse>
[src]

Gets API mappings.

§
getApis(params?: GetApisRequest, opts?: client.RequestOptions): Promise<GetApisResponse>
[src]

Gets a collection of Api resources.

§
getAuthorizer(params: GetAuthorizerRequest, opts?: client.RequestOptions): Promise<GetAuthorizerResponse>
[src]

Gets an Authorizer.

§
getAuthorizers(params: GetAuthorizersRequest, opts?: client.RequestOptions): Promise<GetAuthorizersResponse>
[src]

Gets the Authorizers for an API.

§
getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<GetDeploymentResponse>
[src]

Gets a Deployment.

§
getDeployments(params: GetDeploymentsRequest, opts?: client.RequestOptions): Promise<GetDeploymentsResponse>
[src]

Gets the Deployments for an API.

§
getDomainName(params: GetDomainNameRequest, opts?: client.RequestOptions): Promise<GetDomainNameResponse>
[src]

Gets a domain name.

§
getDomainNames(params?: GetDomainNamesRequest, opts?: client.RequestOptions): Promise<GetDomainNamesResponse>
[src]

Gets the domain names for an AWS account.

§
getIntegration(params: GetIntegrationRequest, opts?: client.RequestOptions): Promise<GetIntegrationResult>
[src]

Gets an Integration.

§
getIntegrationResponse(params: GetIntegrationResponseRequest, opts?: client.RequestOptions): Promise<GetIntegrationResponseResponse>
[src]

Gets an IntegrationResponses.

§
getIntegrationResponses(params: GetIntegrationResponsesRequest, opts?: client.RequestOptions): Promise<GetIntegrationResponsesResponse>
[src]

Gets the IntegrationResponses for an Integration.

§
getIntegrations(params: GetIntegrationsRequest, opts?: client.RequestOptions): Promise<GetIntegrationsResponse>
[src]

Gets the Integrations for an API.

§
getModel(params: GetModelRequest, opts?: client.RequestOptions): Promise<GetModelResponse>
[src]

Gets a Model.

§
getModels(params: GetModelsRequest, opts?: client.RequestOptions): Promise<GetModelsResponse>
[src]

Gets the Models for an API.

§
getModelTemplate(params: GetModelTemplateRequest, opts?: client.RequestOptions): Promise<GetModelTemplateResponse>
[src]

Gets a model template.

§
getRoute(params: GetRouteRequest, opts?: client.RequestOptions): Promise<GetRouteResult>
[src]

Gets a Route.

§
getRouteResponse(params: GetRouteResponseRequest, opts?: client.RequestOptions): Promise<GetRouteResponseResponse>
[src]

Gets a RouteResponse.

§
getRouteResponses(params: GetRouteResponsesRequest, opts?: client.RequestOptions): Promise<GetRouteResponsesResponse>
[src]

Gets the RouteResponses for a Route.

§
getRoutes(params: GetRoutesRequest, opts?: client.RequestOptions): Promise<GetRoutesResponse>
[src]

Gets the Routes for an API.

§
getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResponse>
[src]

Gets a Stage.

§
getStages(params: GetStagesRequest, opts?: client.RequestOptions): Promise<GetStagesResponse>
[src]

Gets the Stages for an API.

§
getTags(params: GetTagsRequest, opts?: client.RequestOptions): Promise<GetTagsResponse>
[src]

Gets a collection of Tag resources.

§
importApi(params: ImportApiRequest, opts?: client.RequestOptions): Promise<ImportApiResponse>
[src]

Imports an API.

§
reimportApi(params: ReimportApiRequest, opts?: client.RequestOptions): Promise<ReimportApiResponse>
[src]

Puts an Api resource.

§
resetAuthorizersCache(params: ResetAuthorizersCacheRequest, opts?: client.RequestOptions): Promise<void>
[src]

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates a new Tag resource to represent a tag.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Tag.

§
updateApi(params: UpdateApiRequest, opts?: client.RequestOptions): Promise<UpdateApiResponse>
[src]

Updates an Api resource.

§
updateApiMapping(params: UpdateApiMappingRequest, opts?: client.RequestOptions): Promise<UpdateApiMappingResponse>
[src]

The API mapping.

§
updateAuthorizer(params: UpdateAuthorizerRequest, opts?: client.RequestOptions): Promise<UpdateAuthorizerResponse>
[src]

Updates an Authorizer.

§
updateDeployment(params: UpdateDeploymentRequest, opts?: client.RequestOptions): Promise<UpdateDeploymentResponse>
[src]

Updates a Deployment.

§
updateDomainName(params: UpdateDomainNameRequest, opts?: client.RequestOptions): Promise<UpdateDomainNameResponse>
[src]

Updates a domain name.

§
updateIntegration(params: UpdateIntegrationRequest, opts?: client.RequestOptions): Promise<UpdateIntegrationResult>
[src]

Updates an Integration.

§
updateIntegrationResponse(params: UpdateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<UpdateIntegrationResponseResponse>
[src]

Updates an IntegrationResponses.

§
updateModel(params: UpdateModelRequest, opts?: client.RequestOptions): Promise<UpdateModelResponse>
[src]

Updates a Model.

§
updateRoute(params: UpdateRouteRequest, opts?: client.RequestOptions): Promise<UpdateRouteResult>
[src]

Updates a Route.

§
updateRouteResponse(params: UpdateRouteResponseRequest, opts?: client.RequestOptions): Promise<UpdateRouteResponseResponse>
[src]

Updates a RouteResponse.

§
updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResponse>
[src]

Updates a Stage.

§Static Properties