Module Values.JobParametersSource

Provides options for defining a job.

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

    When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

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

    The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

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

    The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

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

    The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

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

    The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    *)
  6. retrievalByteRange : String_.t option;
    (*

    The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. An error occurs if you specify this field for an inventory retrieval job request.

    *)
  7. tier : String_.t option;
    (*

    The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

    *)
  8. inventoryRetrievalParameters : InventoryRetrievalJobInput.t option;
    (*

    Input parameters used for range inventory retrieval.

    *)
  9. selectParameters : SelectParameters.t option;
    (*

    Contains the parameters that define a job.

    *)
  10. outputLocation : OutputLocation.t option;
    (*

    Contains information about the location where the select job results are stored.

    *)
}
Sourceval make : ?format:??? -> ?type_:??? -> ?archiveId:??? -> ?description:??? -> ?sNSTopic:??? -> ?retrievalByteRange:??? -> ?tier:??? -> ?inventoryRetrievalParameters:??? -> ?selectParameters:??? -> ?outputLocation:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ]) list ]) 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