Skip to content

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

# ApiGatewayV2Client usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("apigatewayv2")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.NotFoundException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("apigatewayv2").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_api#

Creates an Api resource.

Type annotations and code completion for boto3.client("apigatewayv2").create_api method. boto3 documentation

# create_api method definition

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)
    ...
  1. See ProtocolTypeType
  2. See CorsTypeDef
  3. See CreateApiResponseTypeDef 
# create_api method usage example with argument unpacking

kwargs: CreateApiRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ProtocolType": ...,
}

parent.create_api(**kwargs)
  1. See CreateApiRequestRequestTypeDef

create_api_mapping#

Creates an API mapping.

Type annotations and code completion for boto3.client("apigatewayv2").create_api_mapping method. boto3 documentation

# create_api_mapping method definition

def create_api_mapping(
    self,
    *,
    ApiId: str,
    DomainName: str,
    Stage: str,
    ApiMappingKey: str = ...,
) -> CreateApiMappingResponseTypeDef:  # (1)
    ...
  1. See CreateApiMappingResponseTypeDef 
# create_api_mapping method usage example with argument unpacking

kwargs: CreateApiMappingRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "DomainName": ...,
    "Stage": ...,
}

parent.create_api_mapping(**kwargs)
  1. See CreateApiMappingRequestRequestTypeDef

create_authorizer#

Creates an Authorizer for an API.

Type annotations and code completion for boto3.client("apigatewayv2").create_authorizer method. boto3 documentation

# create_authorizer method definition

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)
    ...
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef
  3. See CreateAuthorizerResponseTypeDef 
# create_authorizer method usage example with argument unpacking

kwargs: CreateAuthorizerRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "AuthorizerType": ...,
    "IdentitySource": ...,
    "Name": ...,
}

parent.create_authorizer(**kwargs)
  1. See CreateAuthorizerRequestRequestTypeDef

create_deployment#

Creates a Deployment for an API.

Type annotations and code completion for boto3.client("apigatewayv2").create_deployment method. boto3 documentation

# create_deployment method definition

def create_deployment(
    self,
    *,
    ApiId: str,
    Description: str = ...,
    StageName: str = ...,
) -> CreateDeploymentResponseTypeDef:  # (1)
    ...
  1. See CreateDeploymentResponseTypeDef 
# create_deployment method usage example with argument unpacking

kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentRequestRequestTypeDef

create_domain_name#

Creates a domain name.

Type annotations and code completion for boto3.client("apigatewayv2").create_domain_name method. boto3 documentation

# create_domain_name method definition

def create_domain_name(
    self,
    *,
    DomainName: str,
    DomainNameConfigurations: Sequence[DomainNameConfigurationTypeDef] = ...,  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationInputTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateDomainNameResponseTypeDef:  # (3)
    ...
  1. See DomainNameConfigurationTypeDef
  2. See MutualTlsAuthenticationInputTypeDef
  3. See CreateDomainNameResponseTypeDef 
# create_domain_name method usage example with argument unpacking

kwargs: CreateDomainNameRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.create_domain_name(**kwargs)
  1. See CreateDomainNameRequestRequestTypeDef

create_integration#

Creates an Integration.

Type annotations and code completion for boto3.client("apigatewayv2").create_integration method. boto3 documentation

# create_integration method definition

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)
    ...
  1. See IntegrationTypeType
  2. See ConnectionTypeType
  3. See ContentHandlingStrategyType
  4. See PassthroughBehaviorType
  5. See TlsConfigInputTypeDef
  6. See CreateIntegrationResultTypeDef 
# create_integration method usage example with argument unpacking

kwargs: CreateIntegrationRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationType": ...,
}

parent.create_integration(**kwargs)
  1. See CreateIntegrationRequestRequestTypeDef

create_integration_response#

Creates an IntegrationResponses.

Type annotations and code completion for boto3.client("apigatewayv2").create_integration_response method. boto3 documentation

# create_integration_response method definition

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)
    ...
  1. See ContentHandlingStrategyType
  2. See CreateIntegrationResponseResponseTypeDef 
# create_integration_response method usage example with argument unpacking

kwargs: CreateIntegrationResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
    "IntegrationResponseKey": ...,
}

parent.create_integration_response(**kwargs)
  1. See CreateIntegrationResponseRequestRequestTypeDef

