create_rest_api¶
Operation¶
create_rest_api
¶
create_rest_api(request: CreateRestApiInput | CreateRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRestApiInputDict]) -> CreateRestApiOutput
Creates a new RestApi resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRestApiInput | CreateRestApiInputDict | 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[CreateRestApiInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRestApiOutput
|
An instance of |
create_rest_api
async
¶
create_rest_api(request: CreateRestApiInput | CreateRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRestApiInputDict]) -> CreateRestApiOutput
Creates a new RestApi resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRestApiInput | CreateRestApiInputDict | 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[CreateRestApiInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRestApiOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateRestApiInputDict
¶
Bases: TypedDict
Dictionary form of CreateRestApiInput.
Attributes¶
api_key_source
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.
binary_media_types
instance-attribute
¶
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
clone_from
instance-attribute
¶
clone_from: str | None
The ID of the RestApi that you want to clone from.
disable_execute_api_endpoint
instance-attribute
¶
disable_execute_api_endpoint: bool | None
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
instance-attribute
¶
endpoint_access_mode: str | None
The endpoint access mode of the RestApi. Only available for RestApis
that use security policies that start with SecurityPolicy_.
endpoint_configuration
instance-attribute
¶
endpoint_configuration: EndpointConfiguration | EndpointConfigurationDict | None
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
minimum_compression_size
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.
policy
instance-attribute
¶
policy: str | None
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
security_policy
instance-attribute
¶
security_policy: str | None
The Transport Layer Security (TLS) version + cipher suite for this RestApi.
tags
instance-attribute
¶
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
CreateRestApiInput
dataclass
¶
Bases: _SerdeShape
The POST Request to add a new RestApi resource to your collection.
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.
binary_media_types
class-attribute
instance-attribute
¶
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
clone_from
class-attribute
instance-attribute
¶
clone_from: str | None = ...
The ID of the RestApi that you want to clone from.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the RestApi.
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. Only available for RestApis
that use security policies that start with SecurityPolicy_.
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.
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.
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.
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
¶
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
Output¶
CreateRestApiOutput
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
¶
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.
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
¶
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
¶
The collection of tags. Each tag element is associated with a given resource.