rboto-api-gateway

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon API Gateway, powered by Rust. This package contains APIGatewayClient and 124 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[api-gateway]"

You can also install rboto-api-gateway directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import APIGatewayClient


async def main() -> None:
    client = APIGatewayClient(region="us-east-1")
    response = await client.get_rest_apis(limit=10)
    for api in response.items or []:
        print(api.id, api.name)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import APIGatewayClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_api_gateway.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_api_gateway.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_api_gateway.types; native response definitions are in the package's _native.pyi.

Method	Required arguments	Return type
create_api_key	None	CreateApiKeyOutput
create_authorizer	rest_api_id: str, name: str, type: AuthorizerType	CreateAuthorizerOutput
create_base_path_mapping	domain_name: str, rest_api_id: str	CreateBasePathMappingOutput
create_deployment	rest_api_id: str	CreateDeploymentOutput
create_documentation_part	rest_api_id: str, location: DocumentationPartLocation, properties: str	CreateDocumentationPartOutput
create_documentation_version	rest_api_id: str, documentation_version: str	CreateDocumentationVersionOutput
create_domain_name	domain_name: str	CreateDomainNameOutput
create_domain_name_access_association	domain_name_arn: str, access_association_source_type: AccessAssociationSourceType, access_association_source: str	CreateDomainNameAccessAssociationOutput
create_model	rest_api_id: str, name: str, content_type: str	CreateModelOutput
create_request_validator	rest_api_id: str	CreateRequestValidatorOutput
create_resource	rest_api_id: str, parent_id: str, path_part: str	CreateResourceOutput
create_rest_api	name: str	CreateRestApiOutput
create_stage	rest_api_id: str, stage_name: str, deployment_id: str	CreateStageOutput
create_usage_plan	name: str	CreateUsagePlanOutput
create_usage_plan_key	usage_plan_id: str, key_id: str, key_type: str	CreateUsagePlanKeyOutput
create_vpc_link	name: str, target_arns: Sequence[str]	CreateVpcLinkOutput
delete_api_key	api_key: str	None
delete_authorizer	rest_api_id: str, authorizer_id: str	None
delete_base_path_mapping	domain_name: str, base_path: str	None
delete_client_certificate	client_certificate_id: str	None
delete_deployment	rest_api_id: str, deployment_id: str	None
delete_documentation_part	rest_api_id: str, documentation_part_id: str	None
delete_documentation_version	rest_api_id: str, documentation_version: str	None
delete_domain_name	domain_name: str	None
delete_domain_name_access_association	domain_name_access_association_arn: str	None
delete_gateway_response	rest_api_id: str, response_type: GatewayResponseType	None
delete_integration	rest_api_id: str, resource_id: str, http_method: str	None
delete_integration_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	None
delete_method	rest_api_id: str, resource_id: str, http_method: str	None
delete_method_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	None
delete_model	rest_api_id: str, model_name: str	None
delete_request_validator	rest_api_id: str, request_validator_id: str	None
delete_resource	rest_api_id: str, resource_id: str	None
delete_rest_api	rest_api_id: str	None
delete_stage	rest_api_id: str, stage_name: str	None
delete_usage_plan	usage_plan_id: str	None
delete_usage_plan_key	usage_plan_id: str, key_id: str	None
delete_vpc_link	vpc_link_id: str	None
flush_stage_authorizers_cache	rest_api_id: str, stage_name: str	None
flush_stage_cache	rest_api_id: str, stage_name: str	None
generate_client_certificate	None	GenerateClientCertificateOutput
get_account	None	GetAccountOutput
get_api_key	api_key: str	GetApiKeyOutput
get_api_keys	None	GetApiKeysOutput
get_authorizer	rest_api_id: str, authorizer_id: str	GetAuthorizerOutput
get_authorizers	rest_api_id: str	GetAuthorizersOutput
get_base_path_mapping	domain_name: str, base_path: str	GetBasePathMappingOutput
get_base_path_mappings	domain_name: str	GetBasePathMappingsOutput
get_client_certificate	client_certificate_id: str	GetClientCertificateOutput
get_client_certificates	None	GetClientCertificatesOutput
get_deployment	rest_api_id: str, deployment_id: str	GetDeploymentOutput
get_deployments	rest_api_id: str	GetDeploymentsOutput
get_documentation_part	rest_api_id: str, documentation_part_id: str	GetDocumentationPartOutput
get_documentation_parts	rest_api_id: str	GetDocumentationPartsOutput
get_documentation_version	rest_api_id: str, documentation_version: str	GetDocumentationVersionOutput
get_documentation_versions	rest_api_id: str	GetDocumentationVersionsOutput
get_domain_name	domain_name: str	GetDomainNameOutput
get_domain_name_access_associations	None	GetDomainNameAccessAssociationsOutput
get_domain_names	None	GetDomainNamesOutput
get_export	rest_api_id: str, stage_name: str, export_type: str	GetExportOutput
get_gateway_response	rest_api_id: str, response_type: GatewayResponseType	GetGatewayResponseOutput
get_gateway_responses	rest_api_id: str	GetGatewayResponsesOutput
get_integration	rest_api_id: str, resource_id: str, http_method: str	GetIntegrationOutput
get_integration_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	GetIntegrationResponseOutput
get_method	rest_api_id: str, resource_id: str, http_method: str	GetMethodOutput
get_method_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	GetMethodResponseOutput
get_model	rest_api_id: str, model_name: str	GetModelOutput
get_model_template	rest_api_id: str, model_name: str	GetModelTemplateOutput
get_models	rest_api_id: str	GetModelsOutput
get_request_validator	rest_api_id: str, request_validator_id: str	GetRequestValidatorOutput
get_request_validators	rest_api_id: str	GetRequestValidatorsOutput
get_resource	rest_api_id: str, resource_id: str	GetResourceOutput
get_resources	rest_api_id: str	GetResourcesOutput
get_rest_api	rest_api_id: str	GetRestApiOutput
get_rest_apis	None	GetRestApisOutput
get_sdk	rest_api_id: str, stage_name: str, sdk_type: str	GetSdkOutput
get_sdk_type	id: str	GetSdkTypeOutput
get_sdk_types	None	GetSdkTypesOutput
get_stage	rest_api_id: str, stage_name: str	GetStageOutput
get_stages	rest_api_id: str	GetStagesOutput
get_tags	resource_arn: str	GetTagsOutput
get_usage	usage_plan_id: str, start_date: str, end_date: str	GetUsageOutput
get_usage_plan	usage_plan_id: str	GetUsagePlanOutput
get_usage_plan_key	usage_plan_id: str, key_id: str	GetUsagePlanKeyOutput
get_usage_plan_keys	usage_plan_id: str	GetUsagePlanKeysOutput
get_usage_plans	None	GetUsagePlansOutput
get_vpc_link	vpc_link_id: str	GetVpcLinkOutput
get_vpc_links	None	GetVpcLinksOutput
import_api_keys	body: bytes, format: ApiKeysFormat	ImportApiKeysOutput
import_documentation_parts	rest_api_id: str, body: bytes	ImportDocumentationPartsOutput
import_rest_api	body: bytes	ImportRestApiOutput
put_gateway_response	rest_api_id: str, response_type: GatewayResponseType	PutGatewayResponseOutput
put_integration	rest_api_id: str, resource_id: str, http_method: str, type: IntegrationType	PutIntegrationOutput
put_integration_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	PutIntegrationResponseOutput
put_method	rest_api_id: str, resource_id: str, http_method: str, authorization_type: str	PutMethodOutput
put_method_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	PutMethodResponseOutput
put_rest_api	rest_api_id: str, body: bytes	PutRestApiOutput
reject_domain_name_access_association	domain_name_access_association_arn: str, domain_name_arn: str	None
tag_resource	resource_arn: str, tags: dict[str, str]	None
test_invoke_authorizer	rest_api_id: str, authorizer_id: str	TestInvokeAuthorizerOutput
test_invoke_method	rest_api_id: str, resource_id: str, http_method: str	TestInvokeMethodOutput
untag_resource	resource_arn: str, tag_keys: Sequence[str]	None
update_account	None	UpdateAccountOutput
update_api_key	api_key: str	UpdateApiKeyOutput
update_authorizer	rest_api_id: str, authorizer_id: str	UpdateAuthorizerOutput
update_base_path_mapping	domain_name: str, base_path: str	UpdateBasePathMappingOutput
update_client_certificate	client_certificate_id: str	UpdateClientCertificateOutput
update_deployment	rest_api_id: str, deployment_id: str	UpdateDeploymentOutput
update_documentation_part	rest_api_id: str, documentation_part_id: str	UpdateDocumentationPartOutput
update_documentation_version	rest_api_id: str, documentation_version: str	UpdateDocumentationVersionOutput
update_domain_name	domain_name: str	UpdateDomainNameOutput
update_gateway_response	rest_api_id: str, response_type: GatewayResponseType	UpdateGatewayResponseOutput
update_integration	rest_api_id: str, resource_id: str, http_method: str	UpdateIntegrationOutput
update_integration_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	UpdateIntegrationResponseOutput
update_method	rest_api_id: str, resource_id: str, http_method: str	UpdateMethodOutput
update_method_response	rest_api_id: str, resource_id: str, http_method: str, status_code: str	UpdateMethodResponseOutput
update_model	rest_api_id: str, model_name: str	UpdateModelOutput
update_request_validator	rest_api_id: str, request_validator_id: str	UpdateRequestValidatorOutput
update_resource	rest_api_id: str, resource_id: str	UpdateResourceOutput
update_rest_api	rest_api_id: str	UpdateRestApiOutput
update_stage	rest_api_id: str, stage_name: str	UpdateStageOutput
update_usage	usage_plan_id: str, key_id: str	UpdateUsageOutput
update_usage_plan	usage_plan_id: str	UpdateUsagePlanOutput
update_vpc_link	vpc_link_id: str	UpdateVpcLinkOutput

