Module Values.ImportApiResponseSource

Imports an API.

Sourcetype nonrec t = {
  1. apiEndpoint : string option;
    (*

    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    *)
  2. apiGatewayManaged : bool option;
    (*

    Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    *)
  3. apiId : Id.t option;
    (*

    The API ID.

    *)
  4. apiKeySelectionExpression : SelectionExpression.t option;
    (*

    An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    *)
  5. corsConfiguration : Cors.t option;
    (*

    A CORS configuration. Supported only for HTTP APIs.

    *)
  6. createdDate : string option;
    (*

    The timestamp when the API was created.

    *)
  7. description : StringWithLengthBetween0And1024.t option;
    (*

    The description of the API.

    *)
  8. disableSchemaValidation : bool option;
    (*

    Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    *)
  9. disableExecuteApiEndpoint : bool option;
    (*

    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.

    *)
  10. importInfo : string list option;
    (*

    The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

    *)
  11. ipAddressType : IpAddressType.t option;
    (*

    The IP address types that can invoke the API.

    *)
  12. name : StringWithLengthBetween1And128.t option;
    (*

    The name of the API.

    *)
  13. protocolType : ProtocolType.t option;
    (*

    The API protocol.

    *)
  14. routeSelectionExpression : SelectionExpression.t option;
    (*

    The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    *)
  15. tags : Tags.t option;
    (*

    A collection of tags associated with the API.

    *)
  16. version : StringWithLengthBetween1And64.t option;
    (*

    A version identifier for the API.

    *)
  17. warnings : string list option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `ConflictException of ConflictException.t
  3. | `NotFoundException of NotFoundException.t
  4. | `TooManyRequestsException of TooManyRequestsException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?apiEndpoint:??? -> ?apiGatewayManaged:??? -> ?apiId:??? -> ?apiKeySelectionExpression:??? -> ?corsConfiguration:??? -> ?createdDate:??? -> ?description:??? -> ?disableSchemaValidation:??? -> ?disableExecuteApiEndpoint:??? -> ?importInfo:??? -> ?ipAddressType:??? -> ?name:??? -> ?protocolType:??? -> ?routeSelectionExpression:??? -> ?tags:??? -> ?version:??? -> ?warnings:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of bool | `Enum of string | `List of [> `String of string ] list | `Map of ([> `String of string ] * [> `String of StringWithLengthBetween1And1600.t ]) list | `String of string | `Structure of (string * [> `Boolean of bool | `Integer of IntegerWithLengthBetweenMinus1And86400.t | `List of [> `String of string ] list ]) list | `Timestamp of string ]) 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