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

# APIGatewayClient 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.

# Exceptions.exceptions usage example

client = boto3.client("apigateway")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)
# Exceptions.exceptions 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

# 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("apigateway").close method. boto3 documentation

# close 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

# create_api_key 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 
# create_api_key method usage example with argument unpacking

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

# create_authorizer 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 
# create_authorizer method usage example with argument unpacking

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

# create_base_path_mapping method definition

def create_base_path_mapping(
    self,
    *,
    domainName: str,
    restApiId: str,
    basePath: str = ...,
    stage: str = ...,
) -> BasePathMappingResponseMetadataTypeDef:  # (1)
    ...
  1. See BasePathMappingResponseMetadataTypeDef 
# create_base_path_mapping method usage example with argument unpacking

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

# create_deployment 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 
# create_deployment method usage example with argument unpacking

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

# create_documentation_part method definition

def create_documentation_part(
    self,
    *,
    restApiId: str,
    location: DocumentationPartLocationTypeDef,  # (1)
    properties: str,
) -> DocumentationPartResponseMetadataTypeDef:  # (2)
    ...
  1. See DocumentationPartLocationTypeDef
  2. See DocumentationPartResponseMetadataTypeDef 
# create_documentation_part method usage example with argument unpacking

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

# create_documentation_version method definition

def create_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
    stageName: str = ...,
    description: str = ...,
) -> DocumentationVersionResponseMetadataTypeDef:  # (1)
    ...
  1. See DocumentationVersionResponseMetadataTypeDef 
# create_documentation_version method usage example with argument unpacking

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

# create_domain_name 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 
# create_domain_name method usage example with argument unpacking

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

# create_model method definition

def create_model(
    self,
    *,
    restApiId: str,
    name: str,
    contentType: str,
    description: str = ...,
    schema: str = ...,
) -> ModelResponseMetadataTypeDef:  # (1)
    ...
  1. See ModelResponseMetadataTypeDef 
# create_model method usage example with argument unpacking

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

# create_request_validator method definition

def create_request_validator(
    self,
    *,
    restApiId: str,
    name: str = ...,
    validateRequestBody: bool = ...,
    validateRequestParameters: bool = ...,
) -> RequestValidatorResponseMetadataTypeDef:  # (1)
    ...
  1. See RequestValidatorResponseMetadataTypeDef 
# create_request_validator method usage example with argument unpacking

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

# create_resource method definition

def create_resource(
    self,
    *,
    restApiId: str,
    parentId: str,
    pathPart: str,
) -> ResourceResponseMetadataTypeDef:  # (1)
    ...
  1. See ResourceResponseMetadataTypeDef 
# create_resource method usage example with argument unpacking

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

# create_rest_api 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 
# create_rest_api method usage example with argument unpacking

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

# create_stage 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 
# create_stage method usage example with argument unpacking

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

# create_usage_plan 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 
# create_usage_plan method usage example with argument unpacking

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

# create_usage_plan_key method definition

def create_usage_plan_key(
    self,
    *,
    usagePlanId: str,
    keyId: str,
    keyType: str,
) -> UsagePlanKeyResponseMetadataTypeDef:  # (1)
    ...
  1. See UsagePlanKeyResponseMetadataTypeDef 
# create_usage_plan_key method usage example with argument unpacking

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

# create_vpc_link method definition