Complete signatures

create_api_key

async def create_api_key(
    *,
    name: str | None = None,
    description: str | None = None,
    enabled: bool | None = None,
    generate_distinct_id: bool | None = None,
    value: str | None = None,
    stage_keys: Sequence[StageKey] | None = None,
    customer_id: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateApiKeyOutput: ...

create_authorizer

async def create_authorizer(
    *,
    rest_api_id: str,
    name: str,
    type: AuthorizerType,
    provider_arns: Sequence[str] | None = None,
    auth_type: str | None = None,
    authorizer_uri: str | None = None,
    authorizer_credentials: str | None = None,
    identity_source: str | None = None,
    identity_validation_expression: str | None = None,
    authorizer_result_ttl_in_seconds: int | None = None,
) -> CreateAuthorizerOutput: ...

create_base_path_mapping

async def create_base_path_mapping(
    *,
    domain_name: str,
    rest_api_id: str,
    domain_name_id: str | None = None,
    base_path: str | None = None,
    stage: str | None = None,
) -> CreateBasePathMappingOutput: ...

create_deployment

async def create_deployment(
    *,
    rest_api_id: str,
    stage_name: str | None = None,
    stage_description: str | None = None,
    description: str | None = None,
    cache_cluster_enabled: bool | None = None,
    cache_cluster_size: CacheClusterSize | None = None,
    variables: dict[str, str] | None = None,
    canary_settings: DeploymentCanarySettings | None = None,
    tracing_enabled: bool | None = None,
) -> CreateDeploymentOutput: ...

create_documentation_part

async def create_documentation_part(
    *,
    rest_api_id: str,
    location: DocumentationPartLocation,
    properties: str,
) -> CreateDocumentationPartOutput: ...

create_documentation_version

async def create_documentation_version(
    *,
    rest_api_id: str,
    documentation_version: str,
    stage_name: str | None = None,
    description: str | None = None,
) -> CreateDocumentationVersionOutput: ...

create_domain_name

async def create_domain_name(
    *,
    domain_name: str,
    certificate_name: str | None = None,
    certificate_body: str | None = None,
    certificate_private_key: str | None = None,
    certificate_chain: str | None = None,
    certificate_arn: str | None = None,
    regional_certificate_name: str | None = None,
    regional_certificate_arn: str | None = None,
    endpoint_configuration: EndpointConfiguration | None = None,
    tags: dict[str, str] | None = None,
    security_policy: SecurityPolicy | None = None,
    endpoint_access_mode: EndpointAccessMode | None = None,
    mutual_tls_authentication: MutualTlsAuthenticationInput | None = None,
    ownership_verification_certificate_arn: str | None = None,
    policy: str | None = None,
    routing_mode: RoutingMode | None = None,
) -> CreateDomainNameOutput: ...

create_domain_name_access_association

async def create_domain_name_access_association(
    *,
    domain_name_arn: str,
    access_association_source_type: AccessAssociationSourceType,
    access_association_source: str,
    tags: dict[str, str] | None = None,
) -> CreateDomainNameAccessAssociationOutput: ...

create_model

async def create_model(
    *,
    rest_api_id: str,
    name: str,
    content_type: str,
    description: str | None = None,
    schema: str | None = None,
) -> CreateModelOutput: ...

create_request_validator

async def create_request_validator(
    *,
    rest_api_id: str,
    name: str | None = None,
    validate_request_body: bool | None = None,
    validate_request_parameters: bool | None = None,
) -> CreateRequestValidatorOutput: ...

create_resource

async def create_resource(
    *,
    rest_api_id: str,
    parent_id: str,
    path_part: str,
) -> CreateResourceOutput: ...

create_rest_api

async def create_rest_api(
    *,
    name: str,
    description: str | None = None,
    version: str | None = None,
    clone_from: str | None = None,
    binary_media_types: Sequence[str] | None = None,
    minimum_compression_size: int | None = None,
    api_key_source: ApiKeySourceType | None = None,
    endpoint_configuration: EndpointConfiguration | None = None,
    policy: str | None = None,
    tags: dict[str, str] | None = None,
    disable_execute_api_endpoint: bool | None = None,
    security_policy: SecurityPolicy | None = None,
    endpoint_access_mode: EndpointAccessMode | None = None,
) -> CreateRestApiOutput: ...

create_stage

async def create_stage(
    *,
    rest_api_id: str,
    stage_name: str,
    deployment_id: str,
    description: str | None = None,
    cache_cluster_enabled: bool | None = None,
    cache_cluster_size: CacheClusterSize | None = None,
    variables: dict[str, str] | None = None,
    documentation_version: str | None = None,
    canary_settings: CanarySettings | None = None,
    tracing_enabled: bool | None = None,
    tags: dict[str, str] | None = None,
) -> CreateStageOutput: ...

create_usage_plan

async def create_usage_plan(
    *,
    name: str,
    description: str | None = None,
    api_stages: Sequence[ApiStage] | None = None,
    throttle: ThrottleSettings | None = None,
    quota: QuotaSettings | None = None,
    tags: dict[str, str] | None = None,
) -> CreateUsagePlanOutput: ...

create_usage_plan_key

async def create_usage_plan_key(
    *,
    usage_plan_id: str,
    key_id: str,
    key_type: str,
) -> CreateUsagePlanKeyOutput: ...

create_vpc_link

async def create_vpc_link(
    *,
    name: str,
    target_arns: Sequence[str],
    description: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateVpcLinkOutput: ...

delete_api_key

async def delete_api_key(
    *,
    api_key: str,
) -> None: ...

delete_authorizer

async def delete_authorizer(
    *,
    rest_api_id: str,
    authorizer_id: str,
) -> None: ...

delete_base_path_mapping

async def delete_base_path_mapping(
    *,
    domain_name: str,
    base_path: str,
    domain_name_id: str | None = None,
) -> None: ...

delete_client_certificate

async def delete_client_certificate(
    *,
    client_certificate_id: str,
) -> None: ...

delete_deployment

async def delete_deployment(
    *,
    rest_api_id: str,
    deployment_id: str,
) -> None: ...

delete_documentation_part

async def delete_documentation_part(
    *,
    rest_api_id: str,
    documentation_part_id: str,
) -> None: ...

delete_documentation_version

async def delete_documentation_version(
    *,
    rest_api_id: str,
    documentation_version: str,
) -> None: ...

delete_domain_name

async def delete_domain_name(
    *,
    domain_name: str,
    domain_name_id: str | None = None,
) -> None: ...

delete_domain_name_access_association

async def delete_domain_name_access_association(
    *,
    domain_name_access_association_arn: str,
) -> None: ...

delete_gateway_response

async def delete_gateway_response(
    *,
    rest_api_id: str,
    response_type: GatewayResponseType,
) -> None: ...

delete_integration

async def delete_integration(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
) -> None: ...

delete_integration_response

async def delete_integration_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
) -> None: ...

delete_method

async def delete_method(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
) -> None: ...

delete_method_response

async def delete_method_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
) -> None: ...

