API Gateway

class apigateway.rest_api

Example:

resources = storage_connector.read_resources(
    service="apigateway",
    resource_type="rest_api")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.api_key_source)
    print(resource.binary_media_types)
    print(resource.created_date)
    print(resource.description)
    print(resource.disable_execute_api_endpoint)
    print(resource.endpoint_configuration)
    print(resource.minimum_compression_size)
    print(resource.name)
    print(resource.policy)
    print(resource.tags)
    print(resource.version)
    print(resource.warnings)
api_key_source

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

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

created_date

The timestamp when the API was created.

description

The API’s description.

disable_execute_api_endpoint

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_configuration

The endpoint configuration of this RestApi showing the endpoint types of the API.

minimum_compression_size

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

The API’s name.

policy

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

tags

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

version

A version identifier for the API.

warnings

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