APIGatewayClient

Index > APIGateway > APIGatewayClient

Auto-generated documentation for APIGateway type annotations stubs module types-aiobotocore-apigateway.

APIGatewayClient

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

APIGatewayClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_apigateway.client import APIGatewayClient

session = get_session()
async with session.create_client("apigateway") as client:
    client: APIGatewayClient

Exceptions

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

APIGatewayClient.exceptions usage example

async with session.create_client("apigateway") as client:
    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)

APIGatewayClient usage type checking example

from types_aiobotocore_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 session.create_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 session.create_client("apigateway").close method. boto3 documentation

# close method definition

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

create_api_key

Create an ApiKey resource.

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

# create_api_key method definition

await 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] = ...,
) -> ApiKeyResponseTypeDef:  # (2)
    ...

1. See StageKeyTypeDef
2. See ApiKeyResponseTypeDef

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

# create_authorizer method definition

await 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 = ...,
) -> AuthorizerResponseTypeDef:  # (2)
    ...

1. See AuthorizerTypeType
2. See AuthorizerResponseTypeDef

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

# create_base_path_mapping method definition

await def create_base_path_mapping(
    self,
    *,
    domainName: str,
    restApiId: str,
    basePath: str = ...,
    stage: str = ...,
) -> BasePathMappingResponseTypeDef:  # (1)
    ...

1. See BasePathMappingResponseTypeDef

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

# create_deployment method definition

await 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 = ...,
) -> DeploymentResponseTypeDef:  # (3)
    ...

1. See CacheClusterSizeType
2. See DeploymentCanarySettingsTypeDef
3. See DeploymentResponseTypeDef

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

# create_documentation_part method definition

await def create_documentation_part(
    self,
    *,
    restApiId: str,
    location: DocumentationPartLocationTypeDef,  # (1)
    properties: str,
) -> DocumentationPartResponseTypeDef:  # (2)
    ...

1. See DocumentationPartLocationTypeDef
2. See DocumentationPartResponseTypeDef

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

# create_documentation_version method definition

await def create_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
    stageName: str = ...,
    description: str = ...,
) -> DocumentationVersionResponseTypeDef:  # (1)
    ...

1. See DocumentationVersionResponseTypeDef

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

# create_domain_name method definition

await 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 = ...,
) -> DomainNameResponseTypeDef:  # (4)
    ...

1. See EndpointConfigurationTypeDef
2. See SecurityPolicyType
3. See MutualTlsAuthenticationInputTypeDef
4. See DomainNameResponseTypeDef

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

# create_model method definition

await def create_model(
    self,
    *,
    restApiId: str,
    name: str,
    contentType: str,
    description: str = ...,
    schema: str = ...,
) -> ModelResponseTypeDef:  # (1)
    ...

1. See ModelResponseTypeDef

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

# create_request_validator method definition

await def create_request_validator(
    self,
    *,
    restApiId: str,
    name: str = ...,
    validateRequestBody: bool = ...,
    validateRequestParameters: bool = ...,
) -> RequestValidatorResponseTypeDef:  # (1)
    ...

1. See RequestValidatorResponseTypeDef

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

# create_resource method definition

await def create_resource(
    self,
    *,
    restApiId: str,
    parentId: str,
    pathPart: str,
) -> ResourceResponseTypeDef:  # (1)
    ...

1. See ResourceResponseTypeDef

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

# create_rest_api method definition

await 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 = ...,
) -> RestApiResponseTypeDef:  # (3)
    ...

1. See ApiKeySourceTypeType
2. See EndpointConfigurationTypeDef
3. See RestApiResponseTypeDef

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

# create_stage method definition

await 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] = ...,
) -> StageResponseTypeDef:  # (3)
    ...

1. See CacheClusterSizeType
2. See CanarySettingsTypeDef
3. See StageResponseTypeDef

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

# create_usage_plan method definition

