Skip to content

import_rest_api

Operation

import_rest_api

import_rest_api(request: ImportRestApiInput | ImportRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportRestApiInputDict]) -> ImportRestApiOutput

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

Parameters:

Name Type Description Default
request ImportRestApiInput | ImportRestApiInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ImportRestApiInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ImportRestApiOutput

An instance of ImportRestApiOutput.

import_rest_api async

import_rest_api(request: ImportRestApiInput | ImportRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportRestApiInputDict]) -> ImportRestApiOutput

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

Parameters:

Name Type Description Default
request ImportRestApiInput | ImportRestApiInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ImportRestApiInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ImportRestApiOutput

An instance of ImportRestApiOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ImportRestApiInputDict

Bases: TypedDict

Dictionary form of ImportRestApiInput.

Attributes

body instance-attribute
body: Required[bytes]

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

fail_on_warnings instance-attribute
fail_on_warnings: bool | None

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

parameters instance-attribute
parameters: Mapping[str, str] | None

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

ImportRestApiInput dataclass

Bases: _SerdeShape

A POST request to import an API to API Gateway using an input of an API definition file.

Attributes

body class-attribute instance-attribute
body: bytes | None = ...

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

fail_on_warnings class-attribute instance-attribute
fail_on_warnings: bool = ...

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

parameters class-attribute instance-attribute
parameters: dict[str, str] | None = ...

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

Output

ImportRestApiOutput dataclass

Bases: _SerdeShape

Represents a REST API.

Attributes

api_key_source class-attribute instance-attribute
api_key_source: str | None = ...

The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

api_status class-attribute instance-attribute
api_status: str | None = ...

The ApiStatus of the RestApi.

api_status_message class-attribute instance-attribute
api_status_message: str | None = ...

The status message of the RestApi. When the status message is UPDATING you can still invoke it.

binary_media_types class-attribute instance-attribute
binary_media_types: list[str] | None = ...

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The timestamp when the API was created.

description class-attribute instance-attribute
description: str | None = ...

The API's description.

disable_execute_api_endpoint class-attribute instance-attribute
disable_execute_api_endpoint: bool = ...

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

endpoint_access_mode class-attribute instance-attribute
endpoint_access_mode: str | None = ...

The endpoint access mode of the RestApi.

endpoint_configuration class-attribute instance-attribute
endpoint_configuration: EndpointConfiguration | None = ...

The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

id class-attribute instance-attribute
id: str | None = ...

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

minimum_compression_size class-attribute instance-attribute
minimum_compression_size: int | None = ...

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name class-attribute instance-attribute
name: str | None = ...

The API's name.

policy class-attribute instance-attribute
policy: str | None = ...

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

root_resource_id class-attribute instance-attribute
root_resource_id: str | None = ...

The API's root resource ID.

security_policy class-attribute instance-attribute
security_policy: str | None = ...

The Transport Layer Security (TLS) version + cipher suite for this RestApi.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The collection of tags. Each tag element is associated with a given resource.

version class-attribute instance-attribute
version: str | None = ...

A version identifier for the API.

warnings class-attribute instance-attribute
warnings: list[str] | None = ...

The warning messages reported when failonwarnings is turned on during API import.