create_model#

Creates a Model for an API.

Type annotations and code completion for boto3.client("apigatewayv2").create_model method. boto3 documentation

# create_model method definition

def create_model(
    self,
    *,
    ApiId: str,
    Name: str,
    Schema: str,
    ContentType: str = ...,
    Description: str = ...,
) -> CreateModelResponseTypeDef:  # (1)
    ...
  1. See CreateModelResponseTypeDef 
# create_model method usage example with argument unpacking

kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "Name": ...,
    "Schema": ...,
}

parent.create_model(**kwargs)
  1. See CreateModelRequestRequestTypeDef

create_route#

Creates a Route for an API.

Type annotations and code completion for boto3.client("apigatewayv2").create_route method. boto3 documentation

# create_route method definition

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)
    ...
  1. See AuthorizationTypeType
  2. See ParameterConstraintsTypeDef
  3. See CreateRouteResultTypeDef 
# create_route method usage example with argument unpacking

kwargs: CreateRouteRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteKey": ...,
}

parent.create_route(**kwargs)
  1. See CreateRouteRequestRequestTypeDef

create_route_response#

Creates a RouteResponse for a Route.

Type annotations and code completion for boto3.client("apigatewayv2").create_route_response method. boto3 documentation

# create_route_response method definition

def create_route_response(
    self,
    *,
    ApiId: str,
    RouteId: str,
    RouteResponseKey: str,
    ModelSelectionExpression: str = ...,
    ResponseModels: Mapping[str, str] = ...,
    ResponseParameters: Mapping[str, ParameterConstraintsTypeDef] = ...,  # (1)
) -> CreateRouteResponseResponseTypeDef:  # (2)
    ...
  1. See ParameterConstraintsTypeDef
  2. See CreateRouteResponseResponseTypeDef 
# create_route_response method usage example with argument unpacking

kwargs: CreateRouteResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
    "RouteResponseKey": ...,
}

parent.create_route_response(**kwargs)
  1. See CreateRouteResponseRequestRequestTypeDef

create_stage#

Creates a Stage for an API.

Type annotations and code completion for boto3.client("apigatewayv2").create_stage method. boto3 documentation

# create_stage method definition

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)
    ...
  1. See AccessLogSettingsTypeDef
  2. See RouteSettingsTypeDef
  3. See RouteSettingsTypeDef
  4. See CreateStageResponseTypeDef 
# create_stage method usage example with argument unpacking

kwargs: CreateStageRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "StageName": ...,
}

parent.create_stage(**kwargs)
  1. See CreateStageRequestRequestTypeDef

Creates a VPC link.

Type annotations and code completion for boto3.client("apigatewayv2").create_vpc_link method. boto3 documentation

# create_vpc_link method definition

def create_vpc_link(
    self,
    *,
    Name: str,
    SubnetIds: Sequence[str],
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateVpcLinkResponseTypeDef:  # (1)
    ...
  1. See CreateVpcLinkResponseTypeDef 
# create_vpc_link method usage example with argument unpacking

kwargs: CreateVpcLinkRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SubnetIds": ...,
}

parent.create_vpc_link(**kwargs)
  1. See CreateVpcLinkRequestRequestTypeDef

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

# delete_access_log_settings method definition

def delete_access_log_settings(
    self,
    *,
    ApiId: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_access_log_settings method usage example with argument unpacking

kwargs: DeleteAccessLogSettingsRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "StageName": ...,
}

parent.delete_access_log_settings(**kwargs)
  1. See DeleteAccessLogSettingsRequestRequestTypeDef

delete_api#

Deletes an Api resource.

Type annotations and code completion for boto3.client("apigatewayv2").delete_api method. boto3 documentation

# delete_api method definition