delete_model

async def delete_model(
    *,
    rest_api_id: str,
    model_name: str,
) -> None: ...

delete_request_validator

async def delete_request_validator(
    *,
    rest_api_id: str,
    request_validator_id: str,
) -> None: ...

delete_resource

async def delete_resource(
    *,
    rest_api_id: str,
    resource_id: str,
) -> None: ...

delete_rest_api

async def delete_rest_api(
    *,
    rest_api_id: str,
) -> None: ...

delete_stage

async def delete_stage(
    *,
    rest_api_id: str,
    stage_name: str,
) -> None: ...

delete_usage_plan

async def delete_usage_plan(
    *,
    usage_plan_id: str,
) -> None: ...

delete_usage_plan_key

async def delete_usage_plan_key(
    *,
    usage_plan_id: str,
    key_id: str,
) -> None: ...

delete_vpc_link

async def delete_vpc_link(
    *,
    vpc_link_id: str,
) -> None: ...

flush_stage_authorizers_cache

async def flush_stage_authorizers_cache(
    *,
    rest_api_id: str,
    stage_name: str,
) -> None: ...

flush_stage_cache

async def flush_stage_cache(
    *,
    rest_api_id: str,
    stage_name: str,
) -> None: ...

generate_client_certificate

async def generate_client_certificate(
    *,
    description: str | None = None,
    tags: dict[str, str] | None = None,
) -> GenerateClientCertificateOutput: ...