def create_vpc_link(
    self,
    *,
    name: str,
    targetArns: Sequence[str],
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> VpcLinkResponseMetadataTypeDef:  # (1)
    ...
  1. See VpcLinkResponseMetadataTypeDef 
# create_vpc_link method usage example with argument unpacking

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

# delete_api_key method definition

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

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

# delete_authorizer method definition

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

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

# delete_base_path_mapping method definition

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

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

# delete_client_certificate method definition

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

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

# delete_deployment method definition

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

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

# delete_documentation_part method definition

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

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

# delete_documentation_version method definition

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

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

# 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_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

# delete_gateway_response method definition

def delete_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See GatewayResponseTypeType
  2. See EmptyResponseMetadataTypeDef 
# delete_gateway_response method usage example with argument unpacking

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

# delete_integration method definition

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

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

# delete_integration_response method definition

def delete_integration_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_integration_response method usage example with argument unpacking

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

# delete_method method definition

def delete_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_method method usage example with argument unpacking

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

# delete_method_response method definition

def delete_method_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_method_response method usage example with argument unpacking

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

# delete_model method definition

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

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

# delete_request_validator method definition

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

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

# delete_resource method definition

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

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

# delete_rest_api method definition

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

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

# delete_stage method definition

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

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

# delete_usage_plan method definition

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

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

# delete_usage_plan_key method definition

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

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

# delete_vpc_link method definition

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

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

# flush_stage_authorizers_cache method definition

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

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

# flush_stage_cache method definition

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

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

# generate_client_certificate method definition

def generate_client_certificate(
    self,
    *,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> ClientCertificateResponseMetadataTypeDef:  # (1)
    ...
  1. See ClientCertificateResponseMetadataTypeDef 
# generate_client_certificate method usage example with argument unpacking

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

# generate_presigned_url 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

# get_account 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

# get_api_key method definition

def get_api_key(
    self,
    *,
    apiKey: str,
    includeValue: bool = ...,
) -> ApiKeyResponseMetadataTypeDef:  # (1)
    ...
  1. See ApiKeyResponseMetadataTypeDef 
# get_api_key method usage example with argument unpacking

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

# get_api_keys method definition

def get_api_keys(
    self,
    *,
    position: str = ...,
    limit: int = ...,
    nameQuery: str = ...,
    customerId: str = ...,
    includeValues: bool = ...,
) -> ApiKeysTypeDef:  # (1)
    ...
  1. See ApiKeysTypeDef 
# get_api_keys method usage example with argument unpacking

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

# get_authorizer method definition

def get_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
) -> AuthorizerResponseMetadataTypeDef:  # (1)
    ...
  1. See AuthorizerResponseMetadataTypeDef 
# get_authorizer method usage example with argument unpacking

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

# get_authorizers method definition

def get_authorizers(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> AuthorizersTypeDef:  # (1)
    ...
  1. See AuthorizersTypeDef 
# get_authorizers method usage example with argument unpacking

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

# get_base_path_mapping method definition

def get_base_path_mapping(
    self,
    *,
    domainName: str,
    basePath: str,
) -> BasePathMappingResponseMetadataTypeDef:  # (1)
    ...
  1. See BasePathMappingResponseMetadataTypeDef 
# get_base_path_mapping method usage example with argument unpacking

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

# get_base_path_mappings method definition

def get_base_path_mappings(
    self,
    *,
    domainName: str,
    position: str = ...,
    limit: int = ...,
) -> BasePathMappingsTypeDef:  # (1)
    ...
  1. See BasePathMappingsTypeDef 
# get_base_path_mappings method usage example with argument unpacking

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

# get_client_certificate method definition

def get_client_certificate(
    self,
    *,
    clientCertificateId: str,
) -> ClientCertificateResponseMetadataTypeDef:  # (1)
    ...
  1. See ClientCertificateResponseMetadataTypeDef 
# get_client_certificate method usage example with argument unpacking

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

# get_client_certificates method definition

def get_client_certificates(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> ClientCertificatesTypeDef:  # (1)
    ...
  1. See ClientCertificatesTypeDef 
# get_client_certificates method usage example with argument unpacking

kwargs: GetClientCertificatesRequestRequestTypeDef = {  # (1)
    "position": ...,
}

parent.get_client_certificates(**kwargs)
  1. See GetClientCertificatesRequestRequestTypeDef

get_deployment#

Gets information about a Deployment resource.

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

# get_deployment method definition

def get_deployment(
    self,
    *,
    restApiId: str,
    deploymentId: str,
    embed: Sequence[str] = ...,
) -> DeploymentResponseMetadataTypeDef:  # (1)
    ...
  1. See DeploymentResponseMetadataTypeDef 
# get_deployment method usage example with argument unpacking

kwargs: GetDeploymentRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "deploymentId": ...,
}

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

get_deployments#

Gets information about a Deployments collection.

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

# get_deployments method definition

def get_deployments(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> DeploymentsTypeDef:  # (1)
    ...
  1. See DeploymentsTypeDef 
# get_deployments method usage example with argument unpacking

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

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

get_documentation_part#

Gets a documentation part.

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

# get_documentation_part method definition

def get_documentation_part(
    self,
    *,
    restApiId: str,
    documentationPartId: str,
) -> DocumentationPartResponseMetadataTypeDef:  # (1)
    ...
  1. See DocumentationPartResponseMetadataTypeDef 
# get_documentation_part method usage example with argument unpacking

kwargs: GetDocumentationPartRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "documentationPartId": ...,
}

parent.get_documentation_part(**kwargs)
  1. See GetDocumentationPartRequestRequestTypeDef

get_documentation_parts#

Gets documentation parts.

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

# get_documentation_parts method definition

def get_documentation_parts(
    self,
    *,
    restApiId: str,
    type: DocumentationPartTypeType = ...,  # (1)
    nameQuery: str = ...,
    path: str = ...,
    position: str = ...,
    limit: int = ...,
    locationStatus: LocationStatusTypeType = ...,  # (2)
) -> DocumentationPartsTypeDef:  # (3)
    ...
  1. See DocumentationPartTypeType
  2. See LocationStatusTypeType
  3. See DocumentationPartsTypeDef 
# get_documentation_parts method usage example with argument unpacking

kwargs: GetDocumentationPartsRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

parent.get_documentation_parts(**kwargs)
  1. See GetDocumentationPartsRequestRequestTypeDef

get_documentation_version#

Gets a documentation version.

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

# get_documentation_version method definition

def get_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
) -> DocumentationVersionResponseMetadataTypeDef:  # (1)
    ...
  1. See DocumentationVersionResponseMetadataTypeDef 
# get_documentation_version method usage example with argument unpacking

kwargs: GetDocumentationVersionRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "documentationVersion": ...,
}

