Module Values.AwsApiGatewayRestApiDetailsSource

Contains information about a REST API in version 1 of Amazon API Gateway.

Sourcetype nonrec t = {
  1. id : NonEmptyString.t option;
    (*

    The identifier of the REST API.

    *)
  2. name : NonEmptyString.t option;
    (*

    The name of the REST API.

    *)
  3. description : NonEmptyString.t option;
    (*

    A description of the REST API.

    *)
  4. createdDate : NonEmptyString.t option;
    (*

    Indicates when the API was created. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

    *)
  5. version : NonEmptyString.t option;
    (*

    The version identifier for the REST API.

    *)
  6. binaryMediaTypes : NonEmptyStringList.t option;
    (*

    The list of binary media types supported by the REST API.

    *)
  7. minimumCompressionSize : Integer.t option;
    (*

    The minimum size in bytes of a payload before compression is enabled. If null, then compression is disabled. If 0, then all payloads are compressed.

    *)
  8. apiKeySource : NonEmptyString.t option;
    (*

    The source of the API key for metering requests according to a usage plan. HEADER indicates whether to read the API key from the X-API-Key header of a request. AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

    *)
  9. endpointConfiguration : AwsApiGatewayEndpointConfiguration.t option;
    (*

    The endpoint configuration of the REST API.

    *)
}
Sourceval make : ?id:??? -> ?name:??? -> ?description:??? -> ?createdDate:??? -> ?version:??? -> ?binaryMediaTypes:??? -> ?minimumCompressionSize:??? -> ?apiKeySource:??? -> ?endpointConfiguration:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Integer.t | `List of [> `String of NonEmptyString.t ] list | `String of NonEmptyString.t | `Structure of (string * [> `List of [> `String of NonEmptyString.t ] list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t