get_account

async def get_account() -> GetAccountOutput: ...

get_api_key

async def get_api_key(
    *,
    api_key: str,
    include_value: bool | None = None,
) -> GetApiKeyOutput: ...

get_api_keys

async def get_api_keys(
    *,
    position: str | None = None,
    limit: int | None = None,
    name_query: str | None = None,
    customer_id: str | None = None,
    include_values: bool | None = None,
) -> GetApiKeysOutput: ...

Also available as client.paginators.get_api_keys(...), returning an async iterator of the response type above.

get_authorizer

async def get_authorizer(
    *,
    rest_api_id: str,
    authorizer_id: str,
) -> GetAuthorizerOutput: ...

get_authorizers

async def get_authorizers(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetAuthorizersOutput: ...

Also available as client.paginators.get_authorizers(...), returning an async iterator of the response type above.

get_base_path_mapping

async def get_base_path_mapping(
    *,
    domain_name: str,
    base_path: str,
    domain_name_id: str | None = None,
) -> GetBasePathMappingOutput: ...

get_base_path_mappings

async def get_base_path_mappings(
    *,
    domain_name: str,
    domain_name_id: str | None = None,
    position: str | None = None,
    limit: int | None = None,
) -> GetBasePathMappingsOutput: ...

Also available as client.paginators.get_base_path_mappings(...), returning an async iterator of the response type above.

get_client_certificate

async def get_client_certificate(
    *,
    client_certificate_id: str,
) -> GetClientCertificateOutput: ...

get_client_certificates

async def get_client_certificates(
    *,
    position: str | None = None,
    limit: int | None = None,
) -> GetClientCertificatesOutput: ...

Also available as client.paginators.get_client_certificates(...), returning an async iterator of the response type above.

get_deployment

async def get_deployment(
    *,
    rest_api_id: str,
    deployment_id: str,
    embed: Sequence[str] | None = None,
) -> GetDeploymentOutput: ...

get_deployments

async def get_deployments(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetDeploymentsOutput: ...

Also available as client.paginators.get_deployments(...), returning an async iterator of the response type above.

get_documentation_part

async def get_documentation_part(
    *,
    rest_api_id: str,
    documentation_part_id: str,
) -> GetDocumentationPartOutput: ...

get_documentation_parts

async def get_documentation_parts(
    *,
    rest_api_id: str,
    type: DocumentationPartType | None = None,
    name_query: str | None = None,
    path: str | None = None,
    position: str | None = None,
    limit: int | None = None,
    location_status: LocationStatusType | None = None,
) -> GetDocumentationPartsOutput: ...

Also available as client.paginators.get_documentation_parts(...), returning an async iterator of the response type above.

get_documentation_version

async def get_documentation_version(
    *,
    rest_api_id: str,
    documentation_version: str,
) -> GetDocumentationVersionOutput: ...

get_documentation_versions

async def get_documentation_versions(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetDocumentationVersionsOutput: ...

Also available as client.paginators.get_documentation_versions(...), returning an async iterator of the response type above.

get_domain_name

async def get_domain_name(
    *,
    domain_name: str,
    domain_name_id: str | None = None,
) -> GetDomainNameOutput: ...

get_domain_name_access_associations

async def get_domain_name_access_associations(
    *,
    position: str | None = None,
    limit: int | None = None,
    resource_owner: ResourceOwner | None = None,
) -> GetDomainNameAccessAssociationsOutput: ...

get_domain_names

async def get_domain_names(
    *,
    position: str | None = None,
    limit: int | None = None,
    resource_owner: ResourceOwner | None = None,
) -> GetDomainNamesOutput: ...

Also available as client.paginators.get_domain_names(...), returning an async iterator of the response type above.

get_export

async def get_export(
    *,
    rest_api_id: str,
    stage_name: str,
    export_type: str,
    parameters: dict[str, str] | None = None,
    accepts: str | None = None,
) -> GetExportOutput: ...

get_gateway_response

async def get_gateway_response(
    *,
    rest_api_id: str,
    response_type: GatewayResponseType,
) -> GetGatewayResponseOutput: ...

get_gateway_responses

async def get_gateway_responses(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetGatewayResponsesOutput: ...

Also available as client.paginators.get_gateway_responses(...), returning an async iterator of the response type above.

get_integration

async def get_integration(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
) -> GetIntegrationOutput: ...

get_integration_response

async def get_integration_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
) -> GetIntegrationResponseOutput: ...

get_method

async def get_method(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
) -> GetMethodOutput: ...

get_method_response

async def get_method_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
) -> GetMethodResponseOutput: ...

get_model

async def get_model(
    *,
    rest_api_id: str,
    model_name: str,
    flatten: bool | None = None,
) -> GetModelOutput: ...

get_model_template

async def get_model_template(
    *,
    rest_api_id: str,
    model_name: str,
) -> GetModelTemplateOutput: ...

get_models

async def get_models(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetModelsOutput: ...

Also available as client.paginators.get_models(...), returning an async iterator of the response type above.

get_request_validator

async def get_request_validator(
    *,
    rest_api_id: str,
    request_validator_id: str,
) -> GetRequestValidatorOutput: ...

get_request_validators

async def get_request_validators(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetRequestValidatorsOutput: ...

Also available as client.paginators.get_request_validators(...), returning an async iterator of the response type above.

get_resource

async def get_resource(
    *,
    rest_api_id: str,
    resource_id: str,
    embed: Sequence[str] | None = None,
) -> GetResourceOutput: ...

get_resources

async def get_resources(
    *,
    rest_api_id: str,
    position: str | None = None,
    limit: int | None = None,
    embed: Sequence[str] | None = None,
) -> GetResourcesOutput: ...

Also available as client.paginators.get_resources(...), returning an async iterator of the response type above.

get_rest_api

async def get_rest_api(
    *,
    rest_api_id: str,
) -> GetRestApiOutput: ...

get_rest_apis

async def get_rest_apis(
    *,
    position: str | None = None,
    limit: int | None = None,
) -> GetRestApisOutput: ...

Also available as client.paginators.get_rest_apis(...), returning an async iterator of the response type above.

get_sdk

async def get_sdk(
    *,
    rest_api_id: str,
    stage_name: str,
    sdk_type: str,
    parameters: dict[str, str] | None = None,
) -> GetSdkOutput: ...

get_sdk_type

async def get_sdk_type(
    *,
    id: str,
) -> GetSdkTypeOutput: ...

get_sdk_types

async def get_sdk_types(
    *,
    position: str | None = None,
    limit: int | None = None,
) -> GetSdkTypesOutput: ...

get_stage

async def get_stage(
    *,
    rest_api_id: str,
    stage_name: str,
) -> GetStageOutput: ...

get_stages

async def get_stages(
    *,
    rest_api_id: str,
    deployment_id: str | None = None,
) -> GetStagesOutput: ...

get_tags

async def get_tags(
    *,
    resource_arn: str,
    position: str | None = None,
    limit: int | None = None,
) -> GetTagsOutput: ...

get_usage

async def get_usage(
    *,
    usage_plan_id: str,
    start_date: str,
    end_date: str,
    key_id: str | None = None,
    position: str | None = None,
    limit: int | None = None,
) -> GetUsageOutput: ...

Also available as client.paginators.get_usage(...), returning an async iterator of the response type above.

get_usage_plan

async def get_usage_plan(
    *,
    usage_plan_id: str,
) -> GetUsagePlanOutput: ...

get_usage_plan_key

async def get_usage_plan_key(
    *,
    usage_plan_id: str,
    key_id: str,
) -> GetUsagePlanKeyOutput: ...

get_usage_plan_keys

async def get_usage_plan_keys(
    *,
    usage_plan_id: str,
    position: str | None = None,
    limit: int | None = None,
    name_query: str | None = None,
) -> GetUsagePlanKeysOutput: ...

Also available as client.paginators.get_usage_plan_keys(...), returning an async iterator of the response type above.

get_usage_plans

async def get_usage_plans(
    *,
    position: str | None = None,
    key_id: str | None = None,
    limit: int | None = None,
) -> GetUsagePlansOutput: ...

Also available as client.paginators.get_usage_plans(...), returning an async iterator of the response type above.

get_vpc_link

async def get_vpc_link(
    *,
    vpc_link_id: str,
) -> GetVpcLinkOutput: ...

get_vpc_links

async def get_vpc_links(
    *,
    position: str | None = None,
    limit: int | None = None,
) -> GetVpcLinksOutput: ...

Also available as client.paginators.get_vpc_links(...), returning an async iterator of the response type above.

import_api_keys

async def import_api_keys(
    *,
    body: bytes,
    format: ApiKeysFormat,
    fail_on_warnings: bool | None = None,
) -> ImportApiKeysOutput: ...

import_documentation_parts

async def import_documentation_parts(
    *,
    rest_api_id: str,
    body: bytes,
    mode: PutMode | None = None,
    fail_on_warnings: bool | None = None,
) -> ImportDocumentationPartsOutput: ...

import_rest_api

async def import_rest_api(
    *,
    body: bytes,
    fail_on_warnings: bool | None = None,
    parameters: dict[str, str] | None = None,
) -> ImportRestApiOutput: ...

put_gateway_response

async def put_gateway_response(
    *,
    rest_api_id: str,
    response_type: GatewayResponseType,
    status_code: str | None = None,
    response_parameters: dict[str, str] | None = None,
    response_templates: dict[str, str] | None = None,
) -> PutGatewayResponseOutput: ...

put_integration

async def put_integration(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    type: IntegrationType,
    integration_http_method: str | None = None,
    uri: str | None = None,
    connection_type: ConnectionType | None = None,
    connection_id: str | None = None,
    credentials: str | None = None,
    request_parameters: dict[str, str] | None = None,
    request_templates: dict[str, str] | None = None,
    passthrough_behavior: str | None = None,
    cache_namespace: str | None = None,
    cache_key_parameters: Sequence[str] | None = None,
    content_handling: ContentHandlingStrategy | None = None,
    timeout_in_millis: int | None = None,
    tls_config: TlsConfig | None = None,
    response_transfer_mode: ResponseTransferMode | None = None,
    integration_target: str | None = None,
) -> PutIntegrationOutput: ...

put_integration_response

async def put_integration_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
    selection_pattern: str | None = None,
    response_parameters: dict[str, str] | None = None,
    response_templates: dict[str, str] | None = None,
    content_handling: ContentHandlingStrategy | None = None,
) -> PutIntegrationResponseOutput: ...

put_method

async def put_method(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    authorization_type: str,
    authorizer_id: str | None = None,
    api_key_required: bool | None = None,
    operation_name: str | None = None,
    request_parameters: dict[str, bool] | None = None,
    request_models: dict[str, str] | None = None,
    request_validator_id: str | None = None,
    authorization_scopes: Sequence[str] | None = None,
) -> PutMethodOutput: ...

put_method_response

async def put_method_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
    response_parameters: dict[str, bool] | None = None,
    response_models: dict[str, str] | None = None,
) -> PutMethodResponseOutput: ...

put_rest_api

async def put_rest_api(
    *,
    rest_api_id: str,
    body: bytes,
    mode: PutMode | None = None,
    fail_on_warnings: bool | None = None,
    parameters: dict[str, str] | None = None,
) -> PutRestApiOutput: ...

reject_domain_name_access_association

async def reject_domain_name_access_association(
    *,
    domain_name_access_association_arn: str,
    domain_name_arn: str,
) -> None: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: dict[str, str],
) -> None: ...

test_invoke_authorizer

async def test_invoke_authorizer(
    *,
    rest_api_id: str,
    authorizer_id: str,
    headers: dict[str, str] | None = None,
    multi_value_headers: dict[str, Sequence[str]] | None = None,
    path_with_query_string: str | None = None,
    body: str | None = None,
    stage_variables: dict[str, str] | None = None,
    additional_context: dict[str, str] | None = None,
) -> TestInvokeAuthorizerOutput: ...

test_invoke_method

async def test_invoke_method(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    path_with_query_string: str | None = None,
    body: str | None = None,
    headers: dict[str, str] | None = None,
    multi_value_headers: dict[str, Sequence[str]] | None = None,
    client_certificate_id: str | None = None,
    stage_variables: dict[str, str] | None = None,
) -> TestInvokeMethodOutput: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: Sequence[str],
) -> None: ...

