Module Values.DescribeApiDestinationResponseSource

Retrieves details about an API destination.

Sourcetype nonrec t = {
  1. apiDestinationArn : ApiDestinationArn.t option;
    (*

    The ARN of the API destination retrieved.

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

    The name of the API destination retrieved.

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

    The description for the API destination retrieved.

    *)
  4. apiDestinationState : ApiDestinationState.t option;
    (*

    The state of the API destination retrieved.

    *)
  5. connectionArn : ConnectionArn.t option;
    (*

    The ARN of the connection specified for the API destination retrieved.

    *)
  6. invocationEndpoint : HttpsEndpoint.t option;
    (*

    The URL to use to connect to the HTTP endpoint.

    *)
  7. httpMethod : ApiDestinationHttpMethod.t option;
    (*

    The method to use to connect to the HTTP endpoint.

    *)
  8. invocationRateLimitPerSecond : ApiDestinationInvocationRateLimitPerSecond.t option;
    (*

    The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

    *)
  9. creationTime : Timestamp.t option;
    (*

    A time stamp for the time that the API destination was created.

    *)
  10. lastModifiedTime : Timestamp.t option;
    (*

    A time stamp for the time that the API destination was last modified.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalException of InternalException.t
  2. | `ResourceNotFoundException of ResourceNotFoundException.t
  3. | `Unknown_operation_error of string * string option
]
Sourceval make : ?apiDestinationArn:??? -> ?name:??? -> ?description:??? -> ?apiDestinationState:??? -> ?connectionArn:??? -> ?invocationEndpoint:??? -> ?httpMethod:??? -> ?invocationRateLimitPerSecond:??? -> ?creationTime:??? -> ?lastModifiedTime:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of ApiDestinationInvocationRateLimitPerSecond.t | `String of ApiDestinationArn.t | `Timestamp of Timestamp.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