parent.get_documentation_version(**kwargs)
  1. See GetDocumentationVersionRequestRequestTypeDef

get_documentation_versions#

Gets documentation versions.

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

# get_documentation_versions method definition

def get_documentation_versions(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> DocumentationVersionsTypeDef:  # (1)
    ...
  1. See DocumentationVersionsTypeDef 
# get_documentation_versions method usage example with argument unpacking

kwargs: GetDocumentationVersionsRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

parent.get_documentation_versions(**kwargs)
  1. See GetDocumentationVersionsRequestRequestTypeDef

get_domain_name#

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

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

# get_domain_name method definition

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

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

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

get_domain_names#

Represents a collection of DomainName resources.

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

# get_domain_names method definition

def get_domain_names(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> DomainNamesTypeDef:  # (1)
    ...
  1. See DomainNamesTypeDef 
# get_domain_names method usage example with argument unpacking

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

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

get_export#

Exports a deployed version of a RestApi in a specified format.

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

# get_export method definition

def get_export(
    self,
    *,
    restApiId: str,
    stageName: str,
    exportType: str,
    parameters: Mapping[str, str] = ...,
    accepts: str = ...,
) -> ExportResponseTypeDef:  # (1)
    ...
  1. See ExportResponseTypeDef 
# get_export method usage example with argument unpacking

kwargs: GetExportRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
    "exportType": ...,
}

parent.get_export(**kwargs)
  1. See GetExportRequestRequestTypeDef

get_gateway_response#

Gets a GatewayResponse of a specified response type on the given RestApi.

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

# get_gateway_response method definition

def get_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
) -> GatewayResponseResponseMetadataTypeDef:  # (2)
    ...
  1. See GatewayResponseTypeType
  2. See GatewayResponseResponseMetadataTypeDef 
# get_gateway_response method usage example with argument unpacking

kwargs: GetGatewayResponseRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "responseType": ...,
}

parent.get_gateway_response(**kwargs)
  1. See GetGatewayResponseRequestRequestTypeDef

get_gateway_responses#

Gets the GatewayResponses collection on the given RestApi.

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

# get_gateway_responses method definition

def get_gateway_responses(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> GatewayResponsesTypeDef:  # (1)
    ...
  1. See GatewayResponsesTypeDef 
# get_gateway_responses method usage example with argument unpacking

kwargs: GetGatewayResponsesRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
}

parent.get_gateway_responses(**kwargs)
  1. See GetGatewayResponsesRequestRequestTypeDef

get_integration#

Get the integration settings.

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

# get_integration method definition

def get_integration(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> IntegrationResponseMetadataTypeDef:  # (1)
    ...
  1. See IntegrationResponseMetadataTypeDef 
# get_integration method usage example with argument unpacking

kwargs: GetIntegrationRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "resourceId": ...,
    "httpMethod": ...,
}

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

get_integration_response#

Represents a get integration response.

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