Module Values.ApiKeySource

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

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

    The identifier of the API Key.

    *)
  2. value : String_.t option;
    (*

    The value of the API Key.

    *)
  3. name : String_.t option;
    (*

    The name of the API Key.

    *)
  4. customerId : String_.t option;
    (*

    An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

    *)
  5. description : String_.t option;
    (*

    The description of the API Key.

    *)
  6. enabled : Boolean.t option;
    (*

    Specifies whether the API Key can be used by callers.

    *)
  7. createdDate : Timestamp.t option;
    (*

    The timestamp when the API Key was created.

    *)
  8. lastUpdatedDate : Timestamp.t option;
    (*

    The timestamp when the API Key was last updated.

    *)
  9. stageKeys : ListOfString.t option;
    (*

    A list of Stage resources that are associated with the ApiKey resource.

    *)
  10. tags : MapOfStringToString.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `ConflictException of ConflictException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `NotFoundException of NotFoundException.t
  5. | `TooManyRequestsException of TooManyRequestsException.t
  6. | `UnauthorizedException of UnauthorizedException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?value:??? -> ?name:??? -> ?customerId:??? -> ?description:??? -> ?enabled:??? -> ?createdDate:??? -> ?lastUpdatedDate:??? -> ?stageKeys:??? -> ?tags:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `LimitExceededException of LimitExceededException.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 -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `LimitExceededException of LimitExceededException.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 * [> `Boolean of Boolean.t | `List of [> `String of String_.t ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.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