await def create_usage_plan(
    self,
    *,
    name: str,
    description: str = ...,
    apiStages: Sequence[ApiStageTypeDef] = ...,  # (1)
    throttle: ThrottleSettingsTypeDef = ...,  # (2)
    quota: QuotaSettingsTypeDef = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> UsagePlanResponseTypeDef:  # (4)
    ...

1. See ApiStageTypeDef
2. See ThrottleSettingsTypeDef
3. See QuotaSettingsTypeDef
4. See UsagePlanResponseTypeDef

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

# create_usage_plan_key method definition

await def create_usage_plan_key(
    self,
    *,
    usagePlanId: str,
    keyId: str,
    keyType: str,
) -> UsagePlanKeyResponseTypeDef:  # (1)
    ...

1. See UsagePlanKeyResponseTypeDef

# 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

create_vpc_link

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 session.create_client("apigateway").create_vpc_link method. boto3 documentation

# create_vpc_link method definition

await def create_vpc_link(
    self,
    *,
    name: str,
    targetArns: Sequence[str],
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> VpcLinkResponseTypeDef:  # (1)
    ...

1. See VpcLinkResponseTypeDef

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

# delete_api_key method definition

await 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 session.create_client("apigateway").delete_authorizer method. boto3 documentation

# delete_authorizer method definition

await 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 session.create_client("apigateway").delete_base_path_mapping method. boto3 documentation

# delete_base_path_mapping method definition

await 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 session.create_client("apigateway").delete_client_certificate method. boto3 documentation

# delete_client_certificate method definition

await 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 session.create_client("apigateway").delete_deployment method. boto3 documentation

# delete_deployment method definition

await 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 session.create_client("apigateway").delete_documentation_part method. boto3 documentation

# delete_documentation_part method definition

await 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 session.create_client("apigateway").delete_documentation_version method. boto3 documentation

# delete_documentation_version method definition

await 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 session.create_client("apigateway").delete_domain_name method. boto3 documentation

# delete_domain_name method definition

await 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 session.create_client("apigateway").delete_gateway_response method. boto3 documentation

# delete_gateway_response method definition

await 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 session.create_client("apigateway").delete_integration method. boto3 documentation

# delete_integration method definition

await 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 session.create_client("apigateway").delete_integration_response method. boto3 documentation

# delete_integration_response method definition

await 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 session.create_client("apigateway").delete_method method. boto3 documentation

# delete_method method definition

await 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 session.create_client("apigateway").delete_method_response method. boto3 documentation

# delete_method_response method definition

await 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 session.create_client("apigateway").delete_model method. boto3 documentation

# delete_model method definition

await 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 session.create_client("apigateway").delete_request_validator method. boto3 documentation

# delete_request_validator method definition

await 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 session.create_client("apigateway").delete_resource method. boto3 documentation

# delete_resource method definition

await 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 session.create_client("apigateway").delete_rest_api method. boto3 documentation

# delete_rest_api method definition

await 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 session.create_client("apigateway").delete_stage method. boto3 documentation

# delete_stage method definition

await 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 session.create_client("apigateway").delete_usage_plan method. boto3 documentation

# delete_usage_plan method definition

await 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 session.create_client("apigateway").delete_usage_plan_key method. boto3 documentation

# delete_usage_plan_key method definition

await 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

delete_vpc_link

Deletes an existing VpcLink of a specified identifier.

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

# delete_vpc_link method definition

await 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 session.create_client("apigateway").flush_stage_authorizers_cache method. boto3 documentation

# flush_stage_authorizers_cache method definition

await 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 session.create_client("apigateway").flush_stage_cache method. boto3 documentation

# flush_stage_cache method definition

await 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 session.create_client("apigateway").generate_client_certificate method. boto3 documentation

# generate_client_certificate method definition

await def generate_client_certificate(
    self,
    *,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> ClientCertificateResponseTypeDef:  # (1)
    ...

1. See ClientCertificateResponseTypeDef

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

# generate_presigned_url method definition

await 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 session.create_client("apigateway").get_account method. boto3 documentation

# get_account method definition

await 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 session.create_client("apigateway").get_api_key method. boto3 documentation

# get_api_key method definition

await def get_api_key(
    self,
    *,
    apiKey: str,
    includeValue: bool = ...,
) -> ApiKeyResponseTypeDef:  # (1)
    ...

1. See ApiKeyResponseTypeDef

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

# get_api_keys method definition

await 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 session.create_client("apigateway").get_authorizer method. boto3 documentation

# get_authorizer method definition

await def get_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
) -> AuthorizerResponseTypeDef:  # (1)
    ...

1. See AuthorizerResponseTypeDef

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

# get_authorizers method definition

await 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 session.create_client("apigateway").get_base_path_mapping method. boto3 documentation

# get_base_path_mapping method definition

await def get_base_path_mapping(
    self,
    *,
    domainName: str,
    basePath: str,
) -> BasePathMappingResponseTypeDef:  # (1)
    ...

1. See BasePathMappingResponseTypeDef

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

# get_base_path_mappings method definition

await 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 session.create_client("apigateway").get_client_certificate method. boto3 documentation

# get_client_certificate method definition

await def get_client_certificate(
    self,
    *,
    clientCertificateId: str,
) -> ClientCertificateResponseTypeDef:  # (1)
    ...

1. See ClientCertificateResponseTypeDef

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

# get_client_certificates method definition

await 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 session.create_client("apigateway").get_deployment method. boto3 documentation

# get_deployment method definition

await def get_deployment(
    self,
    *,
    restApiId: str,
    deploymentId: str,
    embed: Sequence[str] = ...,
) -> DeploymentResponseTypeDef:  # (1)
    ...

1. See DeploymentResponseTypeDef

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

# get_deployments method definition

await 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 session.create_client("apigateway").get_documentation_part method. boto3 documentation

# get_documentation_part method definition

await def get_documentation_part(
    self,
    *,
    restApiId: str,
    documentationPartId: str,
) -> DocumentationPartResponseTypeDef:  # (1)
    ...

1. See DocumentationPartResponseTypeDef

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

# get_documentation_parts method definition

await 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 session.create_client("apigateway").get_documentation_version method. boto3 documentation

# get_documentation_version method definition

await def get_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
) -> DocumentationVersionResponseTypeDef:  # (1)
    ...

1. See DocumentationVersionResponseTypeDef

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

# get_documentation_versions method definition

await 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 session.create_client("apigateway").get_domain_name method. boto3 documentation

# get_domain_name method definition

await def get_domain_name(
    self,
    *,
    domainName: str,
) -> DomainNameResponseTypeDef:  # (1)
    ...

1. See DomainNameResponseTypeDef

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

# get_domain_names method definition

await 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 session.create_client("apigateway").get_export method. boto3 documentation

# get_export method definition

await 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 session.create_client("apigateway").get_gateway_response method. boto3 documentation

# get_gateway_response method definition

await def get_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
) -> GatewayResponseResponseTypeDef:  # (2)
    ...

1. See GatewayResponseTypeType
2. See GatewayResponseResponseTypeDef

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

# get_gateway_responses method definition

await 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 session.create_client("apigateway").get_integration method. boto3 documentation

# get_integration method definition

