Module Values.MethodResponseSource

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Sourcetype nonrec t = {
  1. statusCode : StatusCode.t option;
    (*

    The method response's status code.

    *)
  2. responseParameters : MapOfStringToBoolean.t option;
    (*

    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    *)
  3. responseModels : MapOfStringToString.t option;
    (*

    Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

    *)
}
Sourcetype nonrec error = [
  1. | `NotFoundException of NotFoundException.t
  2. | `TooManyRequestsException of TooManyRequestsException.t
  3. | `UnauthorizedException of UnauthorizedException.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval make : ?statusCode:??? -> ?responseParameters:??? -> ?responseModels:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Map of ([> `String of String_.t ] * [> `Boolean of NullableBoolean.t | `String of String_.t ]) list | `String of StatusCode.t ]) 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