ApiGatewayV2Client
Index > ApiGatewayV2 > ApiGatewayV2Client
Auto-generated documentation for ApiGatewayV2 type annotations stubs module mypy-boto3-apigatewayv2.
ApiGatewayV2Client
Type annotations and code completion for boto3.client("apigatewayv2")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_apigatewayv2.client import ApiGatewayV2Client
def get_apigatewayv2_client() -> ApiGatewayV2Client:
return Session().client("apigatewayv2")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("apigatewayv2").exceptions
structure.
client = boto3.client("apigatewayv2")
try:
do_something(client)
except (
client.AccessDeniedException,
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.NotFoundException,
client.TooManyRequestsException,
) as e:
print(e)
from mypy_boto3_apigatewayv2.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("apigatewayv2").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("apigatewayv2").close
method.
boto3 documentation
create_api
Creates an Api resource.
Type annotations and code completion for boto3.client("apigatewayv2").create_api
method.
boto3 documentation
def create_api(
self,
*,
Name: str,
ProtocolType: ProtocolTypeType, # (1)
ApiKeySelectionExpression: str = ...,
CorsConfiguration: CorsTypeDef = ..., # (2)
CredentialsArn: str = ...,
Description: str = ...,
DisableSchemaValidation: bool = ...,
DisableExecuteApiEndpoint: bool = ...,
RouteKey: str = ...,
RouteSelectionExpression: str = ...,
Tags: Mapping[str, str] = ...,
Target: str = ...,
Version: str = ...,
) -> CreateApiResponseTypeDef: # (3)
...
- See ProtocolTypeType
- See CorsTypeDef
- See CreateApiResponseTypeDef
kwargs: CreateApiRequestRequestTypeDef = { # (1)
"Name": ...,
"ProtocolType": ...,
}
parent.create_api(**kwargs)
create_api_mapping
Creates an API mapping.
Type annotations and code completion for boto3.client("apigatewayv2").create_api_mapping
method.
boto3 documentation
def create_api_mapping(
self,
*,
ApiId: str,
DomainName: str,
Stage: str,
ApiMappingKey: str = ...,
) -> CreateApiMappingResponseTypeDef: # (1)
...
kwargs: CreateApiMappingRequestRequestTypeDef = { # (1)
"ApiId": ...,
"DomainName": ...,
"Stage": ...,
}
parent.create_api_mapping(**kwargs)
create_authorizer
Creates an Authorizer for an API.
Type annotations and code completion for boto3.client("apigatewayv2").create_authorizer
method.
boto3 documentation
def create_authorizer(
self,
*,
ApiId: str,
AuthorizerType: AuthorizerTypeType, # (1)
IdentitySource: Sequence[str],
Name: str,
AuthorizerCredentialsArn: str = ...,
AuthorizerPayloadFormatVersion: str = ...,
AuthorizerResultTtlInSeconds: int = ...,
AuthorizerUri: str = ...,
EnableSimpleResponses: bool = ...,
IdentityValidationExpression: str = ...,
JwtConfiguration: JWTConfigurationTypeDef = ..., # (2)
) -> CreateAuthorizerResponseTypeDef: # (3)
...
kwargs: CreateAuthorizerRequestRequestTypeDef = { # (1)
"ApiId": ...,
"AuthorizerType": ...,
"IdentitySource": ...,
"Name": ...,
}
parent.create_authorizer(**kwargs)
create_deployment
Creates a Deployment for an API.
Type annotations and code completion for boto3.client("apigatewayv2").create_deployment
method.
boto3 documentation
def create_deployment(
self,
*,
ApiId: str,
Description: str = ...,
StageName: str = ...,
) -> CreateDeploymentResponseTypeDef: # (1)
...
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.create_deployment(**kwargs)
create_domain_name
Creates a domain name.
Type annotations and code completion for boto3.client("apigatewayv2").create_domain_name
method.
boto3 documentation
def create_domain_name(
self,
*,
DomainName: str,
DomainNameConfigurations: Sequence[DomainNameConfigurationTypeDef] = ..., # (1)
MutualTlsAuthentication: MutualTlsAuthenticationInputTypeDef = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateDomainNameResponseTypeDef: # (3)
...
- See DomainNameConfigurationTypeDef
- See MutualTlsAuthenticationInputTypeDef
- See CreateDomainNameResponseTypeDef
kwargs: CreateDomainNameRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.create_domain_name(**kwargs)
create_integration
Creates an Integration.
Type annotations and code completion for boto3.client("apigatewayv2").create_integration
method.
boto3 documentation
def create_integration(
self,
*,
ApiId: str,
IntegrationType: IntegrationTypeType, # (1)
ConnectionId: str = ...,
ConnectionType: ConnectionTypeType = ..., # (2)
ContentHandlingStrategy: ContentHandlingStrategyType = ..., # (3)
CredentialsArn: str = ...,
Description: str = ...,
IntegrationMethod: str = ...,
IntegrationSubtype: str = ...,
IntegrationUri: str = ...,
PassthroughBehavior: PassthroughBehaviorType = ..., # (4)
PayloadFormatVersion: str = ...,
RequestParameters: Mapping[str, str] = ...,
RequestTemplates: Mapping[str, str] = ...,
ResponseParameters: Mapping[str, Mapping[str, str]] = ...,
TemplateSelectionExpression: str = ...,
TimeoutInMillis: int = ...,
TlsConfig: TlsConfigInputTypeDef = ..., # (5)
) -> CreateIntegrationResultTypeDef: # (6)
...
- See IntegrationTypeType
- See ConnectionTypeType
- See ContentHandlingStrategyType
- See PassthroughBehaviorType
- See TlsConfigInputTypeDef
- See CreateIntegrationResultTypeDef
kwargs: CreateIntegrationRequestRequestTypeDef = { # (1)
"ApiId": ...,
"IntegrationType": ...,
}
parent.create_integration(**kwargs)
create_integration_response
Creates an IntegrationResponses.
Type annotations and code completion for boto3.client("apigatewayv2").create_integration_response
method.
boto3 documentation
def create_integration_response(
self,
*,
ApiId: str,
IntegrationId: str,
IntegrationResponseKey: str,
ContentHandlingStrategy: ContentHandlingStrategyType = ..., # (1)
ResponseParameters: Mapping[str, str] = ...,
ResponseTemplates: Mapping[str, str] = ...,
TemplateSelectionExpression: str = ...,
) -> CreateIntegrationResponseResponseTypeDef: # (2)
...
kwargs: CreateIntegrationResponseRequestRequestTypeDef = { # (1)
"ApiId": ...,
"IntegrationId": ...,
"IntegrationResponseKey": ...,
}
parent.create_integration_response(**kwargs)
create_model
Creates a Model for an API.
Type annotations and code completion for boto3.client("apigatewayv2").create_model
method.
boto3 documentation
def create_model(
self,
*,
ApiId: str,
Name: str,
Schema: str,
ContentType: str = ...,
Description: str = ...,
) -> CreateModelResponseTypeDef: # (1)
...
kwargs: CreateModelRequestRequestTypeDef = { # (1)
"ApiId": ...,
"Name": ...,
"Schema": ...,
}
parent.create_model(**kwargs)
create_route
Creates a Route for an API.
Type annotations and code completion for boto3.client("apigatewayv2").create_route
method.
boto3 documentation
def create_route(
self,
*,
ApiId: str,
RouteKey: str,
ApiKeyRequired: bool = ...,
AuthorizationScopes: Sequence[str] = ...,
AuthorizationType: AuthorizationTypeType = ..., # (1)
AuthorizerId: str = ...,
ModelSelectionExpression: str = ...,
OperationName: str = ...,
RequestModels: Mapping[str, str] = ...,
RequestParameters: Mapping[str, ParameterConstraintsTypeDef] = ..., # (2)
RouteResponseSelectionExpression: str = ...,
Target: str = ...,
) -> CreateRouteResultTypeDef: # (3)
...
kwargs: CreateRouteRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RouteKey": ...,
}
parent.create_route(**kwargs)
create_route_response
Creates a RouteResponse for a Route.
Type annotations and code completion for boto3.client("apigatewayv2").create_route_response
method.
boto3 documentation
def create_route_response(
self,
*,
ApiId: str,
RouteId: str,
RouteResponseKey: str,
ModelSelectionExpression: str = ...,
ResponseModels: Mapping[str, str] = ...,
ResponseParameters: Mapping[str, ParameterConstraintsTypeDef] = ..., # (1)
) -> CreateRouteResponseResponseTypeDef: # (2)
...
kwargs: CreateRouteResponseRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RouteId": ...,
"RouteResponseKey": ...,
}
parent.create_route_response(**kwargs)
create_stage
Creates a Stage for an API.
Type annotations and code completion for boto3.client("apigatewayv2").create_stage
method.
boto3 documentation
def create_stage(
self,
*,
ApiId: str,
StageName: str,
AccessLogSettings: AccessLogSettingsTypeDef = ..., # (1)
AutoDeploy: bool = ...,
ClientCertificateId: str = ...,
DefaultRouteSettings: RouteSettingsTypeDef = ..., # (2)
DeploymentId: str = ...,
Description: str = ...,
RouteSettings: Mapping[str, RouteSettingsTypeDef] = ..., # (3)
StageVariables: Mapping[str, str] = ...,
Tags: Mapping[str, str] = ...,
) -> CreateStageResponseTypeDef: # (4)
...
- See AccessLogSettingsTypeDef
- See RouteSettingsTypeDef
- See RouteSettingsTypeDef
- See CreateStageResponseTypeDef
kwargs: CreateStageRequestRequestTypeDef = { # (1)
"ApiId": ...,
"StageName": ...,
}
parent.create_stage(**kwargs)
create_vpc_link
Creates a VPC link.
Type annotations and code completion for boto3.client("apigatewayv2").create_vpc_link
method.
boto3 documentation
def create_vpc_link(
self,
*,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str] = ...,
Tags: Mapping[str, str] = ...,
) -> CreateVpcLinkResponseTypeDef: # (1)
...
kwargs: CreateVpcLinkRequestRequestTypeDef = { # (1)
"Name": ...,
"SubnetIds": ...,
}
parent.create_vpc_link(**kwargs)
delete_access_log_settings
Deletes the AccessLogSettings for a Stage.
Type annotations and code completion for boto3.client("apigatewayv2").delete_access_log_settings
method.
boto3 documentation
def delete_access_log_settings(
self,
*,
ApiId: str,
StageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAccessLogSettingsRequestRequestTypeDef = { # (1)
"ApiId": ...,
"StageName": ...,
}
parent.delete_access_log_settings(**kwargs)
delete_api
Deletes an Api resource.
Type annotations and code completion for boto3.client("apigatewayv2").delete_api
method.
boto3 documentation
kwargs: DeleteApiRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.delete_api(**kwargs)
delete_api_mapping
Deletes an API mapping.
Type annotations and code completion for boto3.client("apigatewayv2").delete_api_mapping
method.
boto3 documentation
def delete_api_mapping(
self,
*,
ApiMappingId: str,
DomainName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteApiMappingRequestRequestTypeDef = { # (1)
"ApiMappingId": ...,
"DomainName": ...,
}
parent.delete_api_mapping(**kwargs)
delete_authorizer
Deletes an Authorizer.
Type annotations and code completion for boto3.client("apigatewayv2").delete_authorizer
method.
boto3 documentation
def delete_authorizer(
self,
*,
ApiId: str,
AuthorizerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAuthorizerRequestRequestTypeDef = { # (1)
"ApiId": ...,
"AuthorizerId": ...,
}
parent.delete_authorizer(**kwargs)
delete_cors_configuration
Deletes a CORS configuration.
Type annotations and code completion for boto3.client("apigatewayv2").delete_cors_configuration
method.
boto3 documentation
def delete_cors_configuration(
self,
*,
ApiId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCorsConfigurationRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.delete_cors_configuration(**kwargs)
delete_deployment
Deletes a Deployment.
Type annotations and code completion for boto3.client("apigatewayv2").delete_deployment
method.
boto3 documentation
def delete_deployment(
self,
*,
ApiId: str,
DeploymentId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDeploymentRequestRequestTypeDef = { # (1)
"ApiId": ...,
"DeploymentId": ...,
}
parent.delete_deployment(**kwargs)
delete_domain_name
Deletes a domain name.
Type annotations and code completion for boto3.client("apigatewayv2").delete_domain_name
method.
boto3 documentation
def delete_domain_name(
self,
*,
DomainName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDomainNameRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.delete_domain_name(**kwargs)
delete_integration
Deletes an Integration.
Type annotations and code completion for boto3.client("apigatewayv2").delete_integration
method.
boto3 documentation
def delete_integration(
self,
*,
ApiId: str,
IntegrationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntegrationRequestRequestTypeDef = { # (1)
"ApiId": ...,
"IntegrationId": ...,
}
parent.delete_integration(**kwargs)
delete_integration_response
Deletes an IntegrationResponses.
Type annotations and code completion for boto3.client("apigatewayv2").delete_integration_response
method.
boto3 documentation
def delete_integration_response(
self,
*,
ApiId: str,
IntegrationId: str,
IntegrationResponseId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntegrationResponseRequestRequestTypeDef = { # (1)
"ApiId": ...,
"IntegrationId": ...,
"IntegrationResponseId": ...,
}
parent.delete_integration_response(**kwargs)
delete_model
Deletes a Model.
Type annotations and code completion for boto3.client("apigatewayv2").delete_model
method.
boto3 documentation
def delete_model(
self,
*,
ApiId: str,
ModelId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteModelRequestRequestTypeDef = { # (1)
"ApiId": ...,
"ModelId": ...,
}
parent.delete_model(**kwargs)
delete_route
Deletes a Route.
Type annotations and code completion for boto3.client("apigatewayv2").delete_route
method.
boto3 documentation
def delete_route(
self,
*,
ApiId: str,
RouteId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRouteRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RouteId": ...,
}
parent.delete_route(**kwargs)
delete_route_request_parameter
Deletes a route request parameter.
Type annotations and code completion for boto3.client("apigatewayv2").delete_route_request_parameter
method.
boto3 documentation
def delete_route_request_parameter(
self,
*,
ApiId: str,
RequestParameterKey: str,
RouteId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRouteRequestParameterRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RequestParameterKey": ...,
"RouteId": ...,
}
parent.delete_route_request_parameter(**kwargs)
delete_route_response
Deletes a RouteResponse.
Type annotations and code completion for boto3.client("apigatewayv2").delete_route_response
method.
boto3 documentation
def delete_route_response(
self,
*,
ApiId: str,
RouteId: str,
RouteResponseId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRouteResponseRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RouteId": ...,
"RouteResponseId": ...,
}
parent.delete_route_response(**kwargs)
delete_route_settings
Deletes the RouteSettings for a stage.
Type annotations and code completion for boto3.client("apigatewayv2").delete_route_settings
method.
boto3 documentation
def delete_route_settings(
self,
*,
ApiId: str,
RouteKey: str,
StageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRouteSettingsRequestRequestTypeDef = { # (1)
"ApiId": ...,
"RouteKey": ...,
"StageName": ...,
}
parent.delete_route_settings(**kwargs)
delete_stage
Deletes a Stage.
Type annotations and code completion for boto3.client("apigatewayv2").delete_stage
method.
boto3 documentation
def delete_stage(
self,
*,
ApiId: str,
StageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteStageRequestRequestTypeDef = { # (1)
"ApiId": ...,
"StageName": ...,
}
parent.delete_stage(**kwargs)
delete_vpc_link
Deletes a VPC link.
Type annotations and code completion for boto3.client("apigatewayv2").delete_vpc_link
method.
boto3 documentation
kwargs: DeleteVpcLinkRequestRequestTypeDef = { # (1)
"VpcLinkId": ...,
}
parent.delete_vpc_link(**kwargs)
export_api
See also: AWS API Documentation.
Type annotations and code completion for boto3.client("apigatewayv2").export_api
method.
boto3 documentation
def export_api(
self,
*,
ApiId: str,
OutputType: JSONYAMLType, # (1)
Specification: OAS30Type, # (2)
ExportVersion: str = ...,
IncludeExtensions: bool = ...,
StageName: str = ...,
) -> ExportApiResponseTypeDef: # (3)
...
- See JSONYAMLType
- See OAS30Type
- See ExportApiResponseTypeDef
kwargs: ExportApiRequestRequestTypeDef = { # (1)
"ApiId": ...,
"OutputType": ...,
"Specification": ...,
}
parent.export_api(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("apigatewayv2").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_api
Gets an Api resource.
Type annotations and code completion for boto3.client("apigatewayv2").get_api
method.
boto3 documentation
kwargs: GetApiRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.get_api(**kwargs)
get_api_mapping
Gets an API mapping.
Type annotations and code completion for boto3.client("apigatewayv2").get_api_mapping
method.
boto3 documentation
def get_api_mapping(
self,
*,
ApiMappingId: str,
DomainName: str,
) -> GetApiMappingResponseTypeDef: # (1)
...
kwargs: GetApiMappingRequestRequestTypeDef = { # (1)
"ApiMappingId": ...,
"DomainName": ...,
}
parent.get_api_mapping(**kwargs)
get_api_mappings
Gets API mappings.
Type annotations and code completion for boto3.client("apigatewayv2").get_api_mappings
method.
boto3 documentation
def get_api_mappings(
self,
*,
DomainName: str,
MaxResults: str = ...,
NextToken: str = ...,
) -> GetApiMappingsResponseTypeDef: # (1)
...
kwargs: GetApiMappingsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.get_api_mappings(**kwargs)
get_apis
Gets a collection of Api resources.
Type annotations and code completion for boto3.client("apigatewayv2").get_apis
method.
boto3 documentation
def get_apis(
self,
*,
MaxResults: str = ...,
NextToken: str = ...,
) -> GetApisResponseTypeDef: # (1)
...
kwargs: GetApisRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.get_apis(**kwargs)
get_authorizer
Gets an Authorizer.
Type annotations and code completion for boto3.client("apigatewayv2").get_authorizer
method.
boto3 documentation
def get_authorizer(
self,
*,
ApiId: str,
AuthorizerId: str,
) -> GetAuthorizerResponseTypeDef: # (1)
...
kwargs: GetAuthorizerRequestRequestTypeDef = { # (1)
"ApiId": ...,
"AuthorizerId": ...,
}
parent.get_authorizer(**kwargs)
get_authorizers
Gets the Authorizers for an API.
Type annotations and code completion for boto3.client("apigatewayv2").get_authorizers
method.
boto3 documentation
def get_authorizers(
self,
*,
ApiId: str,
MaxResults: str = ...,
NextToken: str = ...,
) -> GetAuthorizersResponseTypeDef: # (1)
...
kwargs: GetAuthorizersRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.get_authorizers(**kwargs)
get_deployment
Gets a Deployment.
Type annotations and code completion for boto3.client("apigatewayv2").get_deployment
method.
boto3 documentation
def get_deployment(
self,
*,
ApiId: str,
DeploymentId: str,
) -> GetDeploymentResponseTypeDef: # (1)
...
kwargs: GetDeploymentRequestRequestTypeDef = { # (1)
"ApiId": ...,
"DeploymentId": ...,
}
parent.get_deployment(**kwargs)
get_deployments
Gets the Deployments for an API.
Type annotations and code completion for boto3.client("apigatewayv2").get_deployments
method.
boto3 documentation
def get_deployments(
self,
*,
ApiId: str,
MaxResults: str = ...,
NextToken: str = ...,
) -> GetDeploymentsResponseTypeDef: # (1)
...
kwargs: GetDeploymentsRequestRequestTypeDef = { # (1)
"ApiId": ...,
}
parent.get_deployments(**kwargs)
get_domain_name
Gets a domain name.
Type annotations and code completion for boto3.client("apigatewayv2").get_domain_name
method.
boto3 documentation
def get_domain_name(
self,
*,
DomainName: str,
) -> GetDomainNameResponseTypeDef: # (1)
...
kwargs: GetDomainNameRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.get_domain_name(**kwargs)
get_domain_names
Gets the domain names for an AWS account.
Type annotations and code completion for boto3.client("apigatewayv2").get_domain_names
method.
boto3 documentation
def get_domain_names(
self,
*,
MaxResults: str = ...,
NextToken: str = ...,
) -> GetDomainNamesResponseTypeDef: # (1)
...
kwargs: GetDomainNamesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.get_domain_names(**kwargs)
get_integration
Gets an Integration.
Type annotations and code completion for boto3.client("apigatewayv2").get_integration
method.
boto3 documentation
def get_integration(
self,
*,
ApiId: str,
IntegrationId: str,
) -> GetIntegrationResultTypeDef: # (1)
...
kwargs: GetIntegrationRequestRequestTypeDef = { # (1)
"ApiId": ...,
"IntegrationId": ...,
}
parent.get_integration(**kwargs)
get_integration_response
Gets an IntegrationResponses.
Type annotations and code completion for boto3.client("apigatewayv2").get_integration_response
method.
boto3 documentation