Skip to content

APIGatewayClient

Index > APIGateway > APIGatewayClient

Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.

APIGatewayClient

Type annotations and code completion for boto3.client("apigateway"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_apigateway.client import APIGatewayClient

def get_apigateway_client() -> APIGatewayClient:
    return Session().client("apigateway")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("apigateway").exceptions structure.

Usage example
client = boto3.client("apigateway")

try:
    do_something(client)
except (
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.LimitExceededException,
    client.NotFoundException,
    client.ServiceUnavailableException,
    client.TooManyRequestsException,
    client.UnauthorizedException,
) as e:
    print(e)
Type checking example
from mypy_boto3_apigateway.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("apigateway").can_paginate method. boto3 documentation

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

close

Closes underlying endpoint connections.

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

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

create_api_key

Create an ApiKey resource.

Type annotations and code completion for boto3.client("apigateway").create_api_key method. boto3 documentation

Method definition
def create_api_key(
    self,
    *,
    name: str = ...,
    description: str = ...,
    enabled: bool = ...,
    generateDistinctId: bool = ...,
    value: str = ...,
    stageKeys: Sequence[StageKeyTypeDef] = ...,  # (1)
    customerId: str = ...,
    tags: Mapping[str, str] = ...,
) -> ApiKeyResponseMetadataTypeDef:  # (2)
    ...
  1. See StageKeyTypeDef
  2. See ApiKeyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateApiKeyRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_api_key(**kwargs)
  1. See CreateApiKeyRequestRequestTypeDef

create_authorizer

Adds a new Authorizer resource to an existing RestApi resource.

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

Method definition
def create_authorizer(
    self,
    *,
    restApiId: str,
    name: str,
    type: AuthorizerTypeType,  # (1)
    providerARNs: Sequence[str] = ...,
    authType: str = ...,
    authorizerUri: str = ...,
    authorizerCredentials: str = ...,
    identitySource: str = ...,
    identityValidationExpression: str = ...,
    authorizerResultTtlInSeconds: int = ...,
) -> AuthorizerResponseMetadataTypeDef:  # (2)
    ...
  1. See AuthorizerTypeType
  2. See AuthorizerResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateAuthorizerRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "name": ...,
    "type": ...,
}

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

create_base_path_mapping

Creates a new BasePathMapping resource.

Type annotations and code completion for boto3.client("apigateway").create_base_path_mapping method. boto3 documentation

Method definition
def create_base_path_mapping(
    self,
    *,
    domainName: str,
    restApiId: str,
    basePath: str = ...,
    stage: str = ...,
) -> BasePathMappingResponseMetadataTypeDef:  # (1)
    ...
  1. See BasePathMappingResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateBasePathMappingRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "restApiId": ...,
}

parent.create_base_path_mapping(**kwargs)
  1. See CreateBasePathMappingRequestRequestTypeDef

create_deployment

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

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

Method definition
def create_deployment(
    self,
    *,
    restApiId: str,
    stageName: str = ...,
    stageDescription: str = ...,
    description: str = ...,
    cacheClusterEnabled: bool = ...,
    cacheClusterSize: CacheClusterSizeType = ...,  # (1)
    variables: Mapping[str, str] = ...,
    canarySettings: DeploymentCanarySettingsTypeDef = ...,  # (2)
    tracingEnabled: bool = ...,
) -> DeploymentResponseMetadataTypeDef:  # (3)
    ...
  1. See CacheClusterSizeType
  2. See DeploymentCanarySettingsTypeDef
  3. See DeploymentResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

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

create_documentation_part

Creates a documentation part.

Type annotations and code completion for boto3.client("apigateway").create_documentation_part method. boto3 documentation

Method definition
def create_documentation_part(
    self,
    *,
    restApiId: str,
    location: DocumentationPartLocationTypeDef,  # (1)
    properties: str,
) -> DocumentationPartResponseMetadataTypeDef:  # (2)
    ...
  1. See DocumentationPartLocationTypeDef
  2. See DocumentationPartResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateDocumentationPartRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "location": ...,
    "properties": ...,
}

parent.create_documentation_part(**kwargs)
  1. See CreateDocumentationPartRequestRequestTypeDef

create_documentation_version

Creates a documentation version See also: AWS API Documentation.

Type annotations and code completion for boto3.client("apigateway").create_documentation_version method. boto3 documentation

Method definition
def create_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
    stageName: str = ...,
    description: str = ...,
) -> DocumentationVersionResponseMetadataTypeDef:  # (1)
    ...
  1. See DocumentationVersionResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateDocumentationVersionRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "documentationVersion": ...,
}

