package awsm-codegen

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Constructors
Accessors
Helpers
Code generation

package awsm-codegen

awsm-codegen
- Awsm_codegen
  - Ast_convenience
    
    Label
  - Botocore_endpoints
  - Botocore_service
    
    Error
    
    Location
    
    Metadata
    
    ChecksumFormat
    
    Protocol
    
    Operation
    
    Endpoint
    
    Endpointdiscovergy
    
    Error
    
    Http
    
    HttpChecksum
    
    Input
    
    Output
    
    Operations
    
    Shape
    
    Blob
    
    Bool
    
    Double
    
    Enum
    
    Float
    
    Integer
    
    List
    
    Long
    
    Map
    
    Member
    
    Retryable
    
    String
    
    Structure
    
    Timestamp
    
    Shapes
    
    TimestampFormat
    
    Uri
    
    XmlNamespace
  - Botodata
    
    Int64
  - Cli
  - Cmd
  - Dune
  - Ec2_errors
    
    Client_errors_for_specific_actions
    
    Common_client_errors
    
    Server_errors
  - Endpoint
  - Enum_other
  - Import
    
    Process
    
    Output
    
    Util
  - Io
  - Json
    
    Util
  - Json_parser
    
    Let_syntax
  - Payload
  - Query_param
  - Region
  - Result_decoder
  - Service
  - Service_endpoints
  - Service_endpoints_common
  - Service_endpoints_ec2
  - Service_endpoints_json
  - Service_endpoints_query
  - Service_endpoints_rest_json
  - Service_endpoints_rest_xml
  - Service_structure
  - Shape
    
    Graph
    
    Components
    
    Dfs
    
    Topological
  - Shape_signature
  - Shape_structure
  - Type_decl
  - Values

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

An abstract representation of a URL query parameter.

val sexp_of_t : t -> Sexplib0.Sexp.t

Constructors

val create : 
  name:string ->
  field_name:string ->
  shape:string ->
  is_required:bool ->
  t

Build from fields.

parameter name
The (http) name of the parameter.

parameter shape
The boto shape name in the operation.

parameter is_required
Is this required or optional?

val of_botodata : 
  Botodata.operation ->
  shapes:(string, Botodata.shape) Core.List.Assoc.t ->
  t list

Build from a parsed Botodata.operation.

Accessors

val is_required : t -> bool

Helpers

val param_name : t -> string

The HTTP parameter name (the locationName).

val field_name : t -> string

The field name in the name in the ocaml record type.

Code generation

val convert : t -> Ppxlib.Parsetree.expression

Emit a converter.

If the corresponding shape is Mod, emit Mod.to_header.