- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ApiGatewayV2Client
Amazon API Gateway V2
Installation
npm install @aws-sdk/client-apigatewayv2yarn add @aws-sdk/client-apigatewayv2pnpm add @aws-sdk/client-apigatewayv2ApiGatewayV2Client Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateApiCommand | Creates an Api resource. |
| CreateApiMappingCommand | Creates an API mapping. |
| CreateAuthorizerCommand | Creates an Authorizer for an API. |
| CreateDeploymentCommand | Creates a Deployment for an API. |
| CreateDomainNameCommand | Creates a domain name. |
| CreateIntegrationCommand | Creates an Integration. |
| CreateIntegrationResponseCommand | Creates an IntegrationResponses. |
| CreateModelCommand | Creates a Model for an API. |
| CreateRouteCommand | Creates a Route for an API. |
| CreateRouteResponseCommand | Creates a RouteResponse for a Route. |
| CreateStageCommand | Creates a Stage for an API. |
| CreateVpcLinkCommand | Creates a VPC link. |
| DeleteAccessLogSettingsCommand | Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings. |
| DeleteApiCommand | Deletes an Api resource. |
| DeleteApiMappingCommand | Deletes an API mapping. |
| DeleteAuthorizerCommand | Deletes an Authorizer. |
| DeleteCorsConfigurationCommand | Deletes a CORS configuration. |
| DeleteDeploymentCommand | Deletes a Deployment. |
| DeleteDomainNameCommand | Deletes a domain name. |
| DeleteIntegrationCommand | Deletes an Integration. |
| DeleteIntegrationResponseCommand | Deletes an IntegrationResponses. |
| DeleteModelCommand | Deletes a Model. |
| DeleteRouteCommand | Deletes a Route. |
| DeleteRouteRequestParameterCommand | Deletes a route request parameter. Supported only for WebSocket APIs. |
| DeleteRouteResponseCommand | Deletes a RouteResponse. |
| DeleteRouteSettingsCommand | Deletes the RouteSettings for a stage. |
| DeleteStageCommand | Deletes a Stage. |
| DeleteVpcLinkCommand | Deletes a VPC link. |
| ExportApiCommand | |
| GetApiCommand | Gets an Api resource. |
| GetApiMappingCommand | Gets an API mapping. |
| GetApiMappingsCommand | Gets API mappings. |
| GetApisCommand | Gets a collection of Api resources. |
| GetAuthorizerCommand | Gets an Authorizer. |
| GetAuthorizersCommand | Gets the Authorizers for an API. |
| GetDeploymentCommand | Gets a Deployment. |
| GetDeploymentsCommand | Gets the Deployments for an API. |
| GetDomainNameCommand | Gets a domain name. |
| GetDomainNamesCommand | Gets the domain names for an AWS account. |
| GetIntegrationCommand | Gets an Integration. |
| GetIntegrationResponseCommand | Gets an IntegrationResponses. |
| GetIntegrationResponsesCommand | Gets the IntegrationResponses for an Integration. |
| GetIntegrationsCommand | Gets the Integrations for an API. |
| GetModelCommand | Gets a Model. |
| GetModelTemplateCommand | Gets a model template. |
| GetModelsCommand | Gets the Models for an API. |
| GetRouteCommand | Gets a Route. |
| GetRouteResponseCommand | Gets a RouteResponse. |
| GetRouteResponsesCommand | Gets the RouteResponses for a Route. |
| GetRoutesCommand | Gets the Routes for an API. |
| GetStageCommand | Gets a Stage. |
| GetStagesCommand | Gets the Stages for an API. |
| GetTagsCommand | Gets a collection of Tag resources. |
| GetVpcLinkCommand | Gets a VPC link. |
| GetVpcLinksCommand | Gets a collection of VPC links. |
| ImportApiCommand | Imports an API. |
| ReimportApiCommand | Puts an Api resource. |
| ResetAuthorizersCacheCommand | Resets all authorizer cache entries on a stage. Supported only for HTTP APIs. |
| TagResourceCommand | Creates a new Tag resource to represent a tag. |
| UntagResourceCommand | Deletes a Tag. |
| UpdateApiCommand | Updates an Api resource. |
| UpdateApiMappingCommand | The API mapping. |
| UpdateAuthorizerCommand | Updates an Authorizer. |
| UpdateDeploymentCommand | Updates a Deployment. |
| UpdateDomainNameCommand | Updates a domain name. |
| UpdateIntegrationCommand | Updates an Integration. |
| UpdateIntegrationResponseCommand | Updates an IntegrationResponses. |
| UpdateModelCommand | Updates a Model. |
| UpdateRouteCommand | Updates a Route. |
| UpdateRouteResponseCommand | Updates a RouteResponse. |
| UpdateStageCommand | Updates a Stage. |
| UpdateVpcLinkCommand | Updates a VPC link. |
ApiGatewayV2Client Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ApiGatewayV2ClientConfig