parent.create_documentation_version(**kwargs)
  1. See CreateDocumentationVersionRequestRequestTypeDef

create_domain_name

Creates a new domain name.

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

Method definition
def create_domain_name(
    self,
    *,
    domainName: str,
    certificateName: str = ...,
    certificateBody: str = ...,
    certificatePrivateKey: str = ...,
    certificateChain: str = ...,
    certificateArn: str = ...,
    regionalCertificateName: str = ...,
    regionalCertificateArn: str = ...,
    endpointConfiguration: EndpointConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    securityPolicy: SecurityPolicyType = ...,  # (2)
    mutualTlsAuthentication: MutualTlsAuthenticationInputTypeDef = ...,  # (3)
    ownershipVerificationCertificateArn: str = ...,
) -> DomainNameResponseMetadataTypeDef:  # (4)
    ...
  1. See EndpointConfigurationTypeDef
  2. See SecurityPolicyType
  3. See MutualTlsAuthenticationInputTypeDef
  4. See DomainNameResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateDomainNameRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

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

create_model

Adds a new Model resource to an existing RestApi resource.

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

Method definition
def create_model(
    self,
    *,
    restApiId: str,
    name: str,
    contentType: str,
    description: str = ...,
    schema: str = ...,
) -> ModelResponseMetadataTypeDef:  # (1)
    ...
  1. See ModelResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "name": ...,
    "contentType": ...,
}

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

create_request_validator

Creates a RequestValidator of a given RestApi.

Type annotations and code completion for boto3.client("apigateway").create_request_validator method. boto3 documentation

Method definition
def create_request_validator(
    self,
    *,
    restApiId: str,
    name: str = ...,
    validateRequestBody: bool = ...,
    validateRequestParameters: bool = ...,
) -> RequestValidatorResponseMetadataTypeDef:  # (1)
    ...
  1. See RequestValidatorResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateRequestValidatorRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

parent.create_request_validator(**kwargs)
  1. See CreateRequestValidatorRequestRequestTypeDef

create_resource

Creates a Resource resource.

Type annotations and code completion for boto3.client("apigateway").create_resource method. boto3 documentation

Method definition
def create_resource(
    self,
    *,
    restApiId: str,
    parentId: str,
    pathPart: str,
) -> ResourceResponseMetadataTypeDef:  # (1)
    ...
  1. See ResourceResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateResourceRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "parentId": ...,
    "pathPart": ...,
}

parent.create_resource(**kwargs)
  1. See CreateResourceRequestRequestTypeDef

create_rest_api

Creates a new RestApi resource.

Type annotations and code completion for boto3.client("apigateway").create_rest_api method. boto3 documentation

Method definition
def create_rest_api(
    self,
    *,
    name: str,
    description: str = ...,
    version: str = ...,
    cloneFrom: str = ...,
    binaryMediaTypes: Sequence[str] = ...,
    minimumCompressionSize: int = ...,
    apiKeySource: ApiKeySourceTypeType = ...,  # (1)
    endpointConfiguration: EndpointConfigurationTypeDef = ...,  # (2)
    policy: str = ...,
    tags: Mapping[str, str] = ...,
    disableExecuteApiEndpoint: bool = ...,
) -> RestApiResponseMetadataTypeDef:  # (3)
    ...
  1. See ApiKeySourceTypeType
  2. See EndpointConfigurationTypeDef
  3. See RestApiResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateRestApiRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_rest_api(**kwargs)
  1. See CreateRestApiRequestRequestTypeDef

create_stage

Creates a new Stage resource that references a pre-existing Deployment for the API.

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

Method definition
def create_stage(
    self,
    *,
    restApiId: str,
    stageName: str,
    deploymentId: str,
    description: str = ...,
    cacheClusterEnabled: bool = ...,
    cacheClusterSize: CacheClusterSizeType = ...,  # (1)
    variables: Mapping[str, str] = ...,
    documentationVersion: str = ...,
    canarySettings: CanarySettingsTypeDef = ...,  # (2)
    tracingEnabled: bool = ...,
    tags: Mapping[str, str] = ...,
) -> StageResponseMetadataTypeDef:  # (3)
    ...
  1. See CacheClusterSizeType
  2. See CanarySettingsTypeDef
  3. See StageResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateStageRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
    "deploymentId": ...,
}

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

create_usage_plan

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Type annotations and code completion for boto3.client("apigateway").create_usage_plan method. boto3 documentation