def delete_api(
    self,
    *,
    ApiId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_api method usage example with argument unpacking

kwargs: DeleteApiRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.delete_api(**kwargs)
  1. See DeleteApiRequestRequestTypeDef

delete_api_mapping#

Deletes an API mapping.

Type annotations and code completion for boto3.client("apigatewayv2").delete_api_mapping method. boto3 documentation

# delete_api_mapping method definition

def delete_api_mapping(
    self,
    *,
    ApiMappingId: str,
    DomainName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_api_mapping method usage example with argument unpacking

kwargs: DeleteApiMappingRequestRequestTypeDef = {  # (1)
    "ApiMappingId": ...,
    "DomainName": ...,
}

parent.delete_api_mapping(**kwargs)
  1. See DeleteApiMappingRequestRequestTypeDef

delete_authorizer#

Deletes an Authorizer.

Type annotations and code completion for boto3.client("apigatewayv2").delete_authorizer method. boto3 documentation

# delete_authorizer method definition

def delete_authorizer(
    self,
    *,
    ApiId: str,
    AuthorizerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_authorizer method usage example with argument unpacking

kwargs: DeleteAuthorizerRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "AuthorizerId": ...,
}

parent.delete_authorizer(**kwargs)
  1. See DeleteAuthorizerRequestRequestTypeDef

delete_cors_configuration#

Deletes a CORS configuration.

Type annotations and code completion for boto3.client("apigatewayv2").delete_cors_configuration method. boto3 documentation

# delete_cors_configuration method definition

def delete_cors_configuration(
    self,
    *,
    ApiId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_cors_configuration method usage example with argument unpacking

kwargs: DeleteCorsConfigurationRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.delete_cors_configuration(**kwargs)
  1. See DeleteCorsConfigurationRequestRequestTypeDef

delete_deployment#

Deletes a Deployment.

Type annotations and code completion for boto3.client("apigatewayv2").delete_deployment method. boto3 documentation

# delete_deployment method definition

def delete_deployment(
    self,
    *,
    ApiId: str,
    DeploymentId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_deployment method usage example with argument unpacking

kwargs: DeleteDeploymentRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "DeploymentId": ...,
}

parent.delete_deployment(**kwargs)
  1. See DeleteDeploymentRequestRequestTypeDef

delete_domain_name#

Deletes a domain name.

Type annotations and code completion for boto3.client("apigatewayv2").delete_domain_name method. boto3 documentation

# delete_domain_name method definition

def delete_domain_name(
    self,
    *,
    DomainName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_domain_name method usage example with argument unpacking

kwargs: DeleteDomainNameRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.delete_domain_name(**kwargs)
  1. See DeleteDomainNameRequestRequestTypeDef

delete_integration#

Deletes an Integration.

Type annotations and code completion for boto3.client("apigatewayv2").delete_integration method. boto3 documentation

# delete_integration method definition

def delete_integration(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_integration method usage example with argument unpacking

kwargs: DeleteIntegrationRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
}

parent.delete_integration(**kwargs)
  1. See DeleteIntegrationRequestRequestTypeDef

delete_integration_response#

Deletes an IntegrationResponses.

Type annotations and code completion for boto3.client("apigatewayv2").delete_integration_response method. boto3 documentation

# delete_integration_response method definition

def delete_integration_response(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
    IntegrationResponseId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_integration_response method usage example with argument unpacking

kwargs: DeleteIntegrationResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
    "IntegrationResponseId": ...,
}

parent.delete_integration_response(**kwargs)
  1. See DeleteIntegrationResponseRequestRequestTypeDef

delete_model#

Deletes a Model.

Type annotations and code completion for boto3.client("apigatewayv2").delete_model method. boto3 documentation

# delete_model method definition

def delete_model(
    self,
    *,
    ApiId: str,
    ModelId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_model method usage example with argument unpacking

kwargs: DeleteModelRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "ModelId": ...,
}

parent.delete_model(**kwargs)
  1. See DeleteModelRequestRequestTypeDef

delete_route#

Deletes a Route.

Type annotations and code completion for boto3.client("apigatewayv2").delete_route method. boto3 documentation

# delete_route method definition

def delete_route(
    self,
    *,
    ApiId: str,
    RouteId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_route method usage example with argument unpacking

kwargs: DeleteRouteRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
}

parent.delete_route(**kwargs)
  1. See DeleteRouteRequestRequestTypeDef

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

# delete_route_request_parameter method definition

def delete_route_request_parameter(
    self,
    *,
    ApiId: str,
    RequestParameterKey: str,
    RouteId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_route_request_parameter method usage example with argument unpacking

kwargs: DeleteRouteRequestParameterRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RequestParameterKey": ...,
    "RouteId": ...,
}

parent.delete_route_request_parameter(**kwargs)
  1. See DeleteRouteRequestParameterRequestRequestTypeDef

delete_route_response#

Deletes a RouteResponse.

Type annotations and code completion for boto3.client("apigatewayv2").delete_route_response method. boto3 documentation

# delete_route_response method definition

def delete_route_response(
    self,
    *,
    ApiId: str,
    RouteId: str,
    RouteResponseId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_route_response method usage example with argument unpacking

kwargs: DeleteRouteResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
    "RouteResponseId": ...,
}

parent.delete_route_response(**kwargs)
  1. See DeleteRouteResponseRequestRequestTypeDef

delete_route_settings#

Deletes the RouteSettings for a stage.

Type annotations and code completion for boto3.client("apigatewayv2").delete_route_settings method. boto3 documentation

# delete_route_settings method definition

def delete_route_settings(
    self,
    *,
    ApiId: str,
    RouteKey: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_route_settings method usage example with argument unpacking

kwargs: DeleteRouteSettingsRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteKey": ...,
    "StageName": ...,
}

parent.delete_route_settings(**kwargs)
  1. See DeleteRouteSettingsRequestRequestTypeDef

delete_stage#

Deletes a Stage.

Type annotations and code completion for boto3.client("apigatewayv2").delete_stage method. boto3 documentation

# delete_stage method definition

def delete_stage(
    self,
    *,
    ApiId: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_stage method usage example with argument unpacking

kwargs: DeleteStageRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "StageName": ...,
}

parent.delete_stage(**kwargs)
  1. See DeleteStageRequestRequestTypeDef

Deletes a VPC link.

Type annotations and code completion for boto3.client("apigatewayv2").delete_vpc_link method. boto3 documentation

# delete_vpc_link method definition

def delete_vpc_link(
    self,
    *,
    VpcLinkId: str,
) -> Dict[str, Any]:
    ...
# delete_vpc_link method usage example with argument unpacking

kwargs: DeleteVpcLinkRequestRequestTypeDef = {  # (1)
    "VpcLinkId": ...,
}

parent.delete_vpc_link(**kwargs)
  1. See DeleteVpcLinkRequestRequestTypeDef

export_api#

See also: AWS API Documentation.

Type annotations and code completion for boto3.client("apigatewayv2").export_api method. boto3 documentation

# export_api method definition

def export_api(
    self,
    *,
    ApiId: str,
    OutputType: JSONYAMLType,  # (1)
    Specification: OAS30Type,  # (2)
    ExportVersion: str = ...,
    IncludeExtensions: bool = ...,
    StageName: str = ...,
) -> ExportApiResponseTypeDef:  # (3)
    ...
  1. See JSONYAMLType
  2. See OAS30Type
  3. See ExportApiResponseTypeDef 
# export_api method usage example with argument unpacking

kwargs: ExportApiRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "OutputType": ...,
    "Specification": ...,
}

parent.export_api(**kwargs)
  1. See ExportApiRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# get_api method definition

def get_api(
    self,
    *,
    ApiId: str,
) -> GetApiResponseTypeDef:  # (1)
    ...
  1. See GetApiResponseTypeDef 
# get_api method usage example with argument unpacking

kwargs: GetApiRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_api(**kwargs)
  1. See GetApiRequestRequestTypeDef

get_api_mapping#

Gets an API mapping.

Type annotations and code completion for boto3.client("apigatewayv2").get_api_mapping method. boto3 documentation

# get_api_mapping method definition

def get_api_mapping(
    self,
    *,
    ApiMappingId: str,
    DomainName: str,
) -> GetApiMappingResponseTypeDef:  # (1)
    ...
  1. See GetApiMappingResponseTypeDef 
# get_api_mapping method usage example with argument unpacking

kwargs: GetApiMappingRequestRequestTypeDef = {  # (1)
    "ApiMappingId": ...,
    "DomainName": ...,
}

parent.get_api_mapping(**kwargs)
  1. See GetApiMappingRequestRequestTypeDef

get_api_mappings#

Gets API mappings.

Type annotations and code completion for boto3.client("apigatewayv2").get_api_mappings method. boto3 documentation

# get_api_mappings method definition

def get_api_mappings(
    self,
    *,
    DomainName: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetApiMappingsResponseTypeDef:  # (1)
    ...
  1. See GetApiMappingsResponseTypeDef 
# get_api_mappings method usage example with argument unpacking

kwargs: GetApiMappingsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_api_mappings(**kwargs)
  1. See GetApiMappingsRequestRequestTypeDef

get_apis#

Gets a collection of Api resources.

Type annotations and code completion for boto3.client("apigatewayv2").get_apis method. boto3 documentation

# get_apis method definition

def get_apis(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetApisResponseTypeDef:  # (1)
    ...
  1. See GetApisResponseTypeDef 
# get_apis method usage example with argument unpacking

kwargs: GetApisRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.get_apis(**kwargs)
  1. See GetApisRequestRequestTypeDef

get_authorizer#

Gets an Authorizer.

Type annotations and code completion for boto3.client("apigatewayv2").get_authorizer method. boto3 documentation

# get_authorizer method definition

def get_authorizer(
    self,
    *,
    ApiId: str,
    AuthorizerId: str,
) -> GetAuthorizerResponseTypeDef:  # (1)
    ...
  1. See GetAuthorizerResponseTypeDef 
# get_authorizer method usage example with argument unpacking

kwargs: GetAuthorizerRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "AuthorizerId": ...,
}

parent.get_authorizer(**kwargs)
  1. See GetAuthorizerRequestRequestTypeDef

get_authorizers#

Gets the Authorizers for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_authorizers method. boto3 documentation

# get_authorizers method definition

def get_authorizers(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetAuthorizersResponseTypeDef:  # (1)
    ...
  1. See GetAuthorizersResponseTypeDef 
# get_authorizers method usage example with argument unpacking

kwargs: GetAuthorizersRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_authorizers(**kwargs)
  1. See GetAuthorizersRequestRequestTypeDef

get_deployment#

Gets a Deployment.

Type annotations and code completion for boto3.client("apigatewayv2").get_deployment method. boto3 documentation

# get_deployment method definition

def get_deployment(
    self,
    *,
    ApiId: str,
    DeploymentId: str,
) -> GetDeploymentResponseTypeDef:  # (1)
    ...
  1. See GetDeploymentResponseTypeDef 
# get_deployment method usage example with argument unpacking

kwargs: GetDeploymentRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "DeploymentId": ...,
}

parent.get_deployment(**kwargs)
  1. See GetDeploymentRequestRequestTypeDef

get_deployments#

Gets the Deployments for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_deployments method. boto3 documentation

# get_deployments method definition

def get_deployments(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetDeploymentsResponseTypeDef:  # (1)
    ...
  1. See GetDeploymentsResponseTypeDef 
# get_deployments method usage example with argument unpacking

kwargs: GetDeploymentsRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_deployments(**kwargs)
  1. See GetDeploymentsRequestRequestTypeDef

get_domain_name#

Gets a domain name.

Type annotations and code completion for boto3.client("apigatewayv2").get_domain_name method. boto3 documentation

# get_domain_name method definition

def get_domain_name(
    self,
    *,
    DomainName: str,
) -> GetDomainNameResponseTypeDef:  # (1)
    ...
  1. See GetDomainNameResponseTypeDef 
# get_domain_name method usage example with argument unpacking

kwargs: GetDomainNameRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_domain_name(**kwargs)
  1. See GetDomainNameRequestRequestTypeDef

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

# get_domain_names method definition

def get_domain_names(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetDomainNamesResponseTypeDef:  # (1)
    ...
  1. See GetDomainNamesResponseTypeDef 
# get_domain_names method usage example with argument unpacking

kwargs: GetDomainNamesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.get_domain_names(**kwargs)
  1. See GetDomainNamesRequestRequestTypeDef

get_integration#

Gets an Integration.

Type annotations and code completion for boto3.client("apigatewayv2").get_integration method. boto3 documentation

# get_integration method definition

def get_integration(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
) -> GetIntegrationResultTypeDef:  # (1)
    ...
  1. See GetIntegrationResultTypeDef 
# get_integration method usage example with argument unpacking

kwargs: GetIntegrationRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
}

parent.get_integration(**kwargs)
  1. See GetIntegrationRequestRequestTypeDef

get_integration_response#

Gets an IntegrationResponses.

Type annotations and code completion for boto3.client("apigatewayv2").get_integration_response method. boto3 documentation

# get_integration_response method definition

def get_integration_response(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
    IntegrationResponseId: str,
) -> GetIntegrationResponseResponseTypeDef:  # (1)
    ...
  1. See GetIntegrationResponseResponseTypeDef 
# get_integration_response method usage example with argument unpacking

kwargs: GetIntegrationResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
    "IntegrationResponseId": ...,
}

parent.get_integration_response(**kwargs)
  1. See GetIntegrationResponseRequestRequestTypeDef

get_integration_responses#

Gets the IntegrationResponses for an Integration.

Type annotations and code completion for boto3.client("apigatewayv2").get_integration_responses method. boto3 documentation

# get_integration_responses method definition

def get_integration_responses(
    self,
    *,
    ApiId: str,
    IntegrationId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetIntegrationResponsesResponseTypeDef:  # (1)
    ...
  1. See GetIntegrationResponsesResponseTypeDef 
# get_integration_responses method usage example with argument unpacking

kwargs: GetIntegrationResponsesRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "IntegrationId": ...,
}

parent.get_integration_responses(**kwargs)
  1. See GetIntegrationResponsesRequestRequestTypeDef

get_integrations#

Gets the Integrations for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_integrations method. boto3 documentation

# get_integrations method definition

def get_integrations(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetIntegrationsResponseTypeDef:  # (1)
    ...
  1. See GetIntegrationsResponseTypeDef 
# get_integrations method usage example with argument unpacking

kwargs: GetIntegrationsRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_integrations(**kwargs)
  1. See GetIntegrationsRequestRequestTypeDef

get_model#

Gets a Model.

Type annotations and code completion for boto3.client("apigatewayv2").get_model method. boto3 documentation

# get_model method definition

def get_model(
    self,
    *,
    ApiId: str,
    ModelId: str,
) -> GetModelResponseTypeDef:  # (1)
    ...
  1. See GetModelResponseTypeDef 
# get_model method usage example with argument unpacking

kwargs: GetModelRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "ModelId": ...,
}

parent.get_model(**kwargs)
  1. See GetModelRequestRequestTypeDef

get_model_template#

Gets a model template.

Type annotations and code completion for boto3.client("apigatewayv2").get_model_template method. boto3 documentation

# get_model_template method definition

def get_model_template(
    self,
    *,
    ApiId: str,
    ModelId: str,
) -> GetModelTemplateResponseTypeDef:  # (1)
    ...
  1. See GetModelTemplateResponseTypeDef 
# get_model_template method usage example with argument unpacking

kwargs: GetModelTemplateRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "ModelId": ...,
}

parent.get_model_template(**kwargs)
  1. See GetModelTemplateRequestRequestTypeDef

get_models#

Gets the Models for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_models method. boto3 documentation

# get_models method definition

def get_models(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetModelsResponseTypeDef:  # (1)
    ...
  1. See GetModelsResponseTypeDef 
# get_models method usage example with argument unpacking

kwargs: GetModelsRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_models(**kwargs)
  1. See GetModelsRequestRequestTypeDef

get_route#

Gets a Route.

Type annotations and code completion for boto3.client("apigatewayv2").get_route method. boto3 documentation

# get_route method definition

def get_route(
    self,
    *,
    ApiId: str,
    RouteId: str,
) -> GetRouteResultTypeDef:  # (1)
    ...
  1. See GetRouteResultTypeDef 
# get_route method usage example with argument unpacking

kwargs: GetRouteRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
}

parent.get_route(**kwargs)
  1. See GetRouteRequestRequestTypeDef

get_route_response#

Gets a RouteResponse.

Type annotations and code completion for boto3.client("apigatewayv2").get_route_response method. boto3 documentation

# get_route_response method definition

def get_route_response(
    self,
    *,
    ApiId: str,
    RouteId: str,
    RouteResponseId: str,
) -> GetRouteResponseResponseTypeDef:  # (1)
    ...
  1. See GetRouteResponseResponseTypeDef 
# get_route_response method usage example with argument unpacking

kwargs: GetRouteResponseRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
    "RouteResponseId": ...,
}

parent.get_route_response(**kwargs)
  1. See GetRouteResponseRequestRequestTypeDef

get_route_responses#

Gets the RouteResponses for a Route.

Type annotations and code completion for boto3.client("apigatewayv2").get_route_responses method. boto3 documentation

# get_route_responses method definition

def get_route_responses(
    self,
    *,
    ApiId: str,
    RouteId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetRouteResponsesResponseTypeDef:  # (1)
    ...
  1. See GetRouteResponsesResponseTypeDef 
# get_route_responses method usage example with argument unpacking

kwargs: GetRouteResponsesRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "RouteId": ...,
}

parent.get_route_responses(**kwargs)
  1. See GetRouteResponsesRequestRequestTypeDef

get_routes#

Gets the Routes for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_routes method. boto3 documentation

# get_routes method definition

def get_routes(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetRoutesResponseTypeDef:  # (1)
    ...
  1. See GetRoutesResponseTypeDef 
# get_routes method usage example with argument unpacking

kwargs: GetRoutesRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_routes(**kwargs)
  1. See GetRoutesRequestRequestTypeDef

get_stage#

Gets a Stage.

Type annotations and code completion for boto3.client("apigatewayv2").get_stage method. boto3 documentation

# get_stage method definition

def get_stage(
    self,
    *,
    ApiId: str,
    StageName: str,
) -> GetStageResponseTypeDef:  # (1)
    ...
  1. See GetStageResponseTypeDef 
# get_stage method usage example with argument unpacking

kwargs: GetStageRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "StageName": ...,
}

parent.get_stage(**kwargs)
  1. See GetStageRequestRequestTypeDef

get_stages#

Gets the Stages for an API.

Type annotations and code completion for boto3.client("apigatewayv2").get_stages method. boto3 documentation

# get_stages method definition

def get_stages(
    self,
    *,
    ApiId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetStagesResponseTypeDef:  # (1)
    ...
  1. See GetStagesResponseTypeDef 
# get_stages method usage example with argument unpacking

kwargs: GetStagesRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.get_stages(**kwargs)
  1. See GetStagesRequestRequestTypeDef

get_tags#

Gets a collection of Tag resources.

Type annotations and code completion for boto3.client("apigatewayv2").get_tags method. boto3 documentation

# get_tags method definition

def get_tags(
    self,
    *,
    ResourceArn: str,
) -> GetTagsResponseTypeDef:  # (1)
    ...
  1. See GetTagsResponseTypeDef 
# get_tags method usage example with argument unpacking

kwargs: GetTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_tags(**kwargs)
  1. See GetTagsRequestRequestTypeDef

Gets a VPC link.

Type annotations and code completion for boto3.client("apigatewayv2").get_vpc_link method. boto3 documentation

# get_vpc_link method definition

def get_vpc_link(
    self,
    *,
    VpcLinkId: str,
) -> GetVpcLinkResponseTypeDef:  # (1)
    ...
  1. See GetVpcLinkResponseTypeDef 
# get_vpc_link method usage example with argument unpacking

kwargs: GetVpcLinkRequestRequestTypeDef = {  # (1)
    "VpcLinkId": ...,
}

parent.get_vpc_link(**kwargs)
  1. See GetVpcLinkRequestRequestTypeDef

Gets a collection of VPC links.

Type annotations and code completion for boto3.client("apigatewayv2").get_vpc_links method. boto3 documentation

# get_vpc_links method definition

def get_vpc_links(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> GetVpcLinksResponseTypeDef:  # (1)
    ...
  1. See GetVpcLinksResponseTypeDef 
# get_vpc_links method usage example with argument unpacking

kwargs: GetVpcLinksRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.get_vpc_links(**kwargs)
  1. See GetVpcLinksRequestRequestTypeDef

import_api#

Imports an API.

Type annotations and code completion for boto3.client("apigatewayv2").import_api method. boto3 documentation

# import_api method definition

def import_api(
    self,
    *,
    Body: str,
    Basepath: str = ...,
    FailOnWarnings: bool = ...,
) -> ImportApiResponseTypeDef:  # (1)
    ...
  1. See ImportApiResponseTypeDef 
# import_api method usage example with argument unpacking

kwargs: ImportApiRequestRequestTypeDef = {  # (1)
    "Body": ...,
}

parent.import_api(**kwargs)
  1. See ImportApiRequestRequestTypeDef

reimport_api#

Puts an Api resource.

Type annotations and code completion for boto3.client("apigatewayv2").reimport_api method. boto3 documentation

# reimport_api method definition

def reimport_api(
    self,
    *,
    ApiId: str,
    Body: str,
    Basepath: str = ...,
    FailOnWarnings: bool = ...,
) -> ReimportApiResponseTypeDef:  # (1)
    ...
  1. See ReimportApiResponseTypeDef 
# reimport_api method usage example with argument unpacking

kwargs: ReimportApiRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "Body": ...,
}

parent.reimport_api(**kwargs)
  1. See ReimportApiRequestRequestTypeDef

reset_authorizers_cache#

Resets all authorizer cache entries on a stage.

Type annotations and code completion for boto3.client("apigatewayv2").reset_authorizers_cache method. boto3 documentation

# reset_authorizers_cache method definition

def reset_authorizers_cache(
    self,
    *,
    ApiId: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# reset_authorizers_cache method usage example with argument unpacking

kwargs: ResetAuthorizersCacheRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "StageName": ...,
}

parent.reset_authorizers_cache(**kwargs)
  1. See ResetAuthorizersCacheRequestRequestTypeDef

tag_resource#

Creates a new Tag resource to represent a tag.

Type annotations and code completion for boto3.client("apigatewayv2").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Deletes a Tag.

Type annotations and code completion for boto3.client("apigatewayv2").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_api#

Updates an Api resource.

Type annotations and code completion for boto3.client("apigatewayv2").update_api method. boto3 documentation

# update_api method definition

def update_api(
    self,
    *,
    ApiId: str,
    ApiKeySelectionExpression: str = ...,
    CorsConfiguration: CorsTypeDef = ...,  # (1)
    CredentialsArn: str = ...,
    Description: str = ...,
    DisableSchemaValidation: bool = ...,
    DisableExecuteApiEndpoint: bool = ...,
    Name: str = ...,
    RouteKey: str = ...,
    RouteSelectionExpression: str = ...,
    Target: str = ...,
    Version: str = ...,
) -> UpdateApiResponseTypeDef:  # (2)
    ...
  1. See CorsTypeDef
  2. See UpdateApiResponseTypeDef 
# update_api method usage example with argument unpacking

kwargs: UpdateApiRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
}

parent.update_api(**kwargs)
  1. See UpdateApiRequestRequestTypeDef

update_api_mapping#

The API mapping.

Type annotations and code completion for boto3.client("apigatewayv2").update_api_mapping method. boto3 documentation

# update_api_mapping method definition

def update_api_mapping(
    self,
    *,
    ApiId: str,
    ApiMappingId: str,
    DomainName: str,
    ApiMappingKey: str = ...,
    Stage: str = ...,
) -> UpdateApiMappingResponseTypeDef:  # (1)
    ...
  1. See UpdateApiMappingResponseTypeDef 
# update_api_mapping method usage example with argument unpacking

kwargs: UpdateApiMappingRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "ApiMappingId": ...,
    "DomainName": ...,
}

parent.update_api_mapping(**kwargs)
  1. See UpdateApiMappingRequestRequestTypeDef

update_authorizer#

Updates an Authorizer.

Type annotations and code completion for boto3.client("apigatewayv2").update_authorizer method. boto3 documentation

# update_authorizer method definition

def update_authorizer(
    self,
    *,
    ApiId: str,
    AuthorizerId: str,
    AuthorizerCredentialsArn: str = ...,
    AuthorizerPayloadFormatVersion: str = ...,
    AuthorizerResultTtlInSeconds: int = ...,
    AuthorizerType: AuthorizerTypeType = ...,  # (1)
    AuthorizerUri: str = ...,
    EnableSimpleResponses: bool = ...,
    IdentitySource: Sequence[str] = ...,
    IdentityValidationExpression: str = ...,
    JwtConfiguration: JWTConfigurationTypeDef = ...,  # (2)
    Name: str = ...,
) -> UpdateAuthorizerResponseTypeDef:  # (3)
    ...
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef
  3. See UpdateAuthorizerResponseTypeDef 
# update_authorizer method usage example with argument unpacking

kwargs: UpdateAuthorizerRequestRequestTypeDef = {  # (1)
    "ApiId": ...,
    "AuthorizerId": ...,
}

parent.update_authorizer(**kwargs)
  1. See UpdateAuthorizerRequestRequestTypeDef

update_deployment#

Updates a Deployment.

Type annotations and code completion for boto3.client("apigatewayv2").update_deployment method.