await def get_integration(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> IntegrationExtraResponseTypeDef:  # (1)
    ...

1. See IntegrationExtraResponseTypeDef

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

# get_integration_response method definition

await def get_integration_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> IntegrationResponseResponseTypeDef:  # (1)
    ...

1. See IntegrationResponseResponseTypeDef

# get_integration_response method usage example with argument unpacking

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

parent.get_integration_response(**kwargs)

1. See GetIntegrationResponseRequestRequestTypeDef

get_method

Describe an existing Method resource.

Type annotations and code completion for session.create_client("apigateway").get_method method. boto3 documentation

# get_method method definition

await def get_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
) -> MethodExtraResponseTypeDef:  # (1)
    ...

1. See MethodExtraResponseTypeDef

# get_method method usage example with argument unpacking

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

parent.get_method(**kwargs)

1. See GetMethodRequestRequestTypeDef

get_method_response

Describes a MethodResponse resource.

Type annotations and code completion for session.create_client("apigateway").get_method_response method. boto3 documentation

# get_method_response method definition

await def get_method_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
) -> MethodResponseResponseTypeDef:  # (1)
    ...

1. See MethodResponseResponseTypeDef

# get_method_response method usage example with argument unpacking

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

parent.get_method_response(**kwargs)

1. See GetMethodResponseRequestRequestTypeDef

get_model

Describes an existing model defined for a RestApi resource.

Type annotations and code completion for session.create_client("apigateway").get_model method. boto3 documentation

# get_model method definition

await def get_model(
    self,
    *,
    restApiId: str,
    modelName: str,
    flatten: bool = ...,
) -> ModelResponseTypeDef:  # (1)
    ...

1. See ModelResponseTypeDef

# get_model method usage example with argument unpacking

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

parent.get_model(**kwargs)

1. See GetModelRequestRequestTypeDef

get_model_template

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Type annotations and code completion for session.create_client("apigateway").get_model_template method. boto3 documentation

# get_model_template method definition

await def get_model_template(
    self,
    *,
    restApiId: str,
    modelName: str,
) -> TemplateTypeDef:  # (1)
    ...

1. See TemplateTypeDef

# get_model_template method usage example with argument unpacking

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

parent.get_model_template(**kwargs)

1. See GetModelTemplateRequestRequestTypeDef

get_models

Describes existing Models defined for a RestApi resource.

Type annotations and code completion for session.create_client("apigateway").get_models method. boto3 documentation

# get_models method definition