Method definition
def create_usage_plan(
    self,
    *,
    name: str,
    description: str = ...,
    apiStages: Sequence[ApiStageTypeDef] = ...,  # (1)
    throttle: ThrottleSettingsTypeDef = ...,  # (2)
    quota: QuotaSettingsTypeDef = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> UsagePlanResponseMetadataTypeDef:  # (4)
    ...
  1. See ApiStageTypeDef
  2. See ThrottleSettingsTypeDef
  3. See QuotaSettingsTypeDef
  4. See UsagePlanResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateUsagePlanRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_usage_plan(**kwargs)
  1. See CreateUsagePlanRequestRequestTypeDef

create_usage_plan_key

Creates a usage plan key for adding an existing API key to a usage plan.

Type annotations and code completion for boto3.client("apigateway").create_usage_plan_key method. boto3 documentation

Method definition
def create_usage_plan_key(
    self,
    *,
    usagePlanId: str,
    keyId: str,
    keyType: str,
) -> UsagePlanKeyResponseMetadataTypeDef:  # (1)
    ...
  1. See UsagePlanKeyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateUsagePlanKeyRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
    "keyId": ...,
    "keyType": ...,
}

parent.create_usage_plan_key(**kwargs)
  1. See CreateUsagePlanKeyRequestRequestTypeDef

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.

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

Method definition
def create_vpc_link(
    self,
    *,
    name: str,
    targetArns: Sequence[str],
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> VpcLinkResponseMetadataTypeDef:  # (1)
    ...
  1. See VpcLinkResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateVpcLinkRequestRequestTypeDef = {  # (1)
    "name": ...,
    "targetArns": ...,
}

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

delete_api_key

Deletes the ApiKey resource.

Type annotations and code completion for boto3.client("apigateway").delete_api_key method. boto3 documentation

Method definition
def delete_api_key(
    self,
    *,
    apiKey: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteApiKeyRequestRequestTypeDef = {  # (1)
    "apiKey": ...,
}

parent.delete_api_key(**kwargs)
  1. See DeleteApiKeyRequestRequestTypeDef

delete_authorizer

Deletes an existing Authorizer resource.

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

Method definition
def delete_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAuthorizerRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "authorizerId": ...,
}

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

delete_base_path_mapping

Deletes the BasePathMapping resource.

Type annotations and code completion for boto3.client("apigateway").delete_base_path_mapping method. boto3 documentation

Method definition
def delete_base_path_mapping(
    self,
    *,
    domainName: str,
    basePath: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteBasePathMappingRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "basePath": ...,
}

parent.delete_base_path_mapping(**kwargs)
  1. See DeleteBasePathMappingRequestRequestTypeDef

delete_client_certificate

Deletes the ClientCertificate resource.

Type annotations and code completion for boto3.client("apigateway").delete_client_certificate method. boto3 documentation

Method definition
def delete_client_certificate(
    self,
    *,
    clientCertificateId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteClientCertificateRequestRequestTypeDef = {  # (1)
    "clientCertificateId": ...,
}

parent.delete_client_certificate(**kwargs)
  1. See DeleteClientCertificateRequestRequestTypeDef

delete_deployment

Deletes a Deployment resource.

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

Method definition
def delete_deployment(
    self,
    *,
    restApiId: str,
    deploymentId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDeploymentRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "deploymentId": ...,
}

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

delete_documentation_part

Deletes a documentation part See also: AWS API Documentation.

Type annotations and code completion for boto3.client("apigateway").delete_documentation_part method. boto3 documentation

Method definition
def delete_documentation_part(
    self,
    *,
    restApiId: str,
    documentationPartId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDocumentationPartRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "documentationPartId": ...,
}

parent.delete_documentation_part(**kwargs)
  1. See DeleteDocumentationPartRequestRequestTypeDef

delete_documentation_version

Deletes a documentation version.

Type annotations and code completion for boto3.client("apigateway").delete_documentation_version method. boto3 documentation

Method definition
def delete_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDocumentationVersionRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "documentationVersion": ...,
}

parent.delete_documentation_version(**kwargs)
  1. See DeleteDocumentationVersionRequestRequestTypeDef

delete_domain_name

Deletes the DomainName resource.

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

Method definition
def delete_domain_name(
    self,
    *,
    domainName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDomainNameRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

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

delete_gateway_response

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Type annotations and code completion for boto3.client("apigateway").delete_gateway_response method. boto3 documentation

Method definition
def delete_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See GatewayResponseTypeType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteGatewayResponseRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "responseType": ...,
}

parent.delete_gateway_response(**kwargs)
  1. See DeleteGatewayResponseRequestRequestTypeDef

delete_integration

Represents a delete integration.

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

Method definition
def delete_integration(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIntegrationRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
    "httpMethod": ...,
}

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

delete_integration_response

Represents a delete integration response.

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

Method definition
def delete_integration_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIntegrationResponseRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
    "httpMethod": ...,
    "statusCode": ...,
}

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

