import_rest_api¶
Operation¶
async
¶
import_rest_api(input: ImportRestApiInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
ImportRestApiInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ImportRestApiOutput
|
An instance of |
Input¶
dataclass
¶
A POST request to import an API to API Gateway using an input of an API definition file.
Attributes¶
class-attribute
instance-attribute
¶
body: bytes | None = 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.
class-attribute
instance-attribute
¶
fail_on_warnings: bool = False
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.
class-attribute
instance-attribute
¶
parameters: dict[str, str] | None = 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¶
dataclass
¶
Represents a REST API.
Attributes¶
class-attribute
instance-attribute
¶
api_key_source: ApiKeySourceType | None = 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.
class-attribute
instance-attribute
¶
api_status: ApiStatus | None = None
The ApiStatus of the RestApi.
class-attribute
instance-attribute
¶
api_status_message: str | None = None
The status message of the RestApi. When the status message is UPDATING
you can still invoke it.
class-attribute
instance-attribute
¶
binary_media_types: list[str] | None = None
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
class-attribute
instance-attribute
¶
created_date: datetime | None = None
The timestamp when the API was created.
class-attribute
instance-attribute
¶
description: str | None = None
The API's description.
class-attribute
instance-attribute
¶
disable_execute_api_endpoint: bool = False
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.
class-attribute
instance-attribute
¶
endpoint_access_mode: EndpointAccessMode | None = None
The endpoint access mode of the RestApi.
class-attribute
instance-attribute
¶
endpoint_configuration: EndpointConfiguration | None = None
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
class-attribute
instance-attribute
¶
id: str | None = None
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
class-attribute
instance-attribute
¶
minimum_compression_size: int | None = 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.
class-attribute
instance-attribute
¶
policy: str | None = None
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
class-attribute
instance-attribute
¶
root_resource_id: str | None = None
The API's root resource ID.
class-attribute
instance-attribute
¶
security_policy: SecurityPolicy | None = None
The Transport Layer Security (TLS) version + cipher suite for this RestApi.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The collection of tags. Each tag element is associated with a given resource.
class-attribute
instance-attribute
¶
version: str | None = None
A version identifier for the API.
class-attribute
instance-attribute
¶
warnings: list[str] | None = None
The warning messages reported when failonwarnings is turned on during
API import.