APIGatewayClient#
Index > APIGateway > APIGatewayClient
Auto-generated documentation for APIGateway type annotations stubs module types-boto3-apigateway.
APIGatewayClient#
Type annotations and code completion for boto3.client("apigateway").
boto3 documentation
# APIGatewayClient usage example
from boto3.session import Session
from types_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 types_boto3_apigateway.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...Methods#
can_paginate#
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:
...generate_presigned_url#
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:
...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] = ...,
) -> ApiKeyResponseTypeDef: # (2)
...- See
Sequence[StageKeyTypeDef] - See ApiKeyResponseTypeDef
# create_api_key method usage example with argument unpacking
kwargs: CreateApiKeyRequestTypeDef = { # (1)
"name": ...,
}
parent.create_api_key(**kwargs)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 = ...,
) -> AuthorizerResponseTypeDef: # (2)
...# create_authorizer method usage example with argument unpacking
kwargs: CreateAuthorizerRequestTypeDef = { # (1)
"restApiId": ...,
"name": ...,
"type": ...,
}
parent.create_authorizer(**kwargs)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,
domainNameId: str = ...,
basePath: str = ...,
stage: str = ...,
) -> BasePathMappingResponseTypeDef: # (1)
...# create_base_path_mapping method usage example with argument unpacking
kwargs: CreateBasePathMappingRequestTypeDef = { # (1)
"domainName": ...,
"restApiId": ...,
}
parent.create_base_path_mapping(**kwargs)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 = ...,
) -> DeploymentResponseTypeDef: # (3)
...# create_deployment method usage example with argument unpacking
kwargs: CreateDeploymentRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.create_deployment(**kwargs)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,
) -> DocumentationPartResponseTypeDef: # (2)
...# create_documentation_part method usage example with argument unpacking
kwargs: CreateDocumentationPartRequestTypeDef = { # (1)
"restApiId": ...,
"location": ...,
"properties": ...,
}
parent.create_documentation_part(**kwargs)create_documentation_version#
Creates a documentation version.
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 = ...,
) -> DocumentationVersionResponseTypeDef: # (1)
...# create_documentation_version method usage example with argument unpacking
kwargs: CreateDocumentationVersionRequestTypeDef = { # (1)
"restApiId": ...,
"documentationVersion": ...,
}
parent.create_documentation_version(**kwargs)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: EndpointConfigurationUnionTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
securityPolicy: SecurityPolicyType = ..., # (2)
mutualTlsAuthentication: MutualTlsAuthenticationInputTypeDef = ..., # (3)
ownershipVerificationCertificateArn: str = ...,
policy: str = ...,
routingMode: RoutingModeType = ..., # (4)
) -> DomainNameResponseTypeDef: # (5)
...- See EndpointConfigurationUnionTypeDef
- See SecurityPolicyType
- See MutualTlsAuthenticationInputTypeDef
- See RoutingModeType
- See DomainNameResponseTypeDef
# create_domain_name method usage example with argument unpacking
kwargs: CreateDomainNameRequestTypeDef = { # (1)
"domainName": ...,
}
parent.create_domain_name(**kwargs)create_domain_name_access_association#
Creates a domain name access association resource between an access association source and a private custom domain name.
Type annotations and code completion for boto3.client("apigateway").create_domain_name_access_association method.
boto3 documentation
# create_domain_name_access_association method definition
def create_domain_name_access_association(
self,
*,
domainNameArn: str,
accessAssociationSourceType: AccessAssociationSourceTypeType, # (1)
accessAssociationSource: str,
tags: Mapping[str, str] = ...,
) -> DomainNameAccessAssociationResponseTypeDef: # (2)
...# create_domain_name_access_association method usage example with argument unpacking
kwargs: CreateDomainNameAccessAssociationRequestTypeDef = { # (1)
"domainNameArn": ...,
"accessAssociationSourceType": ...,
"accessAssociationSource": ...,
}
parent.create_domain_name_access_association(**kwargs)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 = ...,
) -> ModelResponseTypeDef: # (1)
...# create_model method usage example with argument unpacking
kwargs: CreateModelRequestTypeDef = { # (1)
"restApiId": ...,
"name": ...,
"contentType": ...,
}
parent.create_model(**kwargs)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 = ...,
) -> RequestValidatorResponseTypeDef: # (1)
...# create_request_validator method usage example with argument unpacking
kwargs: CreateRequestValidatorRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.create_request_validator(**kwargs)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,
) -> ResourceResponseTypeDef: # (1)
...# create_resource method usage example with argument unpacking
kwargs: CreateResourceRequestTypeDef = { # (1)
"restApiId": ...,
"parentId": ...,
"pathPart": ...,
}
parent.create_resource(**kwargs)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: EndpointConfigurationUnionTypeDef = ..., # (2)
policy: str = ...,
tags: Mapping[str, str] = ...,
disableExecuteApiEndpoint: bool = ...,
) -> RestApiResponseTypeDef: # (3)
...# create_rest_api method usage example with argument unpacking
kwargs: CreateRestApiRequestTypeDef = { # (1)
"name": ...,
}
parent.create_rest_api(**kwargs)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: CanarySettingsUnionTypeDef = ..., # (2)
tracingEnabled: bool = ...,
tags: Mapping[str, str] = ...,
) -> StageResponseTypeDef: # (3)
...# create_stage method usage example with argument unpacking
kwargs: CreateStageRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
"deploymentId": ...,
}
parent.create_stage(**kwargs)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[ApiStageUnionTypeDef] = ..., # (1)
throttle: ThrottleSettingsTypeDef = ..., # (2)
quota: QuotaSettingsTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
) -> UsagePlanResponseTypeDef: # (4)
...- See
Sequence[ApiStageUnionTypeDef] - See ThrottleSettingsTypeDef
- See QuotaSettingsTypeDef
- See UsagePlanResponseTypeDef
# create_usage_plan method usage example with argument unpacking
kwargs: CreateUsagePlanRequestTypeDef = { # (1)
"name": ...,
}
parent.create_usage_plan(**kwargs)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,
) -> UsagePlanKeyResponseTypeDef: # (1)
...# create_usage_plan_key method usage example with argument unpacking
kwargs: CreateUsagePlanKeyRequestTypeDef = { # (1)
"usagePlanId": ...,
"keyId": ...,
"keyType": ...,
}
parent.create_usage_plan_key(**kwargs)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 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] = ...,
) -> VpcLinkResponseTypeDef: # (1)
...# create_vpc_link method usage example with argument unpacking
kwargs: CreateVpcLinkRequestTypeDef = { # (1)
"name": ...,
"targetArns": ...,
}
parent.create_vpc_link(**kwargs)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)
...# delete_api_key method usage example with argument unpacking
kwargs: DeleteApiKeyRequestTypeDef = { # (1)
"apiKey": ...,
}
parent.delete_api_key(**kwargs)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)
...# delete_authorizer method usage example with argument unpacking
kwargs: DeleteAuthorizerRequestTypeDef = { # (1)
"restApiId": ...,
"authorizerId": ...,
}
parent.delete_authorizer(**kwargs)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,
domainNameId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_base_path_mapping method usage example with argument unpacking
kwargs: DeleteBasePathMappingRequestTypeDef = { # (1)
"domainName": ...,
"basePath": ...,
}
parent.delete_base_path_mapping(**kwargs)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)
...# delete_client_certificate method usage example with argument unpacking
kwargs: DeleteClientCertificateRequestTypeDef = { # (1)
"clientCertificateId": ...,
}
parent.delete_client_certificate(**kwargs)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)
...# delete_deployment method usage example with argument unpacking
kwargs: DeleteDeploymentRequestTypeDef = { # (1)
"restApiId": ...,
"deploymentId": ...,
}
parent.delete_deployment(**kwargs)delete_documentation_part#
Deletes a documentation part.
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)
...# delete_documentation_part method usage example with argument unpacking
kwargs: DeleteDocumentationPartRequestTypeDef = { # (1)
"restApiId": ...,
"documentationPartId": ...,
}
parent.delete_documentation_part(**kwargs)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)
...# delete_documentation_version method usage example with argument unpacking
kwargs: DeleteDocumentationVersionRequestTypeDef = { # (1)
"restApiId": ...,
"documentationVersion": ...,
}
parent.delete_documentation_version(**kwargs)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,
domainNameId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_domain_name method usage example with argument unpacking
kwargs: DeleteDomainNameRequestTypeDef = { # (1)
"domainName": ...,
}
parent.delete_domain_name(**kwargs)delete_domain_name_access_association#
Deletes the DomainNameAccessAssociation resource.
Type annotations and code completion for boto3.client("apigateway").delete_domain_name_access_association method.
boto3 documentation
# delete_domain_name_access_association method definition
def delete_domain_name_access_association(
self,
*,
domainNameAccessAssociationArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_domain_name_access_association method usage example with argument unpacking
kwargs: DeleteDomainNameAccessAssociationRequestTypeDef = { # (1)
"domainNameAccessAssociationArn": ...,
}
parent.delete_domain_name_access_association(**kwargs)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)
...# delete_gateway_response method usage example with argument unpacking
kwargs: DeleteGatewayResponseRequestTypeDef = { # (1)
"restApiId": ...,
"responseType": ...,
}
parent.delete_gateway_response(**kwargs)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)
...# delete_integration method usage example with argument unpacking
kwargs: DeleteIntegrationRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.delete_integration(**kwargs)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)
...# delete_integration_response method usage example with argument unpacking
kwargs: DeleteIntegrationResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.delete_integration_response(**kwargs)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)
...# delete_method method usage example with argument unpacking
kwargs: DeleteMethodRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.delete_method(**kwargs)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)
...# delete_method_response method usage example with argument unpacking
kwargs: DeleteMethodResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.delete_method_response(**kwargs)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)
...# delete_model method usage example with argument unpacking
kwargs: DeleteModelRequestTypeDef = { # (1)
"restApiId": ...,
"modelName": ...,
}
parent.delete_model(**kwargs)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)
...# delete_request_validator method usage example with argument unpacking
kwargs: DeleteRequestValidatorRequestTypeDef = { # (1)
"restApiId": ...,
"requestValidatorId": ...,
}
parent.delete_request_validator(**kwargs)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)
...# delete_resource method usage example with argument unpacking
kwargs: DeleteResourceRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
}
parent.delete_resource(**kwargs)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)
...# delete_rest_api method usage example with argument unpacking
kwargs: DeleteRestApiRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.delete_rest_api(**kwargs)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)
...# delete_stage method usage example with argument unpacking
kwargs: DeleteStageRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
}
parent.delete_stage(**kwargs)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)
...# delete_usage_plan method usage example with argument unpacking
kwargs: DeleteUsagePlanRequestTypeDef = { # (1)
"usagePlanId": ...,
}
parent.delete_usage_plan(**kwargs)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)
...# delete_usage_plan_key method usage example with argument unpacking
kwargs: DeleteUsagePlanKeyRequestTypeDef = { # (1)
"usagePlanId": ...,
"keyId": ...,
}
parent.delete_usage_plan_key(**kwargs)delete_vpc_link#
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)
...# delete_vpc_link method usage example with argument unpacking
kwargs: DeleteVpcLinkRequestTypeDef = { # (1)
"vpcLinkId": ...,
}
parent.delete_vpc_link(**kwargs)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)
...# flush_stage_authorizers_cache method usage example with argument unpacking
kwargs: FlushStageAuthorizersCacheRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
}
parent.flush_stage_authorizers_cache(**kwargs)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)
...# flush_stage_cache method usage example with argument unpacking
kwargs: FlushStageCacheRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
}
parent.flush_stage_cache(**kwargs)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] = ...,
) -> ClientCertificateResponseTypeDef: # (1)
...# generate_client_certificate method usage example with argument unpacking
kwargs: GenerateClientCertificateRequestTypeDef = { # (1)
"description": ...,
}
parent.generate_client_certificate(**kwargs)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)
...- 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 = ...,
) -> ApiKeyResponseTypeDef: # (1)
...# get_api_key method usage example with argument unpacking
kwargs: GetApiKeyRequestTypeDef = { # (1)
"apiKey": ...,
}
parent.get_api_key(**kwargs)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)
...- See ApiKeysTypeDef
# get_api_keys method usage example with argument unpacking
kwargs: GetApiKeysRequestTypeDef = { # (1)
"position": ...,
}
parent.get_api_keys(**kwargs)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,
) -> AuthorizerResponseTypeDef: # (1)
...# get_authorizer method usage example with argument unpacking
kwargs: GetAuthorizerRequestTypeDef = { # (1)
"restApiId": ...,
"authorizerId": ...,
}
parent.get_authorizer(**kwargs)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)
...# get_authorizers method usage example with argument unpacking
kwargs: GetAuthorizersRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_authorizers(**kwargs)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,
domainNameId: str = ...,
) -> BasePathMappingResponseTypeDef: # (1)
...# get_base_path_mapping method usage example with argument unpacking
kwargs: GetBasePathMappingRequestTypeDef = { # (1)
"domainName": ...,
"basePath": ...,
}
parent.get_base_path_mapping(**kwargs)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,
domainNameId: str = ...,
position: str = ...,
limit: int = ...,
) -> BasePathMappingsTypeDef: # (1)
...# get_base_path_mappings method usage example with argument unpacking
kwargs: GetBasePathMappingsRequestTypeDef = { # (1)
"domainName": ...,
}
parent.get_base_path_mappings(**kwargs)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,
) -> ClientCertificateResponseTypeDef: # (1)
...# get_client_certificate method usage example with argument unpacking
kwargs: GetClientCertificateRequestTypeDef = { # (1)
"clientCertificateId": ...,
}
parent.get_client_certificate(**kwargs)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)
...# get_client_certificates method usage example with argument unpacking
kwargs: GetClientCertificatesRequestTypeDef = { # (1)
"position": ...,
}
parent.get_client_certificates(**kwargs)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] = ...,
) -> DeploymentResponseTypeDef: # (1)
...# get_deployment method usage example with argument unpacking
kwargs: GetDeploymentRequestTypeDef = { # (1)
"restApiId": ...,
"deploymentId": ...,
}
parent.get_deployment(**kwargs)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)
...# get_deployments method usage example with argument unpacking
kwargs: GetDeploymentsRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_deployments(**kwargs)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,
) -> DocumentationPartResponseTypeDef: # (1)
...# get_documentation_part method usage example with argument unpacking
kwargs: GetDocumentationPartRequestTypeDef = { # (1)
"restApiId": ...,
"documentationPartId": ...,
}
parent.get_documentation_part(**kwargs)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)
...# get_documentation_parts method usage example with argument unpacking
kwargs: GetDocumentationPartsRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_documentation_parts(**kwargs)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,
) -> DocumentationVersionResponseTypeDef: # (1)
...# get_documentation_version method usage example with argument unpacking
kwargs: GetDocumentationVersionRequestTypeDef = { # (1)
"restApiId": ...,
"documentationVersion": ...,
}
parent.get_documentation_version(**kwargs)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)
...# get_documentation_versions method usage example with argument unpacking
kwargs: GetDocumentationVersionsRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_documentation_versions(**kwargs)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,
domainNameId: str = ...,
) -> DomainNameResponseTypeDef: # (1)
...# get_domain_name method usage example with argument unpacking
kwargs: GetDomainNameRequestTypeDef = { # (1)
"domainName": ...,
}
parent.get_domain_name(**kwargs)get_domain_name_access_associations#
Represents a collection on DomainNameAccessAssociations resources.
Type annotations and code completion for boto3.client("apigateway").get_domain_name_access_associations method.
boto3 documentation
# get_domain_name_access_associations method definition
def get_domain_name_access_associations(
self,
*,
position: str = ...,
limit: int = ...,
resourceOwner: ResourceOwnerType = ..., # (1)
) -> DomainNameAccessAssociationsTypeDef: # (2)
...# get_domain_name_access_associations method usage example with argument unpacking
kwargs: GetDomainNameAccessAssociationsRequestTypeDef = { # (1)
"position": ...,
}
parent.get_domain_name_access_associations(**kwargs)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 = ...,
resourceOwner: ResourceOwnerType = ..., # (1)
) -> DomainNamesTypeDef: # (2)
...- See ResourceOwnerType
- See DomainNamesTypeDef
# get_domain_names method usage example with argument unpacking
kwargs: GetDomainNamesRequestTypeDef = { # (1)
"position": ...,
}
parent.get_domain_names(**kwargs)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)
...# get_export method usage example with argument unpacking
kwargs: GetExportRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
"exportType": ...,
}
parent.get_export(**kwargs)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)
) -> GatewayResponseResponseTypeDef: # (2)
...# get_gateway_response method usage example with argument unpacking
kwargs: GetGatewayResponseRequestTypeDef = { # (1)
"restApiId": ...,
"responseType": ...,
}
parent.get_gateway_response(**kwargs)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)
...# get_gateway_responses method usage example with argument unpacking
kwargs: GetGatewayResponsesRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_gateway_responses(**kwargs)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,
) -> IntegrationResponseExtraTypeDef: # (1)
...# get_integration method usage example with argument unpacking
kwargs: GetIntegrationRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.get_integration(**kwargs)get_integration_response#
Represents a get integration response.
Type annotations and code completion for boto3.client("apigateway").get_integration_response method.
boto3 documentation
# get_integration_response method definition
def get_integration_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> IntegrationResponseResponseTypeDef: # (1)
...# get_integration_response method usage example with argument unpacking
kwargs: GetIntegrationResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.get_integration_response(**kwargs)get_method#
Describe an existing Method resource.
Type annotations and code completion for boto3.client("apigateway").get_method method.
boto3 documentation
# get_method method definition
def get_method(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
) -> MethodResponseExtraTypeDef: # (1)
...# get_method method usage example with argument unpacking
kwargs: GetMethodRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.get_method(**kwargs)get_method_response#
Describes a MethodResponse resource.
Type annotations and code completion for boto3.client("apigateway").get_method_response method.
boto3 documentation
# get_method_response method definition
def get_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> MethodResponseResponseTypeDef: # (1)
...# get_method_response method usage example with argument unpacking
kwargs: GetMethodResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.get_method_response(**kwargs)get_model#
Describes an existing model defined for a RestApi resource.
Type annotations and code completion for boto3.client("apigateway").get_model method.
boto3 documentation
# get_model method definition
def get_model(
self,
*,
restApiId: str,
modelName: str,
flatten: bool = ...,
) -> ModelResponseTypeDef: # (1)
...# get_model method usage example with argument unpacking
kwargs: GetModelRequestTypeDef = { # (1)
"restApiId": ...,
"modelName": ...,
}
parent.get_model(**kwargs)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 boto3.client("apigateway").get_model_template method.
boto3 documentation
# get_model_template method definition
def get_model_template(
self,
*,
restApiId: str,
modelName: str,
) -> TemplateTypeDef: # (1)
...- See TemplateTypeDef
# get_model_template method usage example with argument unpacking
kwargs: GetModelTemplateRequestTypeDef = { # (1)
"restApiId": ...,
"modelName": ...,
}
parent.get_model_template(**kwargs)get_models#
Describes existing Models defined for a RestApi resource.
Type annotations and code completion for boto3.client("apigateway").get_models method.
boto3 documentation
# get_models method definition
def get_models(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> ModelsTypeDef: # (1)
...- See ModelsTypeDef
# get_models method usage example with argument unpacking
kwargs: GetModelsRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_models(**kwargs)get_request_validator#
Gets a RequestValidator of a given RestApi.
Type annotations and code completion for boto3.client("apigateway").get_request_validator method.
boto3 documentation
# get_request_validator method definition
def get_request_validator(
self,
*,
restApiId: str,
requestValidatorId: str,
) -> RequestValidatorResponseTypeDef: # (1)
...# get_request_validator method usage example with argument unpacking
kwargs: GetRequestValidatorRequestTypeDef = { # (1)
"restApiId": ...,
"requestValidatorId": ...,
}
parent.get_request_validator(**kwargs)get_request_validators#
Gets the RequestValidators collection of a given RestApi.
Type annotations and code completion for boto3.client("apigateway").get_request_validators method.
boto3 documentation
# get_request_validators method definition
def get_request_validators(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> RequestValidatorsTypeDef: # (1)
...# get_request_validators method usage example with argument unpacking
kwargs: GetRequestValidatorsRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_request_validators(**kwargs)get_resource#
Lists information about a resource.
Type annotations and code completion for boto3.client("apigateway").get_resource method.
boto3 documentation
# get_resource method definition
def get_resource(
self,
*,
restApiId: str,
resourceId: str,
embed: Sequence[str] = ...,
) -> ResourceResponseTypeDef: # (1)
...# get_resource method usage example with argument unpacking
kwargs: GetResourceRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
}
parent.get_resource(**kwargs)get_resources#
Lists information about a collection of Resource resources.
Type annotations and code completion for boto3.client("apigateway").get_resources method.
boto3 documentation
# get_resources method definition
def get_resources(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
embed: Sequence[str] = ...,
) -> ResourcesTypeDef: # (1)
...- See ResourcesTypeDef
# get_resources method usage example with argument unpacking
kwargs: GetResourcesRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_resources(**kwargs)get_rest_api#
Lists the RestApi resource in the collection.
Type annotations and code completion for boto3.client("apigateway").get_rest_api method.
boto3 documentation
# get_rest_api method definition
def get_rest_api(
self,
*,
restApiId: str,
) -> RestApiResponseTypeDef: # (1)
...# get_rest_api method usage example with argument unpacking
kwargs: GetRestApiRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_rest_api(**kwargs)get_rest_apis#
Lists the RestApis resources for your collection.
Type annotations and code completion for boto3.client("apigateway").get_rest_apis method.
boto3 documentation
# get_rest_apis method definition
def get_rest_apis(
self,
*,
position: str = ...,
limit: int = ...,
) -> RestApisTypeDef: # (1)
...- See RestApisTypeDef
# get_rest_apis method usage example with argument unpacking
kwargs: GetRestApisRequestTypeDef = { # (1)
"position": ...,
}
parent.get_rest_apis(**kwargs)get_sdk#
Generates a client SDK for a RestApi and Stage.
Type annotations and code completion for boto3.client("apigateway").get_sdk method.
boto3 documentation
# get_sdk method definition
def get_sdk(
self,
*,
restApiId: str,
stageName: str,
sdkType: str,
parameters: Mapping[str, str] = ...,
) -> SdkResponseTypeDef: # (1)
...# get_sdk method usage example with argument unpacking
kwargs: GetSdkRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
"sdkType": ...,
}
parent.get_sdk(**kwargs)get_sdk_type#
Gets an SDK type.
Type annotations and code completion for boto3.client("apigateway").get_sdk_type method.
boto3 documentation
# get_sdk_type method definition
def get_sdk_type(
self,
*,
id: str,
) -> SdkTypeResponseTypeDef: # (1)
...# get_sdk_type method usage example with argument unpacking
kwargs: GetSdkTypeRequestTypeDef = { # (1)
"id": ...,
}
parent.get_sdk_type(**kwargs)get_sdk_types#
Gets SDK types.
Type annotations and code completion for boto3.client("apigateway").get_sdk_types method.
boto3 documentation
# get_sdk_types method definition
def get_sdk_types(
self,
*,
position: str = ...,
limit: int = ...,
) -> SdkTypesTypeDef: # (1)
...- See SdkTypesTypeDef
# get_sdk_types method usage example with argument unpacking
kwargs: GetSdkTypesRequestTypeDef = { # (1)
"position": ...,
}
parent.get_sdk_types(**kwargs)get_stage#
Gets information about a Stage resource.
Type annotations and code completion for boto3.client("apigateway").get_stage method.
boto3 documentation
# get_stage method definition
def get_stage(
self,
*,
restApiId: str,
stageName: str,
) -> StageResponseTypeDef: # (1)
...# get_stage method usage example with argument unpacking
kwargs: GetStageRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
}
parent.get_stage(**kwargs)get_stages#
Gets information about one or more Stage resources.
Type annotations and code completion for boto3.client("apigateway").get_stages method.
boto3 documentation
# get_stages method definition
def get_stages(
self,
*,
restApiId: str,
deploymentId: str = ...,
) -> StagesTypeDef: # (1)
...- See StagesTypeDef
# get_stages method usage example with argument unpacking
kwargs: GetStagesRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.get_stages(**kwargs)get_tags#
Gets the Tags collection for a given resource.
Type annotations and code completion for boto3.client("apigateway").get_tags method.
boto3 documentation
# get_tags method definition
def get_tags(
self,
*,
resourceArn: str,
position: str = ...,
limit: int = ...,
) -> TagsTypeDef: # (1)
...- See TagsTypeDef
# get_tags method usage example with argument unpacking
kwargs: GetTagsRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.get_tags(**kwargs)get_usage#
Gets the usage data of a usage plan in a specified time interval.
Type annotations and code completion for boto3.client("apigateway").get_usage method.
boto3 documentation
# get_usage method definition
def get_usage(
self,
*,
usagePlanId: str,
startDate: str,
endDate: str,
keyId: str = ...,
position: str = ...,
limit: int = ...,
) -> UsageTypeDef: # (1)
...- See UsageTypeDef
# get_usage method usage example with argument unpacking
kwargs: GetUsageRequestTypeDef = { # (1)
"usagePlanId": ...,
"startDate": ...,
"endDate": ...,
}
parent.get_usage(**kwargs)get_usage_plan#
Gets a usage plan of a given plan identifier.
Type annotations and code completion for boto3.client("apigateway").get_usage_plan method.
boto3 documentation
# get_usage_plan method definition
def get_usage_plan(
self,
*,
usagePlanId: str,
) -> UsagePlanResponseTypeDef: # (1)
...# get_usage_plan method usage example with argument unpacking
kwargs: GetUsagePlanRequestTypeDef = { # (1)
"usagePlanId": ...,
}
parent.get_usage_plan(**kwargs)get_usage_plan_key#
Gets a usage plan key of a given key identifier.
Type annotations and code completion for boto3.client("apigateway").get_usage_plan_key method.
boto3 documentation
# get_usage_plan_key method definition
def get_usage_plan_key(
self,
*,
usagePlanId: str,
keyId: str,
) -> UsagePlanKeyResponseTypeDef: # (1)
...# get_usage_plan_key method usage example with argument unpacking
kwargs: GetUsagePlanKeyRequestTypeDef = { # (1)
"usagePlanId": ...,
"keyId": ...,
}
parent.get_usage_plan_key(**kwargs)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 boto3.client("apigateway").get_usage_plan_keys method.
boto3 documentation
# get_usage_plan_keys method definition
def get_usage_plan_keys(
self,
*,
usagePlanId: str,
position: str = ...,
limit: int = ...,
nameQuery: str = ...,
) -> UsagePlanKeysTypeDef: # (1)
...# get_usage_plan_keys method usage example with argument unpacking
kwargs: GetUsagePlanKeysRequestTypeDef = { # (1)
"usagePlanId": ...,
}
parent.get_usage_plan_keys(**kwargs)get_usage_plans#
Gets all the usage plans of the caller's account.
Type annotations and code completion for boto3.client("apigateway").get_usage_plans method.
boto3 documentation
# get_usage_plans method definition
def get_usage_plans(
self,
*,
position: str = ...,
keyId: str = ...,
limit: int = ...,
) -> UsagePlansTypeDef: # (1)
...# get_usage_plans method usage example with argument unpacking
kwargs: GetUsagePlansRequestTypeDef = { # (1)
"position": ...,
}
parent.get_usage_plans(**kwargs)get_vpc_link#
Gets a specified VPC link under the caller's account in a region.
Type annotations and code completion for boto3.client("apigateway").get_vpc_link method.
boto3 documentation
# get_vpc_link method definition
def get_vpc_link(
self,
*,
vpcLinkId: str,
) -> VpcLinkResponseTypeDef: # (1)
...# get_vpc_link method usage example with argument unpacking
kwargs: GetVpcLinkRequestTypeDef = { # (1)
"vpcLinkId": ...,
}
parent.get_vpc_link(**kwargs)get_vpc_links#
Gets the VpcLinks collection under the caller's account in a selected region.
Type annotations and code completion for boto3.client("apigateway").get_vpc_links method.
boto3 documentation
# get_vpc_links method definition
def get_vpc_links(
self,
*,
position: str = ...,
limit: int = ...,
) -> VpcLinksTypeDef: # (1)
...- See VpcLinksTypeDef
# get_vpc_links method usage example with argument unpacking
kwargs: GetVpcLinksRequestTypeDef = { # (1)
"position": ...,
}
parent.get_vpc_links(**kwargs)import_api_keys#
Import API keys from an external source, such as a CSV-formatted file.
Type annotations and code completion for boto3.client("apigateway").import_api_keys method.
boto3 documentation
# import_api_keys method definition
def import_api_keys(
self,
*,
body: BlobTypeDef,
format: ApiKeysFormatType, # (1)
failOnWarnings: bool = ...,
) -> ApiKeyIdsTypeDef: # (2)
...- See ApiKeysFormatType
- See ApiKeyIdsTypeDef
# import_api_keys method usage example with argument unpacking
kwargs: ImportApiKeysRequestTypeDef = { # (1)
"body": ...,
"format": ...,
}
parent.import_api_keys(**kwargs)import_documentation_parts#
Imports documentation parts.
Type annotations and code completion for boto3.client("apigateway").import_documentation_parts method.
boto3 documentation
# import_documentation_parts method definition
def import_documentation_parts(
self,
*,
restApiId: str,
body: BlobTypeDef,
mode: PutModeType = ..., # (1)
failOnWarnings: bool = ...,
) -> DocumentationPartIdsTypeDef: # (2)
...# import_documentation_parts method usage example with argument unpacking
kwargs: ImportDocumentationPartsRequestTypeDef = { # (1)
"restApiId": ...,
"body": ...,
}
parent.import_documentation_parts(**kwargs)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 boto3.client("apigateway").import_rest_api method.
boto3 documentation
# import_rest_api method definition
def import_rest_api(
self,
*,
body: BlobTypeDef,
failOnWarnings: bool = ...,
parameters: Mapping[str, str] = ...,
) -> RestApiResponseTypeDef: # (1)
...# import_rest_api method usage example with argument unpacking
kwargs: ImportRestApiRequestTypeDef = { # (1)
"body": ...,
}
parent.import_rest_api(**kwargs)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 boto3.client("apigateway").put_gateway_response method.
boto3 documentation
# put_gateway_response method definition
def put_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
statusCode: str = ...,
responseParameters: Mapping[str, str] = ...,
responseTemplates: Mapping[str, str] = ...,
) -> GatewayResponseResponseTypeDef: # (2)
...# put_gateway_response method usage example with argument unpacking
kwargs: PutGatewayResponseRequestTypeDef = { # (1)
"restApiId": ...,
"responseType": ...,
}
parent.put_gateway_response(**kwargs)put_integration#
Sets up a method's integration.
Type annotations and code completion for boto3.client("apigateway").put_integration method.
boto3 documentation
# put_integration method definition
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)
) -> IntegrationResponseExtraTypeDef: # (5)
...- See IntegrationTypeType
- See ConnectionTypeType
- See ContentHandlingStrategyType
- See TlsConfigTypeDef
- See IntegrationResponseExtraTypeDef
# put_integration method usage example with argument unpacking
kwargs: PutIntegrationRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"type": ...,
}
parent.put_integration(**kwargs)put_integration_response#
Represents a put integration.
Type annotations and code completion for boto3.client("apigateway").put_integration_response method.
boto3 documentation
# put_integration_response method definition
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)
...# put_integration_response method usage example with argument unpacking
kwargs: PutIntegrationResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.put_integration_response(**kwargs)put_method#
Add a method to an existing Resource resource.
Type annotations and code completion for boto3.client("apigateway").put_method method.
boto3 documentation
# put_method method definition
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] = ...,
) -> MethodResponseExtraTypeDef: # (1)
...# put_method method usage example with argument unpacking
kwargs: PutMethodRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"authorizationType": ...,
}
parent.put_method(**kwargs)put_method_response#
Adds a MethodResponse to an existing Method resource.
Type annotations and code completion for boto3.client("apigateway").put_method_response method.
boto3 documentation
# put_method_response method definition
def put_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
responseParameters: Mapping[str, bool] = ...,
responseModels: Mapping[str, str] = ...,
) -> MethodResponseResponseTypeDef: # (1)
...# put_method_response method usage example with argument unpacking
kwargs: PutMethodResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.put_method_response(**kwargs)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 boto3.client("apigateway").put_rest_api method.
boto3 documentation
# put_rest_api method definition
def put_rest_api(
self,
*,
restApiId: str,
body: BlobTypeDef,
mode: PutModeType = ..., # (1)
failOnWarnings: bool = ...,
parameters: Mapping[str, str] = ...,
) -> RestApiResponseTypeDef: # (2)
...- See PutModeType
- See RestApiResponseTypeDef
# put_rest_api method usage example with argument unpacking
kwargs: PutRestApiRequestTypeDef = { # (1)
"restApiId": ...,
"body": ...,
}
parent.put_rest_api(**kwargs)reject_domain_name_access_association#
Rejects a domain name access association with a private custom domain name.
Type annotations and code completion for boto3.client("apigateway").reject_domain_name_access_association method.
boto3 documentation
# reject_domain_name_access_association method definition
def reject_domain_name_access_association(
self,
*,
domainNameAccessAssociationArn: str,
domainNameArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# reject_domain_name_access_association method usage example with argument unpacking
kwargs: RejectDomainNameAccessAssociationRequestTypeDef = { # (1)
"domainNameAccessAssociationArn": ...,
"domainNameArn": ...,
}
parent.reject_domain_name_access_association(**kwargs)tag_resource#
Adds or updates a tag on a given resource.
Type annotations and code completion for boto3.client("apigateway").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)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 boto3.client("apigateway").test_invoke_authorizer method.
boto3 documentation
# test_invoke_authorizer method definition
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)
...# test_invoke_authorizer method usage example with argument unpacking
kwargs: TestInvokeAuthorizerRequestTypeDef = { # (1)
"restApiId": ...,
"authorizerId": ...,
}
parent.test_invoke_authorizer(**kwargs)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 boto3.client("apigateway").test_invoke_method method.
boto3 documentation
# test_invoke_method method definition
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)
...# test_invoke_method method usage example with argument unpacking
kwargs: TestInvokeMethodRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.test_invoke_method(**kwargs)untag_resource#
Removes a tag from a given resource.
Type annotations and code completion for boto3.client("apigateway").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_account#
Changes information about the current Account resource.
Type annotations and code completion for boto3.client("apigateway").update_account method.
boto3 documentation
# update_account method definition
def update_account(
self,
*,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> AccountTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See AccountTypeDef
# update_account method usage example with argument unpacking
kwargs: UpdateAccountRequestTypeDef = { # (1)
"patchOperations": ...,
}
parent.update_account(**kwargs)update_api_key#
Changes information about an ApiKey resource.
Type annotations and code completion for boto3.client("apigateway").update_api_key method.
boto3 documentation
# update_api_key method definition
def update_api_key(
self,
*,
apiKey: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ApiKeyResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See ApiKeyResponseTypeDef
# update_api_key method usage example with argument unpacking
kwargs: UpdateApiKeyRequestTypeDef = { # (1)
"apiKey": ...,
}
parent.update_api_key(**kwargs)update_authorizer#
Updates an existing Authorizer resource.
Type annotations and code completion for boto3.client("apigateway").update_authorizer method.
boto3 documentation
# update_authorizer method definition
def update_authorizer(
self,
*,
restApiId: str,
authorizerId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> AuthorizerResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See AuthorizerResponseTypeDef
# update_authorizer method usage example with argument unpacking
kwargs: UpdateAuthorizerRequestTypeDef = { # (1)
"restApiId": ...,
"authorizerId": ...,
}
parent.update_authorizer(**kwargs)update_base_path_mapping#
Changes information about the BasePathMapping resource.
Type annotations and code completion for boto3.client("apigateway").update_base_path_mapping method.
boto3 documentation
# update_base_path_mapping method definition
def update_base_path_mapping(
self,
*,
domainName: str,
basePath: str,
domainNameId: str = ...,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> BasePathMappingResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See BasePathMappingResponseTypeDef
# update_base_path_mapping method usage example with argument unpacking
kwargs: UpdateBasePathMappingRequestTypeDef = { # (1)
"domainName": ...,
"basePath": ...,
}
parent.update_base_path_mapping(**kwargs)update_client_certificate#
Changes information about an ClientCertificate resource.
Type annotations and code completion for boto3.client("apigateway").update_client_certificate method.
boto3 documentation
# update_client_certificate method definition
def update_client_certificate(
self,
*,
clientCertificateId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ClientCertificateResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See ClientCertificateResponseTypeDef
# update_client_certificate method usage example with argument unpacking
kwargs: UpdateClientCertificateRequestTypeDef = { # (1)
"clientCertificateId": ...,
}
parent.update_client_certificate(**kwargs)update_deployment#
Changes information about a Deployment resource.
Type annotations and code completion for boto3.client("apigateway").update_deployment method.
boto3 documentation
# update_deployment method definition
def update_deployment(
self,
*,
restApiId: str,
deploymentId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DeploymentResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See DeploymentResponseTypeDef
# update_deployment method usage example with argument unpacking
kwargs: UpdateDeploymentRequestTypeDef = { # (1)
"restApiId": ...,
"deploymentId": ...,
}
parent.update_deployment(**kwargs)update_documentation_part#
Updates a documentation part.
Type annotations and code completion for boto3.client("apigateway").update_documentation_part method.
boto3 documentation
# update_documentation_part method definition
def update_documentation_part(
self,
*,
restApiId: str,
documentationPartId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DocumentationPartResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See DocumentationPartResponseTypeDef
# update_documentation_part method usage example with argument unpacking
kwargs: UpdateDocumentationPartRequestTypeDef = { # (1)
"restApiId": ...,
"documentationPartId": ...,
}
parent.update_documentation_part(**kwargs)update_documentation_version#
Updates a documentation version.
Type annotations and code completion for boto3.client("apigateway").update_documentation_version method.
boto3 documentation
# update_documentation_version method definition
def update_documentation_version(
self,
*,
restApiId: str,
documentationVersion: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DocumentationVersionResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See DocumentationVersionResponseTypeDef
# update_documentation_version method usage example with argument unpacking
kwargs: UpdateDocumentationVersionRequestTypeDef = { # (1)
"restApiId": ...,
"documentationVersion": ...,
}
parent.update_documentation_version(**kwargs)update_domain_name#
Changes information about the DomainName resource.
Type annotations and code completion for boto3.client("apigateway").update_domain_name method.
boto3 documentation
# update_domain_name method definition
def update_domain_name(
self,
*,
domainName: str,
domainNameId: str = ...,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DomainNameResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See DomainNameResponseTypeDef
# update_domain_name method usage example with argument unpacking
kwargs: UpdateDomainNameRequestTypeDef = { # (1)
"domainName": ...,
}
parent.update_domain_name(**kwargs)update_gateway_response#
Updates a GatewayResponse of a specified response type on the given RestApi.
Type annotations and code completion for boto3.client("apigateway").update_gateway_response method.
boto3 documentation
# update_gateway_response method definition
def update_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (2)
) -> GatewayResponseResponseTypeDef: # (3)
...- See GatewayResponseTypeType
- See
Sequence[PatchOperationTypeDef] - See GatewayResponseResponseTypeDef
# update_gateway_response method usage example with argument unpacking
kwargs: UpdateGatewayResponseRequestTypeDef = { # (1)
"restApiId": ...,
"responseType": ...,
}
parent.update_gateway_response(**kwargs)update_integration#
Represents an update integration.
Type annotations and code completion for boto3.client("apigateway").update_integration method.
boto3 documentation
# update_integration method definition
def update_integration(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> IntegrationResponseExtraTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See IntegrationResponseExtraTypeDef
# update_integration method usage example with argument unpacking
kwargs: UpdateIntegrationRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.update_integration(**kwargs)update_integration_response#
Represents an update integration response.
Type annotations and code completion for boto3.client("apigateway").update_integration_response method.
boto3 documentation
# update_integration_response method definition
def update_integration_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> IntegrationResponseResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See IntegrationResponseResponseTypeDef
# update_integration_response method usage example with argument unpacking
kwargs: UpdateIntegrationResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.update_integration_response(**kwargs)update_method#
Updates an existing Method resource.
Type annotations and code completion for boto3.client("apigateway").update_method method.
boto3 documentation
# update_method method definition
def update_method(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> MethodResponseExtraTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See MethodResponseExtraTypeDef
# update_method method usage example with argument unpacking
kwargs: UpdateMethodRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
parent.update_method(**kwargs)update_method_response#
Updates an existing MethodResponse resource.
Type annotations and code completion for boto3.client("apigateway").update_method_response method.
boto3 documentation
# update_method_response method definition
def update_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> MethodResponseResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See MethodResponseResponseTypeDef
# update_method_response method usage example with argument unpacking
kwargs: UpdateMethodResponseRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
parent.update_method_response(**kwargs)update_model#
Changes information about a model.
Type annotations and code completion for boto3.client("apigateway").update_model method.
boto3 documentation
# update_model method definition
def update_model(
self,
*,
restApiId: str,
modelName: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ModelResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See ModelResponseTypeDef
# update_model method usage example with argument unpacking
kwargs: UpdateModelRequestTypeDef = { # (1)
"restApiId": ...,
"modelName": ...,
}
parent.update_model(**kwargs)update_request_validator#
Updates a RequestValidator of a given RestApi.
Type annotations and code completion for boto3.client("apigateway").update_request_validator method.
boto3 documentation
# update_request_validator method definition
def update_request_validator(
self,
*,
restApiId: str,
requestValidatorId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> RequestValidatorResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See RequestValidatorResponseTypeDef
# update_request_validator method usage example with argument unpacking
kwargs: UpdateRequestValidatorRequestTypeDef = { # (1)
"restApiId": ...,
"requestValidatorId": ...,
}
parent.update_request_validator(**kwargs)update_resource#
Changes information about a Resource resource.
Type annotations and code completion for boto3.client("apigateway").update_resource method.
boto3 documentation
# update_resource method definition
def update_resource(
self,
*,
restApiId: str,
resourceId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ResourceResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See ResourceResponseTypeDef
# update_resource method usage example with argument unpacking
kwargs: UpdateResourceRequestTypeDef = { # (1)
"restApiId": ...,
"resourceId": ...,
}
parent.update_resource(**kwargs)update_rest_api#
Changes information about the specified API.
Type annotations and code completion for boto3.client("apigateway").update_rest_api method.
boto3 documentation
# update_rest_api method definition
def update_rest_api(
self,
*,
restApiId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> RestApiResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See RestApiResponseTypeDef
# update_rest_api method usage example with argument unpacking
kwargs: UpdateRestApiRequestTypeDef = { # (1)
"restApiId": ...,
}
parent.update_rest_api(**kwargs)update_stage#
Changes information about a Stage resource.
Type annotations and code completion for boto3.client("apigateway").update_stage method.
boto3 documentation
# update_stage method definition
def update_stage(
self,
*,
restApiId: str,
stageName: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> StageResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See StageResponseTypeDef
# update_stage method usage example with argument unpacking
kwargs: UpdateStageRequestTypeDef = { # (1)
"restApiId": ...,
"stageName": ...,
}
parent.update_stage(**kwargs)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 boto3.client("apigateway").update_usage method.
boto3 documentation
# update_usage method definition
def update_usage(
self,
*,
usagePlanId: str,
keyId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> UsageTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See UsageTypeDef
# update_usage method usage example with argument unpacking
kwargs: UpdateUsageRequestTypeDef = { # (1)
"usagePlanId": ...,
"keyId": ...,
}
parent.update_usage(**kwargs)update_usage_plan#
Updates a usage plan of a given plan Id.
Type annotations and code completion for boto3.client("apigateway").update_usage_plan method.
boto3 documentation
# update_usage_plan method definition
def update_usage_plan(
self,
*,
usagePlanId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> UsagePlanResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See UsagePlanResponseTypeDef
# update_usage_plan method usage example with argument unpacking
kwargs: UpdateUsagePlanRequestTypeDef = { # (1)
"usagePlanId": ...,
}
parent.update_usage_plan(**kwargs)update_vpc_link#
Updates an existing VpcLink of a specified identifier.
Type annotations and code completion for boto3.client("apigateway").update_vpc_link method.
boto3 documentation
# update_vpc_link method definition
def update_vpc_link(
self,
*,
vpcLinkId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> VpcLinkResponseTypeDef: # (2)
...- See
Sequence[PatchOperationTypeDef] - See VpcLinkResponseTypeDef
# update_vpc_link method usage example with argument unpacking
kwargs: UpdateVpcLinkRequestTypeDef = { # (1)
"vpcLinkId": ...,
}
parent.update_vpc_link(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("apigateway").get_paginator method with overloads.
client.get_paginator("get_api_keys")-> GetApiKeysPaginatorclient.get_paginator("get_authorizers")-> GetAuthorizersPaginatorclient.get_paginator("get_base_path_mappings")-> GetBasePathMappingsPaginatorclient.get_paginator("get_client_certificates")-> GetClientCertificatesPaginatorclient.get_paginator("get_deployments")-> GetDeploymentsPaginatorclient.get_paginator("get_documentation_parts")-> GetDocumentationPartsPaginatorclient.get_paginator("get_documentation_versions")-> GetDocumentationVersionsPaginatorclient.get_paginator("get_domain_names")-> GetDomainNamesPaginatorclient.get_paginator("get_gateway_responses")-> GetGatewayResponsesPaginatorclient.get_paginator("get_models")-> GetModelsPaginatorclient.get_paginator("get_request_validators")-> GetRequestValidatorsPaginatorclient.get_paginator("get_resources")-> GetResourcesPaginatorclient.get_paginator("get_rest_apis")-> GetRestApisPaginatorclient.get_paginator("get_sdk_types")-> GetSdkTypesPaginatorclient.get_paginator("get_usage")-> GetUsagePaginatorclient.get_paginator("get_usage_plan_keys")-> GetUsagePlanKeysPaginatorclient.get_paginator("get_usage_plans")-> GetUsagePlansPaginatorclient.get_paginator("get_vpc_links")-> GetVpcLinksPaginator