delete_method

Deletes an existing Method resource.

Type annotations and code completion for boto3.client("apigateway").delete_method method. boto3 documentation

Method definition
def delete_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteMethodRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
    "httpMethod": ...,
}

parent.delete_method(**kwargs)
  1. See DeleteMethodRequestRequestTypeDef

delete_method_response

Deletes an existing MethodResponse resource.

Type annotations and code completion for boto3.client("apigateway").delete_method_response method. boto3 documentation

Method definition
def delete_method_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteMethodResponseRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
    "httpMethod": ...,
    "statusCode": ...,
}

parent.delete_method_response(**kwargs)
  1. See DeleteMethodResponseRequestRequestTypeDef

delete_model

Deletes a model.

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

Method definition
def delete_model(
    self,
    *,
    restApiId: str,
    modelName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteModelRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "modelName": ...,
}

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

delete_request_validator

Deletes a RequestValidator of a given RestApi.

Type annotations and code completion for boto3.client("apigateway").delete_request_validator method. boto3 documentation

Method definition
def delete_request_validator(
    self,
    *,
    restApiId: str,
    requestValidatorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteRequestValidatorRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "requestValidatorId": ...,
}

parent.delete_request_validator(**kwargs)
  1. See DeleteRequestValidatorRequestRequestTypeDef

delete_resource

Deletes a Resource resource.

Type annotations and code completion for boto3.client("apigateway").delete_resource method. boto3 documentation

Method definition
def delete_resource(
    self,
    *,
    restApiId: str,
    resourceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteResourceRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
}

parent.delete_resource(**kwargs)
  1. See DeleteResourceRequestRequestTypeDef

delete_rest_api

Deletes the specified API.

Type annotations and code completion for boto3.client("apigateway").delete_rest_api method. boto3 documentation