await def get_models(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> ModelsTypeDef:  # (1)
    ...

1. See ModelsTypeDef

# get_models method usage example with argument unpacking

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

parent.get_models(**kwargs)

1. See GetModelsRequestRequestTypeDef

get_request_validator

Gets a RequestValidator of a given RestApi.

Type annotations and code completion for session.create_client("apigateway").get_request_validator method. boto3 documentation

# get_request_validator method definition

await def get_request_validator(
    self,
    *,
    restApiId: str,
    requestValidatorId: str,
) -> RequestValidatorResponseTypeDef:  # (1)
    ...

1. See RequestValidatorResponseTypeDef

# get_request_validator method usage example with argument unpacking

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

parent.get_request_validator(**kwargs)

1. See GetRequestValidatorRequestRequestTypeDef

get_request_validators

Gets the RequestValidators collection of a given RestApi.

Type annotations and code completion for session.create_client("apigateway").get_request_validators method. boto3 documentation

# get_request_validators method definition

await def get_request_validators(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
) -> RequestValidatorsTypeDef:  # (1)
    ...

1. See RequestValidatorsTypeDef

# get_request_validators method usage example with argument unpacking

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

parent.get_request_validators(**kwargs)

1. See GetRequestValidatorsRequestRequestTypeDef

get_resource

Lists information about a resource.

Type annotations and code completion for session.create_client("apigateway").get_resource method. boto3 documentation

# get_resource method definition

await def get_resource(
    self,
    *,
    restApiId: str,
    resourceId: str,
    embed: Sequence[str] = ...,
) -> ResourceResponseTypeDef:  # (1)
    ...

1. See ResourceResponseTypeDef

# get_resource method usage example with argument unpacking

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

parent.get_resource(**kwargs)

1. See GetResourceRequestRequestTypeDef

get_resources

Lists information about a collection of Resource resources.

Type annotations and code completion for session.create_client("apigateway").get_resources method. boto3 documentation

# get_resources method definition

await def get_resources(
    self,
    *,
    restApiId: str,
    position: str = ...,
    limit: int = ...,
    embed: Sequence[str] = ...,
) -> ResourcesTypeDef:  # (1)
    ...

1. See ResourcesTypeDef

# get_resources method usage example with argument unpacking

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

parent.get_resources(**kwargs)

1. See GetResourcesRequestRequestTypeDef

get_rest_api

Lists the RestApi resource in the collection.

Type annotations and code completion for session.create_client("apigateway").get_rest_api method. boto3 documentation

# get_rest_api method definition

await def get_rest_api(
    self,
    *,
    restApiId: str,
) -> RestApiResponseTypeDef:  # (1)
    ...

1. See RestApiResponseTypeDef

# get_rest_api method usage example with argument unpacking

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

parent.get_rest_api(**kwargs)

1. See GetRestApiRequestRequestTypeDef

get_rest_apis

Lists the RestApis resources for your collection.

Type annotations and code completion for session.create_client("apigateway").get_rest_apis method. boto3 documentation

# get_rest_apis method definition

await def get_rest_apis(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> RestApisTypeDef:  # (1)
    ...

1. See RestApisTypeDef

# get_rest_apis method usage example with argument unpacking

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

parent.get_rest_apis(**kwargs)

1. See GetRestApisRequestRequestTypeDef

get_sdk

Generates a client SDK for a RestApi and Stage.

Type annotations and code completion for session.create_client("apigateway").get_sdk method. boto3 documentation

# get_sdk method definition

await def get_sdk(
    self,
    *,
    restApiId: str,
    stageName: str,
    sdkType: str,
    parameters: Mapping[str, str] = ...,
) -> SdkResponseTypeDef:  # (1)
    ...

1. See SdkResponseTypeDef

# get_sdk method usage example with argument unpacking

kwargs: GetSdkRequestRequestTypeDef = {  # (1)
    "restApiId": ...,
    "stageName": ...,
    "sdkType": ...,
}

parent.get_sdk(**kwargs)

1. See GetSdkRequestRequestTypeDef

get_sdk_type

Gets an SDK type.

Type annotations and code completion for session.create_client("apigateway").get_sdk_type method. boto3 documentation

# get_sdk_type method definition

await def get_sdk_type(
    self,
    *,
    id: str,
) -> SdkTypeResponseTypeDef:  # (1)
    ...

1. See SdkTypeResponseTypeDef

# get_sdk_type method usage example with argument unpacking

kwargs: GetSdkTypeRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_sdk_type(**kwargs)

1. See GetSdkTypeRequestRequestTypeDef

get_sdk_types

Gets SDK types See also: AWS API Documentation.

Type annotations and code completion for session.create_client("apigateway").get_sdk_types method. boto3 documentation

# get_sdk_types method definition

await def get_sdk_types(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> SdkTypesTypeDef:  # (1)
    ...

1. See SdkTypesTypeDef

# get_sdk_types method usage example with argument unpacking

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

parent.get_sdk_types(**kwargs)

1. See GetSdkTypesRequestRequestTypeDef

get_stage

Gets information about a Stage resource.

Type annotations and code completion for session.create_client("apigateway").get_stage method. boto3 documentation

# get_stage method definition

await def get_stage(
    self,
    *,
    restApiId: str,
    stageName: str,
) -> StageResponseTypeDef:  # (1)
    ...

1. See StageResponseTypeDef

# get_stage method usage example with argument unpacking

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

parent.get_stage(**kwargs)

1. See GetStageRequestRequestTypeDef

get_stages

Gets information about one or more Stage resources.

Type annotations and code completion for session.create_client("apigateway").get_stages method. boto3 documentation

# get_stages method definition

await def get_stages(
    self,
    *,
    restApiId: str,
    deploymentId: str = ...,
) -> StagesTypeDef:  # (1)
    ...

1. See StagesTypeDef

# get_stages method usage example with argument unpacking

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

parent.get_stages(**kwargs)

1. See GetStagesRequestRequestTypeDef

get_tags

Gets the Tags collection for a given resource.

Type annotations and code completion for session.create_client("apigateway").get_tags method. boto3 documentation

# get_tags method definition

await def get_tags(
    self,
    *,
    resourceArn: str,
    position: str = ...,
    limit: int = ...,
) -> TagsTypeDef:  # (1)
    ...

1. See TagsTypeDef

# get_tags method usage example with argument unpacking

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

parent.get_tags(**kwargs)

1. See GetTagsRequestRequestTypeDef

get_usage

Gets the usage data of a usage plan in a specified time interval.

Type annotations and code completion for session.create_client("apigateway").get_usage method. boto3 documentation

# get_usage method definition

await def get_usage(
    self,
    *,
    usagePlanId: str,
    startDate: str,
    endDate: str,
    keyId: str = ...,
    position: str = ...,
    limit: int = ...,
) -> UsageTypeDef:  # (1)
    ...

1. See UsageTypeDef

# get_usage method usage example with argument unpacking

kwargs: GetUsageRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
    "startDate": ...,
    "endDate": ...,
}

parent.get_usage(**kwargs)

1. See GetUsageRequestRequestTypeDef

get_usage_plan

Gets a usage plan of a given plan identifier.

Type annotations and code completion for session.create_client("apigateway").get_usage_plan method. boto3 documentation

# get_usage_plan method definition

await def get_usage_plan(
    self,
    *,
    usagePlanId: str,
) -> UsagePlanResponseTypeDef:  # (1)
    ...

1. See UsagePlanResponseTypeDef

# get_usage_plan method usage example with argument unpacking

kwargs: GetUsagePlanRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
}

parent.get_usage_plan(**kwargs)

1. See GetUsagePlanRequestRequestTypeDef

get_usage_plan_key

Gets a usage plan key of a given key identifier.

Type annotations and code completion for session.create_client("apigateway").get_usage_plan_key method. boto3 documentation

# get_usage_plan_key method definition

await def get_usage_plan_key(
    self,
    *,
    usagePlanId: str,
    keyId: str,
) -> UsagePlanKeyResponseTypeDef:  # (1)
    ...

1. See UsagePlanKeyResponseTypeDef

# get_usage_plan_key method usage example with argument unpacking

kwargs: GetUsagePlanKeyRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
    "keyId": ...,
}

parent.get_usage_plan_key(**kwargs)

1. See GetUsagePlanKeyRequestRequestTypeDef

get_usage_plan_keys

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Type annotations and code completion for session.create_client("apigateway").get_usage_plan_keys method. boto3 documentation

# get_usage_plan_keys method definition

await def get_usage_plan_keys(
    self,
    *,
    usagePlanId: str,
    position: str = ...,
    limit: int = ...,
    nameQuery: str = ...,
) -> UsagePlanKeysTypeDef:  # (1)
    ...

1. See UsagePlanKeysTypeDef

# get_usage_plan_keys method usage example with argument unpacking

kwargs: GetUsagePlanKeysRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
}

parent.get_usage_plan_keys(**kwargs)

1. See GetUsagePlanKeysRequestRequestTypeDef

get_usage_plans

Gets all the usage plans of the caller's account.

Type annotations and code completion for session.create_client("apigateway").get_usage_plans method. boto3 documentation