update_account

async def update_account(
    *,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateAccountOutput: ...

update_api_key

async def update_api_key(
    *,
    api_key: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateApiKeyOutput: ...

update_authorizer

async def update_authorizer(
    *,
    rest_api_id: str,
    authorizer_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateAuthorizerOutput: ...

update_base_path_mapping

async def update_base_path_mapping(
    *,
    domain_name: str,
    base_path: str,
    domain_name_id: str | None = None,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateBasePathMappingOutput: ...

update_client_certificate

async def update_client_certificate(
    *,
    client_certificate_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateClientCertificateOutput: ...

update_deployment

async def update_deployment(
    *,
    rest_api_id: str,
    deployment_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateDeploymentOutput: ...

update_documentation_part

async def update_documentation_part(
    *,
    rest_api_id: str,
    documentation_part_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateDocumentationPartOutput: ...

update_documentation_version

async def update_documentation_version(
    *,
    rest_api_id: str,
    documentation_version: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateDocumentationVersionOutput: ...

update_domain_name

async def update_domain_name(
    *,
    domain_name: str,
    domain_name_id: str | None = None,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateDomainNameOutput: ...

update_gateway_response

async def update_gateway_response(
    *,
    rest_api_id: str,
    response_type: GatewayResponseType,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateGatewayResponseOutput: ...

update_integration

async def update_integration(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateIntegrationOutput: ...

update_integration_response

async def update_integration_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateIntegrationResponseOutput: ...

update_method

async def update_method(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateMethodOutput: ...

update_method_response

async def update_method_response(
    *,
    rest_api_id: str,
    resource_id: str,
    http_method: str,
    status_code: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateMethodResponseOutput: ...

update_model

async def update_model(
    *,
    rest_api_id: str,
    model_name: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateModelOutput: ...

update_request_validator

async def update_request_validator(
    *,
    rest_api_id: str,
    request_validator_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateRequestValidatorOutput: ...

update_resource

async def update_resource(
    *,
    rest_api_id: str,
    resource_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateResourceOutput: ...

update_rest_api

async def update_rest_api(
    *,
    rest_api_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateRestApiOutput: ...

update_stage

async def update_stage(
    *,
    rest_api_id: str,
    stage_name: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateStageOutput: ...

update_usage

async def update_usage(
    *,
    usage_plan_id: str,
    key_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateUsageOutput: ...

update_usage_plan

async def update_usage_plan(
    *,
    usage_plan_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateUsagePlanOutput: ...

update_vpc_link

async def update_vpc_link(
    *,
    vpc_link_id: str,
    patch_operations: Sequence[PatchOperation] | None = None,
) -> UpdateVpcLinkOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.