APIGatewayClient
Index > APIGateway > APIGatewayClient
Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.
APIGatewayClient
Type annotations and code completion for boto3.client("apigateway")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_apigateway.client import APIGatewayClient
def get_apigateway_client() -> APIGatewayClient:
return Session().client("apigateway")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("apigateway").exceptions
structure.
client = boto3.client("apigateway")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.LimitExceededException,
client.NotFoundException,
client.ServiceUnavailableException,
client.TooManyRequestsException,
client.UnauthorizedException,
) as e:
print(e)
from mypy_boto3_apigateway.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("apigateway").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("apigateway").close
method.
boto3 documentation
create_api_key
Create an ApiKey resource.
Type annotations and code completion for boto3.client("apigateway").create_api_key
method.
boto3 documentation
def create_api_key(
self,
*,
name: str = ...,
description: str = ...,
enabled: bool = ...,
generateDistinctId: bool = ...,
value: str = ...,
stageKeys: Sequence[StageKeyTypeDef] = ..., # (1)
customerId: str = ...,
tags: Mapping[str, str] = ...,
) -> ApiKeyResponseMetadataTypeDef: # (2)
...
kwargs: CreateApiKeyRequestRequestTypeDef = { # (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
def create_authorizer(
self,
*,
restApiId: str,
name: str,
type: AuthorizerTypeType, # (1)
providerARNs: Sequence[str] = ...,
authType: str = ...,
authorizerUri: str = ...,
authorizerCredentials: str = ...,
identitySource: str = ...,
identityValidationExpression: str = ...,
authorizerResultTtlInSeconds: int = ...,
) -> AuthorizerResponseMetadataTypeDef: # (2)
...
kwargs: CreateAuthorizerRequestRequestTypeDef = { # (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
def create_base_path_mapping(
self,
*,
domainName: str,
restApiId: str,
basePath: str = ...,
stage: str = ...,
) -> BasePathMappingResponseMetadataTypeDef: # (1)
...
kwargs: CreateBasePathMappingRequestRequestTypeDef = { # (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
def create_deployment(
self,
*,
restApiId: str,
stageName: str = ...,
stageDescription: str = ...,
description: str = ...,
cacheClusterEnabled: bool = ...,
cacheClusterSize: CacheClusterSizeType = ..., # (1)
variables: Mapping[str, str] = ...,
canarySettings: DeploymentCanarySettingsTypeDef = ..., # (2)
tracingEnabled: bool = ...,
) -> DeploymentResponseMetadataTypeDef: # (3)
...
kwargs: CreateDeploymentRequestRequestTypeDef = { # (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
def create_documentation_part(
self,
*,
restApiId: str,
location: DocumentationPartLocationTypeDef, # (1)
properties: str,
) -> DocumentationPartResponseMetadataTypeDef: # (2)
...
kwargs: CreateDocumentationPartRequestRequestTypeDef = { # (1)
"restApiId": ...,
"location": ...,
"properties": ...,
}
parent.create_documentation_part(**kwargs)
create_documentation_version
Creates a documentation version See also: AWS API Documentation.
Type annotations and code completion for boto3.client("apigateway").create_documentation_version
method.
boto3 documentation
def create_documentation_version(
self,
*,
restApiId: str,
documentationVersion: str,
stageName: str = ...,
description: str = ...,
) -> DocumentationVersionResponseMetadataTypeDef: # (1)
...
kwargs: CreateDocumentationVersionRequestRequestTypeDef = { # (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
def create_domain_name(
self,
*,
domainName: str,
certificateName: str = ...,
certificateBody: str = ...,
certificatePrivateKey: str = ...,
certificateChain: str = ...,
certificateArn: str = ...,
regionalCertificateName: str = ...,
regionalCertificateArn: str = ...,
endpointConfiguration: EndpointConfigurationTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
securityPolicy: SecurityPolicyType = ..., # (2)
mutualTlsAuthentication: MutualTlsAuthenticationInputTypeDef = ..., # (3)
ownershipVerificationCertificateArn: str = ...,
) -> DomainNameResponseMetadataTypeDef: # (4)
...
- See EndpointConfigurationTypeDef
- See SecurityPolicyType
- See MutualTlsAuthenticationInputTypeDef
- See DomainNameResponseMetadataTypeDef
kwargs: CreateDomainNameRequestRequestTypeDef = { # (1)
"domainName": ...,
}
parent.create_domain_name(**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
def create_model(
self,
*,
restApiId: str,
name: str,
contentType: str,
description: str = ...,
schema: str = ...,
) -> ModelResponseMetadataTypeDef: # (1)
...
kwargs: CreateModelRequestRequestTypeDef = { # (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
def create_request_validator(
self,
*,
restApiId: str,
name: str = ...,
validateRequestBody: bool = ...,
validateRequestParameters: bool = ...,
) -> RequestValidatorResponseMetadataTypeDef: # (1)
...
kwargs: CreateRequestValidatorRequestRequestTypeDef = { # (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
def create_resource(
self,
*,
restApiId: str,
parentId: str,
pathPart: str,
) -> ResourceResponseMetadataTypeDef: # (1)
...
kwargs: CreateResourceRequestRequestTypeDef = { # (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
def create_rest_api(
self,
*,
name: str,
description: str = ...,
version: str = ...,
cloneFrom: str = ...,
binaryMediaTypes: Sequence[str] = ...,
minimumCompressionSize: int = ...,
apiKeySource: ApiKeySourceTypeType = ..., # (1)
endpointConfiguration: EndpointConfigurationTypeDef = ..., # (2)
policy: str = ...,
tags: Mapping[str, str] = ...,
disableExecuteApiEndpoint: bool = ...,
) -> RestApiResponseMetadataTypeDef: # (3)
...
kwargs: CreateRestApiRequestRequestTypeDef = { # (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
def create_stage(
self,
*,
restApiId: str,
stageName: str,
deploymentId: str,
description: str = ...,
cacheClusterEnabled: bool = ...,
cacheClusterSize: CacheClusterSizeType = ..., # (1)
variables: Mapping[str, str] = ...,
documentationVersion: str = ...,
canarySettings: CanarySettingsTypeDef = ..., # (2)
tracingEnabled: bool = ...,
tags: Mapping[str, str] = ...,
) -> StageResponseMetadataTypeDef: # (3)
...
kwargs: CreateStageRequestRequestTypeDef = { # (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
def create_usage_plan(
self,
*,
name: str,
description: str = ...,
apiStages: Sequence[ApiStageTypeDef] = ..., # (1)
throttle: ThrottleSettingsTypeDef = ..., # (2)
quota: QuotaSettingsTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
) -> UsagePlanResponseMetadataTypeDef: # (4)
...
- See ApiStageTypeDef
- See ThrottleSettingsTypeDef
- See QuotaSettingsTypeDef
- See UsagePlanResponseMetadataTypeDef
kwargs: CreateUsagePlanRequestRequestTypeDef = { # (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
def create_usage_plan_key(
self,
*,
usagePlanId: str,
keyId: str,
keyType: str,
) -> UsagePlanKeyResponseMetadataTypeDef: # (1)
...
kwargs: CreateUsagePlanKeyRequestRequestTypeDef = { # (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
def create_vpc_link(
self,
*,
name: str,
targetArns: Sequence[str],
description: str = ...,
tags: Mapping[str, str] = ...,
) -> VpcLinkResponseMetadataTypeDef: # (1)
...
kwargs: CreateVpcLinkRequestRequestTypeDef = { # (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
def delete_api_key(
self,
*,
apiKey: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteApiKeyRequestRequestTypeDef = { # (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
def delete_authorizer(
self,
*,
restApiId: str,
authorizerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAuthorizerRequestRequestTypeDef = { # (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
def delete_base_path_mapping(
self,
*,
domainName: str,
basePath: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteBasePathMappingRequestRequestTypeDef = { # (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
def delete_client_certificate(
self,
*,
clientCertificateId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteClientCertificateRequestRequestTypeDef = { # (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
def delete_deployment(
self,
*,
restApiId: str,
deploymentId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDeploymentRequestRequestTypeDef = { # (1)
"restApiId": ...,
"deploymentId": ...,
}
parent.delete_deployment(**kwargs)
delete_documentation_part
Deletes a documentation part See also: AWS API Documentation.
Type annotations and code completion for boto3.client("apigateway").delete_documentation_part
method.
boto3 documentation
def delete_documentation_part(
self,
*,
restApiId: str,
documentationPartId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDocumentationPartRequestRequestTypeDef = { # (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
def delete_documentation_version(
self,
*,
restApiId: str,
documentationVersion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDocumentationVersionRequestRequestTypeDef = { # (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
def delete_domain_name(
self,
*,
domainName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDomainNameRequestRequestTypeDef = { # (1)
"domainName": ...,
}
parent.delete_domain_name(**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
def delete_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: DeleteGatewayResponseRequestRequestTypeDef = { # (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
def delete_integration(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntegrationRequestRequestTypeDef = { # (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
def delete_integration_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntegrationResponseRequestRequestTypeDef = { # (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
def delete_method(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteMethodRequestRequestTypeDef = { # (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
def delete_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteMethodResponseRequestRequestTypeDef = { # (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
def delete_model(
self,
*,
restApiId: str,
modelName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteModelRequestRequestTypeDef = { # (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
def delete_request_validator(
self,
*,
restApiId: str,
requestValidatorId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRequestValidatorRequestRequestTypeDef = { # (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
def delete_resource(
self,
*,
restApiId: str,
resourceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteResourceRequestRequestTypeDef = { # (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
def delete_rest_api(
self,
*,
restApiId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRestApiRequestRequestTypeDef = { # (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
def delete_stage(
self,
*,
restApiId: str,
stageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteStageRequestRequestTypeDef = { # (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
def delete_usage_plan(
self,
*,
usagePlanId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUsagePlanRequestRequestTypeDef = { # (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
def delete_usage_plan_key(
self,
*,
usagePlanId: str,
keyId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUsagePlanKeyRequestRequestTypeDef = { # (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
def delete_vpc_link(
self,
*,
vpcLinkId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteVpcLinkRequestRequestTypeDef = { # (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
def flush_stage_authorizers_cache(
self,
*,
restApiId: str,
stageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: FlushStageAuthorizersCacheRequestRequestTypeDef = { # (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
def flush_stage_cache(
self,
*,
restApiId: str,
stageName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: FlushStageCacheRequestRequestTypeDef = { # (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
def generate_client_certificate(
self,
*,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> ClientCertificateResponseMetadataTypeDef: # (1)
...
kwargs: GenerateClientCertificateRequestRequestTypeDef = { # (1)
"description": ...,
}
parent.generate_client_certificate(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("apigateway").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_account
Gets information about the current Account resource.
Type annotations and code completion for boto3.client("apigateway").get_account
method.
boto3 documentation
- 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
def get_api_key(
self,
*,
apiKey: str,
includeValue: bool = ...,
) -> ApiKeyResponseMetadataTypeDef: # (1)
...
kwargs: GetApiKeyRequestRequestTypeDef = { # (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
def get_api_keys(
self,
*,
position: str = ...,
limit: int = ...,
nameQuery: str = ...,
customerId: str = ...,
includeValues: bool = ...,
) -> ApiKeysTypeDef: # (1)
...
- See ApiKeysTypeDef
kwargs: GetApiKeysRequestRequestTypeDef = { # (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
def get_authorizer(
self,
*,
restApiId: str,
authorizerId: str,
) -> AuthorizerResponseMetadataTypeDef: # (1)
...
kwargs: GetAuthorizerRequestRequestTypeDef = { # (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
def get_authorizers(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> AuthorizersTypeDef: # (1)
...
kwargs: GetAuthorizersRequestRequestTypeDef = { # (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
def get_base_path_mapping(
self,
*,
domainName: str,
basePath: str,
) -> BasePathMappingResponseMetadataTypeDef: # (1)
...
kwargs: GetBasePathMappingRequestRequestTypeDef = { # (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
def get_base_path_mappings(
self,
*,
domainName: str,
position: str = ...,
limit: int = ...,
) -> BasePathMappingsTypeDef: # (1)
...
kwargs: GetBasePathMappingsRequestRequestTypeDef = { # (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
def get_client_certificate(
self,
*,
clientCertificateId: str,
) -> ClientCertificateResponseMetadataTypeDef: # (1)
...
kwargs: GetClientCertificateRequestRequestTypeDef = { # (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
def get_client_certificates(
self,
*,
position: str = ...,
limit: int = ...,
) -> ClientCertificatesTypeDef: # (1)
...
kwargs: GetClientCertificatesRequestRequestTypeDef = { # (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
def get_deployment(
self,
*,
restApiId: str,
deploymentId: str,
embed: Sequence[str] = ...,
) -> DeploymentResponseMetadataTypeDef: # (1)
...
kwargs: GetDeploymentRequestRequestTypeDef = { # (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
def get_deployments(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> DeploymentsTypeDef: # (1)
...
kwargs: GetDeploymentsRequestRequestTypeDef = { # (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
def get_documentation_part(
self,
*,
restApiId: str,
documentationPartId: str,
) -> DocumentationPartResponseMetadataTypeDef: # (1)
...
kwargs: GetDocumentationPartRequestRequestTypeDef = { # (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
def get_documentation_parts(
self,
*,
restApiId: str,
type: DocumentationPartTypeType = ..., # (1)
nameQuery: str = ...,
path: str = ...,
position: str = ...,
limit: int = ...,
locationStatus: LocationStatusTypeType = ..., # (2)
) -> DocumentationPartsTypeDef: # (3)
...
kwargs: GetDocumentationPartsRequestRequestTypeDef = { # (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
def get_documentation_version(
self,
*,
restApiId: str,
documentationVersion: str,
) -> DocumentationVersionResponseMetadataTypeDef: # (1)
...
kwargs: GetDocumentationVersionRequestRequestTypeDef = { # (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
def get_documentation_versions(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> DocumentationVersionsTypeDef: # (1)
...
kwargs: GetDocumentationVersionsRequestRequestTypeDef = { # (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
def get_domain_name(
self,
*,
domainName: str,
) -> DomainNameResponseMetadataTypeDef: # (1)
...
kwargs: GetDomainNameRequestRequestTypeDef = { # (1)
"domainName": ...,
}
parent.get_domain_name(**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
def get_domain_names(
self,
*,
position: str = ...,
limit: int = ...,
) -> DomainNamesTypeDef: # (1)
...
kwargs: GetDomainNamesRequestRequestTypeDef = { # (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
def get_export(
self,
*,
restApiId: str,
stageName: str,
exportType: str,
parameters: Mapping[str, str] = ...,
accepts: str = ...,
) -> ExportResponseTypeDef: # (1)
...
kwargs: GetExportRequestRequestTypeDef = { # (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
def get_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
) -> GatewayResponseResponseMetadataTypeDef: # (2)
...
kwargs: GetGatewayResponseRequestRequestTypeDef = { # (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
def get_gateway_responses(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> GatewayResponsesTypeDef: # (1)
...
kwargs: GetGatewayResponsesRequestRequestTypeDef = { # (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
def get_integration(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
) -> IntegrationResponseMetadataTypeDef: # (1)
...
kwargs: GetIntegrationRequestRequestTypeDef = { # (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
def get_integration_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> IntegrationResponseResponseMetadataTypeDef: # (1)
...
kwargs: GetIntegrationResponseRequestRequestTypeDef = { # (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
def get_method(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
) -> MethodResponseMetadataTypeDef: # (1)
...
kwargs: GetMethodRequestRequestTypeDef = { # (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
def get_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
) -> MethodResponseResponseMetadataTypeDef: # (1)
...
kwargs: GetMethodResponseRequestRequestTypeDef = { # (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
def get_model(
self,
*,
restApiId: str,
modelName: str,
flatten: bool = ...,
) -> ModelResponseMetadataTypeDef: # (1)
...
kwargs: GetModelRequestRequestTypeDef = { # (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
def get_model_template(
self,
*,
restApiId: str,
modelName: str,
) -> TemplateTypeDef: # (1)
...
- See TemplateTypeDef
kwargs: GetModelTemplateRequestRequestTypeDef = { # (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
def get_models(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> ModelsTypeDef: # (1)
...
- See ModelsTypeDef
kwargs: GetModelsRequestRequestTypeDef = { # (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
def get_request_validator(
self,
*,
restApiId: str,
requestValidatorId: str,
) -> RequestValidatorResponseMetadataTypeDef: # (1)
...
kwargs: GetRequestValidatorRequestRequestTypeDef = { # (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
def get_request_validators(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
) -> RequestValidatorsTypeDef: # (1)
...
kwargs: GetRequestValidatorsRequestRequestTypeDef = { # (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
def get_resource(
self,
*,
restApiId: str,
resourceId: str,
embed: Sequence[str] = ...,
) -> ResourceResponseMetadataTypeDef: # (1)
...
kwargs: GetResourceRequestRequestTypeDef = { # (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
def get_resources(
self,
*,
restApiId: str,
position: str = ...,
limit: int = ...,
embed: Sequence[str] = ...,
) -> ResourcesTypeDef: # (1)
...
- See ResourcesTypeDef
kwargs: GetResourcesRequestRequestTypeDef = { # (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
def get_rest_api(
self,
*,
restApiId: str,
) -> RestApiResponseMetadataTypeDef: # (1)
...
kwargs: GetRestApiRequestRequestTypeDef = { # (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
def get_rest_apis(
self,
*,
position: str = ...,
limit: int = ...,
) -> RestApisTypeDef: # (1)
...
- See RestApisTypeDef
kwargs: GetRestApisRequestRequestTypeDef = { # (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
def get_sdk(
self,
*,
restApiId: str,
stageName: str,
sdkType: str,
parameters: Mapping[str, str] = ...,
) -> SdkResponseTypeDef: # (1)
...
kwargs: GetSdkRequestRequestTypeDef = { # (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
kwargs: GetSdkTypeRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_sdk_type(**kwargs)
get_sdk_types
Gets SDK types See also: AWS API Documentation.
Type annotations and code completion for boto3.client("apigateway").get_sdk_types
method.
boto3 documentation
def get_sdk_types(
self,
*,
position: str = ...,
limit: int = ...,
) -> SdkTypesTypeDef: # (1)
...
- See SdkTypesTypeDef
kwargs: GetSdkTypesRequestRequestTypeDef = { # (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
def get_stage(
self,
*,
restApiId: str,
stageName: str,
) -> StageResponseMetadataTypeDef: # (1)
...
kwargs: GetStageRequestRequestTypeDef = { # (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
def get_stages(
self,
*,
restApiId: str,
deploymentId: str = ...,
) -> StagesTypeDef: # (1)
...
- See StagesTypeDef
kwargs: GetStagesRequestRequestTypeDef = { # (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
def get_tags(
self,
*,
resourceArn: str,
position: str = ...,
limit: int = ...,
) -> TagsTypeDef: # (1)
...
- See TagsTypeDef
kwargs: GetTagsRequestRequestTypeDef = { # (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
def get_usage(
self,
*,
usagePlanId: str,
startDate: str,
endDate: str,
keyId: str = ...,
position: str = ...,
limit: int = ...,
) -> UsageTypeDef: # (1)
...
- See UsageTypeDef
kwargs: GetUsageRequestRequestTypeDef = { # (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
def get_usage_plan(
self,
*,
usagePlanId: str,
) -> UsagePlanResponseMetadataTypeDef: # (1)
...
kwargs: GetUsagePlanRequestRequestTypeDef = { # (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
def get_usage_plan_key(
self,
*,
usagePlanId: str,
keyId: str,
) -> UsagePlanKeyResponseMetadataTypeDef: # (1)
...
kwargs: GetUsagePlanKeyRequestRequestTypeDef = { # (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
def get_usage_plan_keys(
self,
*,
usagePlanId: str,
position: str = ...,
limit: int = ...,
nameQuery: str = ...,
) -> UsagePlanKeysTypeDef: # (1)
...
kwargs: GetUsagePlanKeysRequestRequestTypeDef = { # (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
def get_usage_plans(
self,
*,
position: str = ...,
keyId: str = ...,
limit: int = ...,
) -> UsagePlansTypeDef: # (1)
...
kwargs: GetUsagePlansRequestRequestTypeDef = { # (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
def get_vpc_link(
self,
*,
vpcLinkId: str,
) -> VpcLinkResponseMetadataTypeDef: # (1)
...
kwargs: GetVpcLinkRequestRequestTypeDef = { # (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
def get_vpc_links(
self,
*,
position: str = ...,
limit: int = ...,
) -> VpcLinksTypeDef: # (1)
...
- See VpcLinksTypeDef
kwargs: GetVpcLinksRequestRequestTypeDef = { # (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
def import_api_keys(
self,
*,
body: Union[str, bytes, IO[Any], StreamingBody],
format: ApiKeysFormatType, # (1)
failOnWarnings: bool = ...,
) -> ApiKeyIdsTypeDef: # (2)
...
- See ApiKeysFormatType
- See ApiKeyIdsTypeDef
kwargs: ImportApiKeysRequestRequestTypeDef = { # (1)
"body": ...,
"format": ...,
}
parent.import_api_keys(**kwargs)
import_documentation_parts
Imports documentation parts See also: AWS API Documentation.
Type annotations and code completion for boto3.client("apigateway").import_documentation_parts
method.
boto3 documentation
def import_documentation_parts(
self,
*,
restApiId: str,
body: Union[str, bytes, IO[Any], StreamingBody],
mode: PutModeType = ..., # (1)
failOnWarnings: bool = ...,
) -> DocumentationPartIdsTypeDef: # (2)
...
kwargs: ImportDocumentationPartsRequestRequestTypeDef = { # (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
def import_rest_api(
self,
*,
body: Union[str, bytes, IO[Any], StreamingBody],
failOnWarnings: bool = ...,
parameters: Mapping[str, str] = ...,
) -> RestApiResponseMetadataTypeDef: # (1)
...
kwargs: ImportRestApiRequestRequestTypeDef = { # (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
def put_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
statusCode: str = ...,
responseParameters: Mapping[str, str] = ...,
responseTemplates: Mapping[str, str] = ...,
) -> GatewayResponseResponseMetadataTypeDef: # (2)
...
kwargs: PutGatewayResponseRequestRequestTypeDef = { # (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
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)
) -> IntegrationResponseMetadataTypeDef: # (5)
...
- See IntegrationTypeType
- See ConnectionTypeType
- See ContentHandlingStrategyType
- See TlsConfigTypeDef
- See IntegrationResponseMetadataTypeDef
kwargs: PutIntegrationRequestRequestTypeDef = { # (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
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)
) -> IntegrationResponseResponseMetadataTypeDef: # (2)
...
kwargs: PutIntegrationResponseRequestRequestTypeDef = { # (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
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] = ...,
) -> MethodResponseMetadataTypeDef: # (1)
...
kwargs: PutMethodRequestRequestTypeDef = { # (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
def put_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
responseParameters: Mapping[str, bool] = ...,
responseModels: Mapping[str, str] = ...,
) -> MethodResponseResponseMetadataTypeDef: # (1)
...
kwargs: PutMethodResponseRequestRequestTypeDef = { # (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
def put_rest_api(
self,
*,
restApiId: str,
body: Union[str, bytes, IO[Any], StreamingBody],
mode: PutModeType = ..., # (1)
failOnWarnings: bool = ...,
parameters: Mapping[str, str] = ...,
) -> RestApiResponseMetadataTypeDef: # (2)
...
kwargs: PutRestApiRequestRequestTypeDef = { # (1)
"restApiId": ...,
"body": ...,
}
parent.put_rest_api(**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
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (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
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)
...
kwargs: TestInvokeAuthorizerRequestRequestTypeDef = { # (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
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)
...
kwargs: TestInvokeMethodRequestRequestTypeDef = { # (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
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (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
def update_account(
self,
*,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> AccountTypeDef: # (2)
...
- See PatchOperationTypeDef
- See AccountTypeDef
kwargs: UpdateAccountRequestRequestTypeDef = { # (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
def update_api_key(
self,
*,
apiKey: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ApiKeyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateApiKeyRequestRequestTypeDef = { # (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
def update_authorizer(
self,
*,
restApiId: str,
authorizerId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> AuthorizerResponseMetadataTypeDef: # (2)
...
kwargs: UpdateAuthorizerRequestRequestTypeDef = { # (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
def update_base_path_mapping(
self,
*,
domainName: str,
basePath: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> BasePathMappingResponseMetadataTypeDef: # (2)
...
kwargs: UpdateBasePathMappingRequestRequestTypeDef = { # (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
def update_client_certificate(
self,
*,
clientCertificateId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ClientCertificateResponseMetadataTypeDef: # (2)
...
kwargs: UpdateClientCertificateRequestRequestTypeDef = { # (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
def update_deployment(
self,
*,
restApiId: str,
deploymentId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DeploymentResponseMetadataTypeDef: # (2)
...
kwargs: UpdateDeploymentRequestRequestTypeDef = { # (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
def update_documentation_part(
self,
*,
restApiId: str,
documentationPartId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DocumentationPartResponseMetadataTypeDef: # (2)
...
kwargs: UpdateDocumentationPartRequestRequestTypeDef = { # (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
def update_documentation_version(
self,
*,
restApiId: str,
documentationVersion: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DocumentationVersionResponseMetadataTypeDef: # (2)
...
kwargs: UpdateDocumentationVersionRequestRequestTypeDef = { # (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
def update_domain_name(
self,
*,
domainName: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> DomainNameResponseMetadataTypeDef: # (2)
...
kwargs: UpdateDomainNameRequestRequestTypeDef = { # (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
def update_gateway_response(
self,
*,
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (2)
) -> GatewayResponseResponseMetadataTypeDef: # (3)
...
kwargs: UpdateGatewayResponseRequestRequestTypeDef = { # (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
def update_integration(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> IntegrationResponseMetadataTypeDef: # (2)
...
kwargs: UpdateIntegrationRequestRequestTypeDef = { # (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
def update_integration_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> IntegrationResponseResponseMetadataTypeDef: # (2)
...
kwargs: UpdateIntegrationResponseRequestRequestTypeDef = { # (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
def update_method(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> MethodResponseMetadataTypeDef: # (2)
...
kwargs: UpdateMethodRequestRequestTypeDef = { # (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
def update_method_response(
self,
*,
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> MethodResponseResponseMetadataTypeDef: # (2)
...
kwargs: UpdateMethodResponseRequestRequestTypeDef = { # (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
def update_model(
self,
*,
restApiId: str,
modelName: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ModelResponseMetadataTypeDef: # (2)
...
kwargs: UpdateModelRequestRequestTypeDef = { # (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
def update_request_validator(
self,
*,
restApiId: str,
requestValidatorId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> RequestValidatorResponseMetadataTypeDef: # (2)
...
kwargs: UpdateRequestValidatorRequestRequestTypeDef = { # (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
def update_resource(
self,
*,
restApiId: str,
resourceId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> ResourceResponseMetadataTypeDef: # (2)
...
kwargs: UpdateResourceRequestRequestTypeDef = { # (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
def update_rest_api(
self,
*,
restApiId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> RestApiResponseMetadataTypeDef: # (2)
...
kwargs: UpdateRestApiRequestRequestTypeDef = { # (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
def update_stage(
self,
*,
restApiId: str,
stageName: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> StageResponseMetadataTypeDef: # (2)
...
kwargs: UpdateStageRequestRequestTypeDef = { # (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
def update_usage(
self,
*,
usagePlanId: str,
keyId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> UsageTypeDef: # (2)
...
- See PatchOperationTypeDef
- See UsageTypeDef
kwargs: UpdateUsageRequestRequestTypeDef = { # (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
def update_usage_plan(
self,
*,
usagePlanId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> UsagePlanResponseMetadataTypeDef: # (2)
...
kwargs: UpdateUsagePlanRequestRequestTypeDef = { # (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
def update_vpc_link(
self,
*,
vpcLinkId: str,
patchOperations: Sequence[PatchOperationTypeDef] = ..., # (1)
) -> VpcLinkResponseMetadataTypeDef: # (2)
...
kwargs: UpdateVpcLinkRequestRequestTypeDef = { # (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