# get_usage_plans method definition

await def get_usage_plans(
    self,
    *,
    position: str = ...,
    keyId: str = ...,
    limit: int = ...,
) -> UsagePlansTypeDef:  # (1)
    ...

1. See UsagePlansTypeDef

# get_usage_plans method usage example with argument unpacking

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

parent.get_usage_plans(**kwargs)

1. See GetUsagePlansRequestRequestTypeDef

get_vpc_link

Gets a specified VPC link under the caller's account in a region.

Type annotations and code completion for session.create_client("apigateway").get_vpc_link method. boto3 documentation

# get_vpc_link method definition

await def get_vpc_link(
    self,
    *,
    vpcLinkId: str,
) -> VpcLinkResponseTypeDef:  # (1)
    ...

1. See VpcLinkResponseTypeDef

# get_vpc_link method usage example with argument unpacking

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

parent.get_vpc_link(**kwargs)

1. See GetVpcLinkRequestRequestTypeDef

get_vpc_links

Gets the VpcLinks collection under the caller's account in a selected region.

Type annotations and code completion for session.create_client("apigateway").get_vpc_links method. boto3 documentation

# get_vpc_links method definition

await def get_vpc_links(
    self,
    *,
    position: str = ...,
    limit: int = ...,
) -> VpcLinksTypeDef:  # (1)
    ...

1. See VpcLinksTypeDef

# get_vpc_links method usage example with argument unpacking

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

parent.get_vpc_links(**kwargs)

1. See GetVpcLinksRequestRequestTypeDef

import_api_keys

Import API keys from an external source, such as a CSV-formatted file.

Type annotations and code completion for session.create_client("apigateway").import_api_keys method. boto3 documentation

# import_api_keys method definition

await def import_api_keys(
    self,
    *,
    body: Union[str, bytes, IO[Any], StreamingBody],
    format: ApiKeysFormatType,  # (1)
    failOnWarnings: bool = ...,
) -> ApiKeyIdsTypeDef:  # (2)
    ...

1. See ApiKeysFormatType
2. See ApiKeyIdsTypeDef

# import_api_keys method usage example with argument unpacking

kwargs: ImportApiKeysRequestRequestTypeDef = {  # (1)
    "body": ...,
    "format": ...,
}

parent.import_api_keys(**kwargs)

1. See ImportApiKeysRequestRequestTypeDef

import_documentation_parts

Imports documentation parts See also: AWS API Documentation.

Type annotations and code completion for session.create_client("apigateway").import_documentation_parts method. boto3 documentation

# import_documentation_parts method definition

await def import_documentation_parts(
    self,
    *,
    restApiId: str,
    body: Union[str, bytes, IO[Any], StreamingBody],
    mode: PutModeType = ...,  # (1)
    failOnWarnings: bool = ...,
) -> DocumentationPartIdsTypeDef:  # (2)
    ...

1. See PutModeType
2. See DocumentationPartIdsTypeDef

# import_documentation_parts method usage example with argument unpacking

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

parent.import_documentation_parts(**kwargs)

1. See ImportDocumentationPartsRequestRequestTypeDef

import_rest_api

A feature of the API Gateway control service for creating a new API from an external API definition file.

Type annotations and code completion for session.create_client("apigateway").import_rest_api method. boto3 documentation

# import_rest_api method definition

await def import_rest_api(
    self,
    *,
    body: Union[str, bytes, IO[Any], StreamingBody],
    failOnWarnings: bool = ...,
    parameters: Mapping[str, str] = ...,
) -> RestApiResponseTypeDef:  # (1)
    ...

1. See RestApiResponseTypeDef

# import_rest_api method usage example with argument unpacking

kwargs: ImportRestApiRequestRequestTypeDef = {  # (1)
    "body": ...,
}

parent.import_rest_api(**kwargs)

1. See ImportRestApiRequestRequestTypeDef

put_gateway_response

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Type annotations and code completion for session.create_client("apigateway").put_gateway_response method. boto3 documentation

# put_gateway_response method definition

await def put_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
    statusCode: str = ...,
    responseParameters: Mapping[str, str] = ...,
    responseTemplates: Mapping[str, str] = ...,
) -> GatewayResponseResponseTypeDef:  # (2)
    ...

1. See GatewayResponseTypeType
2. See GatewayResponseResponseTypeDef

# put_gateway_response method usage example with argument unpacking

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

parent.put_gateway_response(**kwargs)

1. See PutGatewayResponseRequestRequestTypeDef

put_integration

Sets up a method's integration.

Type annotations and code completion for session.create_client("apigateway").put_integration method. boto3 documentation

# put_integration method definition

await def put_integration(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    type: IntegrationTypeType,  # (1)
    integrationHttpMethod: str = ...,
    uri: str = ...,
    connectionType: ConnectionTypeType = ...,  # (2)
    connectionId: str = ...,
    credentials: str = ...,
    requestParameters: Mapping[str, str] = ...,
    requestTemplates: Mapping[str, str] = ...,
    passthroughBehavior: str = ...,
    cacheNamespace: str = ...,
    cacheKeyParameters: Sequence[str] = ...,
    contentHandling: ContentHandlingStrategyType = ...,  # (3)
    timeoutInMillis: int = ...,
    tlsConfig: TlsConfigTypeDef = ...,  # (4)
) -> IntegrationExtraResponseTypeDef:  # (5)
    ...

1. See IntegrationTypeType
2. See ConnectionTypeType
3. See ContentHandlingStrategyType
4. See TlsConfigTypeDef
5. See IntegrationExtraResponseTypeDef

# put_integration method usage example with argument unpacking

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