Method definition
def delete_rest_api(
    self,
    *,
    restApiId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteRestApiRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

parent.delete_rest_api(**kwargs)
  1. See DeleteRestApiRequestRequestTypeDef

delete_stage

Deletes a Stage resource.

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

Method definition
def delete_stage(
    self,
    *,
    restApiId: str,
    stageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteStageRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
}

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

delete_usage_plan

Deletes a usage plan of a given plan Id.

Type annotations and code completion for boto3.client("apigateway").delete_usage_plan method. boto3 documentation

Method definition
def delete_usage_plan(
    self,
    *,
    usagePlanId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUsagePlanRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
}

parent.delete_usage_plan(**kwargs)
  1. See DeleteUsagePlanRequestRequestTypeDef

delete_usage_plan_key

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Type annotations and code completion for boto3.client("apigateway").delete_usage_plan_key method. boto3 documentation

Method definition
def delete_usage_plan_key(
    self,
    *,
    usagePlanId: str,
    keyId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUsagePlanKeyRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
    "keyId": ...,
}

parent.delete_usage_plan_key(**kwargs)
  1. See DeleteUsagePlanKeyRequestRequestTypeDef

Deletes an existing VpcLink of a specified identifier.

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

Method definition
def delete_vpc_link(
    self,
    *,
    vpcLinkId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteVpcLinkRequestRequestTypeDef = {  # (1)
    "vpcLinkId": ...,
}

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

flush_stage_authorizers_cache

Flushes all authorizer cache entries on a stage.

Type annotations and code completion for boto3.client("apigateway").flush_stage_authorizers_cache method. boto3 documentation

Method definition
def flush_stage_authorizers_cache(
    self,
    *,
    restApiId: str,
    stageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: FlushStageAuthorizersCacheRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
}

parent.flush_stage_authorizers_cache(**kwargs)
  1. See FlushStageAuthorizersCacheRequestRequestTypeDef

flush_stage_cache

Flushes a stage's cache.

Type annotations and code completion for boto3.client("apigateway").flush_stage_cache method. boto3 documentation

Method definition
def flush_stage_cache(
    self,
    *,
    restApiId: str,
    stageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: FlushStageCacheRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
}

parent.flush_stage_cache(**kwargs)
  1. See FlushStageCacheRequestRequestTypeDef

generate_client_certificate

Generates a ClientCertificate resource.

Type annotations and code completion for boto3.client("apigateway").generate_client_certificate method. boto3 documentation

Method definition
def generate_client_certificate(
    self,
    *,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> ClientCertificateResponseMetadataTypeDef:  # (1)
    ...
  1. See ClientCertificateResponseMetadataTypeDef
Usage example with kwargs
kwargs: GenerateClientCertificateRequestRequestTypeDef = {  # (1)
    "description": ...,
}

parent.generate_client_certificate(**kwargs)
  1. See GenerateClientCertificateRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("apigateway").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_account

Gets information about the current Account resource.

Type annotations and code completion for boto3.client("apigateway").get_account method. boto3 documentation

Method definition
def get_account(
    self,
) -> AccountTypeDef:  # (1)
    ...
  1. See AccountTypeDef

get_api_key

Gets information about the current ApiKey resource.

Type annotations and code completion for boto3.client("apigateway").get_api_key method. boto3 documentation

Method definition
def get_api_key(
    self,
    *,
    apiKey: str,
    includeValue: bool = ...,
) -> ApiKeyResponseMetadataTypeDef:  # (1)
    ...
  1. See ApiKeyResponseMetadataTypeDef
Usage example with kwargs
kwargs: GetApiKeyRequestRequestTypeDef = {  # (1)
    "apiKey": ...,
}

parent.get_api_key(**kwargs)
  1. See GetApiKeyRequestRequestTypeDef

get_api_keys

Gets information about the current ApiKeys resource.

Type annotations and code completion for boto3.client("apigateway").get_api_keys method. boto3 documentation

Method definition
def get_api_keys(
    self,
    *,
    position: str = ...,
    limit: int = ...,
    nameQuery: str = ...,
    customerId: str = ...,
    includeValues: bool = ...,
) -> ApiKeysTypeDef:  # (1)
    ...
  1. See ApiKeysTypeDef
Usage example with kwargs
kwargs: GetApiKeysRequestRequestTypeDef = {  # (1)
    "position": ...,
}

parent.get_api_keys(**kwargs)
  1. See GetApiKeysRequestRequestTypeDef

get_authorizer

Describe an existing Authorizer resource.

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

Method definition
def get_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
) -> AuthorizerResponseMetadataTypeDef:  # (1)
    ...
  1. See AuthorizerResponseMetadataTypeDef
Usage example with kwargs
kwargs: GetAuthorizerRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "authorizerId": ...,
}

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

get_authorizers

Describe an existing Authorizers resource.

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

Method definition
def get_authorizers(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> AuthorizersTypeDef:  # (1)
    ...
  1. See AuthorizersTypeDef
Usage example with kwargs
kwargs: GetAuthorizersRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

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

get_base_path_mapping

Describe a BasePathMapping resource.

Type annotations and code completion for boto3.client("apigateway").get_base_path_mapping method. boto3 documentation

Method definition
def get_base_path_mapping(
    self,
    *,
    domainName: str,
    basePath: str,
) -> BasePathMappingResponseMetadataTypeDef:  # (1)
    ...
  1. See BasePathMappingResponseMetadataTypeDef
Usage example with kwargs
kwargs: GetBasePathMappingRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "basePath": ...,
}

parent.get_base_path_mapping(**kwargs)
  1. See GetBasePathMappingRequestRequestTypeDef

get_base_path_mappings

Represents a collection of BasePathMapping resources.

Type annotations and code completion for boto3.client("apigateway").get_base_path_mappings method. boto3 documentation

Method definition
def get_base_path_mappings(
    self,
    *,
    domainName: str,
    position: str = ...,
    limit: int = ...,
) -> BasePathMappingsTypeDef:  # (1)
    ...
  1. See BasePathMappingsTypeDef
Usage example with kwargs
kwargs: GetBasePathMappingsRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.get_base_path_mappings(**kwargs)
  1. See GetBasePathMappingsRequestRequestTypeDef

get_client_certificate

Gets information about the current ClientCertificate resource.

Type annotations and code completion for boto3.client("apigateway").get_client_certificate method. boto3 documentation

Method definition
def get_client_certificate(
    self,
    *,
    clientCertificateId: str,
) -> ClientCertificateResponseMetadataTypeDef:  # (1)
    ...
  1. See ClientCertificateResponseMetadataTypeDef
Usage example with kwargs
kwargs: GetClientCertificateRequestRequestTypeDef = {  # (1)
    "clientCertificateId": ...,
}

parent.get_client_certificate(**kwargs)
  1. See GetClientCertificateRequestRequestTypeDef

get_client_certificates

Gets a collection of ClientCertificate resources.

Type annotations and code completion for boto3.client("apigateway").get_client_certificates method. boto3 documentation

Method definition
def get_client_certificates(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> ClientCertificatesTypeDef:  # (1)
    ...
  1. See ClientCertificatesTypeDef
Usage example with kwargs
kwargs: GetClientCertificatesRequestRequestTypeDef = {  # (1)
    "position": ...,