parent.put_integration(**kwargs)

1. See PutIntegrationRequestRequestTypeDef

put_integration_response

Represents a put integration.

Type annotations and code completion for session.create_client("apigateway").put_integration_response method. boto3 documentation

# put_integration_response method definition

await def put_integration_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    selectionPattern: str = ...,
    responseParameters: Mapping[str, str] = ...,
    responseTemplates: Mapping[str, str] = ...,
    contentHandling: ContentHandlingStrategyType = ...,  # (1)
) -> IntegrationResponseResponseTypeDef:  # (2)
    ...

1. See ContentHandlingStrategyType
2. See IntegrationResponseResponseTypeDef

# put_integration_response method usage example with argument unpacking

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

parent.put_integration_response(**kwargs)

1. See PutIntegrationResponseRequestRequestTypeDef

put_method

Add a method to an existing Resource resource.

Type annotations and code completion for session.create_client("apigateway").put_method method. boto3 documentation

# put_method method definition

await def put_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    authorizationType: str,
    authorizerId: str = ...,
    apiKeyRequired: bool = ...,
    operationName: str = ...,
    requestParameters: Mapping[str, bool] = ...,
    requestModels: Mapping[str, str] = ...,
    requestValidatorId: str = ...,
    authorizationScopes: Sequence[str] = ...,
) -> MethodExtraResponseTypeDef:  # (1)
    ...

1. See MethodExtraResponseTypeDef

# put_method method usage example with argument unpacking

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

parent.put_method(**kwargs)

1. See PutMethodRequestRequestTypeDef

put_method_response

Adds a MethodResponse to an existing Method resource.

Type annotations and code completion for session.create_client("apigateway").put_method_response method. boto3 documentation

# put_method_response method definition

await def put_method_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    responseParameters: Mapping[str, bool] = ...,
    responseModels: Mapping[str, str] = ...,
) -> MethodResponseResponseTypeDef:  # (1)
    ...

1. See MethodResponseResponseTypeDef

# put_method_response method usage example with argument unpacking

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

parent.put_method_response(**kwargs)

1. See PutMethodResponseRequestRequestTypeDef

put_rest_api

A feature of the API Gateway control service for updating an existing API with an input of external API definitions.

Type annotations and code completion for session.create_client("apigateway").put_rest_api method. boto3 documentation

# put_rest_api method definition

await def put_rest_api(
    self,
    *,
    restApiId: str,
    body: Union[str, bytes, IO[Any], StreamingBody],
    mode: PutModeType = ...,  # (1)
    failOnWarnings: bool = ...,
    parameters: Mapping[str, str] = ...,
) -> RestApiResponseTypeDef:  # (2)
    ...

1. See PutModeType
2. See RestApiResponseTypeDef

# put_rest_api method usage example with argument unpacking

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

parent.put_rest_api(**kwargs)

1. See PutRestApiRequestRequestTypeDef

tag_resource

Adds or updates a tag on a given resource.

Type annotations and code completion for session.create_client("apigateway").tag_resource method. boto3 documentation

# tag_resource method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

test_invoke_authorizer

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Type annotations and code completion for session.create_client("apigateway").test_invoke_authorizer method. boto3 documentation

# test_invoke_authorizer method definition

await def test_invoke_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
    headers: Mapping[str, str] = ...,
    multiValueHeaders: Mapping[str, Sequence[str]] = ...,
    pathWithQueryString: str = ...,
    body: str = ...,
    stageVariables: Mapping[str, str] = ...,
    additionalContext: Mapping[str, str] = ...,
) -> TestInvokeAuthorizerResponseTypeDef:  # (1)
    ...

1. See TestInvokeAuthorizerResponseTypeDef

# test_invoke_authorizer method usage example with argument unpacking

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

parent.test_invoke_authorizer(**kwargs)

1. See TestInvokeAuthorizerRequestRequestTypeDef

test_invoke_method

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

Type annotations and code completion for session.create_client("apigateway").test_invoke_method method. boto3 documentation

# test_invoke_method method definition

await def test_invoke_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    pathWithQueryString: str = ...,
    body: str = ...,
    headers: Mapping[str, str] = ...,
    multiValueHeaders: Mapping[str, Sequence[str]] = ...,
    clientCertificateId: str = ...,
    stageVariables: Mapping[str, str] = ...,
) -> TestInvokeMethodResponseTypeDef:  # (1)
    ...

1. See TestInvokeMethodResponseTypeDef

# test_invoke_method method usage example with argument unpacking

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

parent.test_invoke_method(**kwargs)

1. See TestInvokeMethodRequestRequestTypeDef

untag_resource

Removes a tag from a given resource.

Type annotations and code completion for session.create_client("apigateway").untag_resource method. boto3 documentation

# untag_resource method definition

await 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_account

Changes information about the current Account resource.

Type annotations and code completion for session.create_client("apigateway").update_account method. boto3 documentation

# update_account method definition

await def update_account(
    self,
    *,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> AccountTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See AccountTypeDef

# update_account method usage example with argument unpacking

kwargs: UpdateAccountRequestRequestTypeDef = {  # (1)
    "patchOperations": ...,
}

parent.update_account(**kwargs)

1. See UpdateAccountRequestRequestTypeDef

update_api_key

Changes information about an ApiKey resource.

Type annotations and code completion for session.create_client("apigateway").update_api_key method. boto3 documentation

# update_api_key method definition

await def update_api_key(
    self,
    *,
    apiKey: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> ApiKeyResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See ApiKeyResponseTypeDef

# update_api_key method usage example with argument unpacking

kwargs: UpdateApiKeyRequestRequestTypeDef = {  # (1)
    "apiKey": ...,
}

parent.update_api_key(**kwargs)

1. See UpdateApiKeyRequestRequestTypeDef

update_authorizer

Updates an existing Authorizer resource.

Type annotations and code completion for session.create_client("apigateway").update_authorizer method. boto3 documentation

# update_authorizer method definition

await def update_authorizer(
    self,
    *,
    restApiId: str,
    authorizerId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> AuthorizerResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See AuthorizerResponseTypeDef

# update_authorizer method usage example with argument unpacking

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

parent.update_authorizer(**kwargs)

1. See UpdateAuthorizerRequestRequestTypeDef

update_base_path_mapping

Changes information about the BasePathMapping resource.

Type annotations and code completion for session.create_client("apigateway").update_base_path_mapping method. boto3 documentation

# update_base_path_mapping method definition

await def update_base_path_mapping(
    self,
    *,
    domainName: str,
    basePath: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> BasePathMappingResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See BasePathMappingResponseTypeDef

# update_base_path_mapping method usage example with argument unpacking

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

parent.update_base_path_mapping(**kwargs)

1. See UpdateBasePathMappingRequestRequestTypeDef

update_client_certificate

Changes information about an ClientCertificate resource.

Type annotations and code completion for session.create_client("apigateway").update_client_certificate method. boto3 documentation

# update_client_certificate method definition

await def update_client_certificate(
    self,
    *,
    clientCertificateId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> ClientCertificateResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See ClientCertificateResponseTypeDef

# update_client_certificate method usage example with argument unpacking

kwargs: UpdateClientCertificateRequestRequestTypeDef = {  # (1)
    "clientCertificateId": ...,
}

parent.update_client_certificate(**kwargs)

1. See UpdateClientCertificateRequestRequestTypeDef

update_deployment

Changes information about a Deployment resource.

Type annotations and code completion for session.create_client("apigateway").update_deployment method. boto3 documentation

# update_deployment method definition

await def update_deployment(
    self,
    *,
    restApiId: str,
    deploymentId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> DeploymentResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See DeploymentResponseTypeDef

# update_deployment method usage example with argument unpacking

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

parent.update_deployment(**kwargs)

1. See UpdateDeploymentRequestRequestTypeDef

update_documentation_part

Updates a documentation part.

Type annotations and code completion for session.create_client("apigateway").update_documentation_part method. boto3 documentation

# update_documentation_part method definition

await def update_documentation_part(
    self,
    *,
    restApiId: str,
    documentationPartId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> DocumentationPartResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See DocumentationPartResponseTypeDef

# update_documentation_part method usage example with argument unpacking

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

parent.update_documentation_part(**kwargs)

1. See UpdateDocumentationPartRequestRequestTypeDef

update_documentation_version

Updates a documentation version.

Type annotations and code completion for session.create_client("apigateway").update_documentation_version method. boto3 documentation

# update_documentation_version method definition

await def update_documentation_version(
    self,
    *,
    restApiId: str,
    documentationVersion: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> DocumentationVersionResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See DocumentationVersionResponseTypeDef

# update_documentation_version method usage example with argument unpacking

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

parent.update_documentation_version(**kwargs)

1. See UpdateDocumentationVersionRequestRequestTypeDef

update_domain_name

Changes information about the DomainName resource.

Type annotations and code completion for session.create_client("apigateway").update_domain_name method. boto3 documentation

# update_domain_name method definition

await def update_domain_name(
    self,
    *,
    domainName: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> DomainNameResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See DomainNameResponseTypeDef

# update_domain_name method usage example with argument unpacking

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

parent.update_domain_name(**kwargs)

1. See UpdateDomainNameRequestRequestTypeDef

update_gateway_response

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

Type annotations and code completion for session.create_client("apigateway").update_gateway_response method. boto3 documentation

# update_gateway_response method definition

await def update_gateway_response(
    self,
    *,
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (2)
) -> GatewayResponseResponseTypeDef:  # (3)
    ...

1. See GatewayResponseTypeType
2. See PatchOperationTypeDef
3. See GatewayResponseResponseTypeDef

# update_gateway_response method usage example with argument unpacking

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

parent.update_gateway_response(**kwargs)

1. See UpdateGatewayResponseRequestRequestTypeDef

update_integration

Represents an update integration.

Type annotations and code completion for session.create_client("apigateway").update_integration method. boto3 documentation

# update_integration method definition

await def update_integration(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> IntegrationExtraResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See IntegrationExtraResponseTypeDef

# update_integration method usage example with argument unpacking

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

parent.update_integration(**kwargs)

1. See UpdateIntegrationRequestRequestTypeDef

update_integration_response

Represents an update integration response.

Type annotations and code completion for session.create_client("apigateway").update_integration_response method. boto3 documentation

# update_integration_response method definition

await def update_integration_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> IntegrationResponseResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See IntegrationResponseResponseTypeDef

# update_integration_response method usage example with argument unpacking

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

parent.update_integration_response(**kwargs)

1. See UpdateIntegrationResponseRequestRequestTypeDef

update_method

Updates an existing Method resource.

Type annotations and code completion for session.create_client("apigateway").update_method method. boto3 documentation

# update_method method definition

await def update_method(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> MethodExtraResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See MethodExtraResponseTypeDef

# update_method method usage example with argument unpacking

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

parent.update_method(**kwargs)

1. See UpdateMethodRequestRequestTypeDef

update_method_response

Updates an existing MethodResponse resource.

Type annotations and code completion for session.create_client("apigateway").update_method_response method. boto3 documentation

# update_method_response method definition

await def update_method_response(
    self,
    *,
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> MethodResponseResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See MethodResponseResponseTypeDef

# update_method_response method usage example with argument unpacking

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

parent.update_method_response(**kwargs)

1. See UpdateMethodResponseRequestRequestTypeDef

update_model

Changes information about a model.

Type annotations and code completion for session.create_client("apigateway").update_model method. boto3 documentation

# update_model method definition

await def update_model(
    self,
    *,
    restApiId: str,
    modelName: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> ModelResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See ModelResponseTypeDef

# update_model method usage example with argument unpacking

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

parent.update_model(**kwargs)

1. See UpdateModelRequestRequestTypeDef

update_request_validator

Updates a RequestValidator of a given RestApi.

Type annotations and code completion for session.create_client("apigateway").update_request_validator method. boto3 documentation

# update_request_validator method definition

await def update_request_validator(
    self,
    *,
    restApiId: str,
    requestValidatorId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> RequestValidatorResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See RequestValidatorResponseTypeDef

# update_request_validator method usage example with argument unpacking

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

parent.update_request_validator(**kwargs)

1. See UpdateRequestValidatorRequestRequestTypeDef

update_resource

Changes information about a Resource resource.

Type annotations and code completion for session.create_client("apigateway").update_resource method. boto3 documentation

# update_resource method definition

await def update_resource(
    self,
    *,
    restApiId: str,
    resourceId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> ResourceResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See ResourceResponseTypeDef

# update_resource method usage example with argument unpacking

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

parent.update_resource(**kwargs)

1. See UpdateResourceRequestRequestTypeDef

update_rest_api

Changes information about the specified API.

Type annotations and code completion for session.create_client("apigateway").update_rest_api method. boto3 documentation

# update_rest_api method definition

await def update_rest_api(
    self,
    *,
    restApiId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> RestApiResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See RestApiResponseTypeDef

# update_rest_api method usage example with argument unpacking

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

parent.update_rest_api(**kwargs)

1. See UpdateRestApiRequestRequestTypeDef

update_stage

Changes information about a Stage resource.

Type annotations and code completion for session.create_client("apigateway").update_stage method. boto3 documentation

# update_stage method definition

await def update_stage(
    self,
    *,
    restApiId: str,
    stageName: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> StageResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See StageResponseTypeDef

# update_stage method usage example with argument unpacking

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

parent.update_stage(**kwargs)

1. See UpdateStageRequestRequestTypeDef

update_usage

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Type annotations and code completion for session.create_client("apigateway").update_usage method. boto3 documentation

# update_usage method definition

await def update_usage(
    self,
    *,
    usagePlanId: str,
    keyId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> UsageTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See UsageTypeDef

# update_usage method usage example with argument unpacking

kwargs: UpdateUsageRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
    "keyId": ...,
}

parent.update_usage(**kwargs)

1. See UpdateUsageRequestRequestTypeDef

update_usage_plan

Updates a usage plan of a given plan Id.

Type annotations and code completion for session.create_client("apigateway").update_usage_plan method. boto3 documentation

# update_usage_plan method definition

await def update_usage_plan(
    self,
    *,
    usagePlanId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> UsagePlanResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See UsagePlanResponseTypeDef

# update_usage_plan method usage example with argument unpacking

kwargs: UpdateUsagePlanRequestRequestTypeDef = {  # (1)
    "usagePlanId": ...,
}

parent.update_usage_plan(**kwargs)

1. See UpdateUsagePlanRequestRequestTypeDef

update_vpc_link

Updates an existing VpcLink of a specified identifier.

Type annotations and code completion for session.create_client("apigateway").update_vpc_link method. boto3 documentation

# update_vpc_link method definition

await def update_vpc_link(
    self,
    *,
    vpcLinkId: str,
    patchOperations: Sequence[PatchOperationTypeDef] = ...,  # (1)
) -> VpcLinkResponseTypeDef:  # (2)
    ...

1. See PatchOperationTypeDef
2. See VpcLinkResponseTypeDef

# update_vpc_link method usage example with argument unpacking

kwargs: UpdateVpcLinkRequestRequestTypeDef = {  # (1)
    "vpcLinkId": ...,
}

parent.update_vpc_link(**kwargs)

1. See UpdateVpcLinkRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("apigateway").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> APIGatewayClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("apigateway").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.create_client("apigateway").get_paginator method with overloads.

• client.get_paginator("get_api_keys") -> GetApiKeysPaginator
• client.get_paginator("get_authorizers") -> GetAuthorizersPaginator
• client.get_paginator("get_base_path_mappings") -> GetBasePathMappingsPaginator
• client.get_paginator("get_client_certificates") -> GetClientCertificatesPaginator
• client.get_paginator("get_deployments") -> GetDeploymentsPaginator
• client.get_paginator("get_documentation_parts") -> GetDocumentationPartsPaginator
• client.get_paginator("get_documentation_versions") -> GetDocumentationVersionsPaginator
• client.get_paginator("get_domain_names") -> GetDomainNamesPaginator
• client.get_paginator("get_gateway_responses") -> GetGatewayResponsesPaginator
• client.get_paginator("get_models") -> GetModelsPaginator
• client.get_paginator("get_request_validators") -> GetRequestValidatorsPaginator
• client.get_paginator("get_resources") -> GetResourcesPaginator
• client.get_paginator("get_rest_apis") -> GetRestApisPaginator
• client.get_paginator("get_sdk_types") -> GetSdkTypesPaginator
• client.get_paginator("get_usage") -> GetUsagePaginator
• client.get_paginator("get_usage_plan_keys") -> GetUsagePlanKeysPaginator
• client.get_paginator("get_usage_plans") -> GetUsagePlansPaginator
• client.get_paginator("get_vpc_links") -> GetVpcLinksPaginator