package awsm

  1. Overview
  2. Docs

A configuration defines parameters needed for making calls to AWS. Some parameters, such as access keys and region, are needed by virtually all calls, while others apply only to specific services. We strive to match the specifications of the aws CLI. It defines multiple sources from which values of these parameters can be obtained---config and credentials files, environment variables, and command line flags---and selects values from these sources in a certain precedence order. The main make constructor considers all such sources and applies the same precedence rules. Submodules Config_file and Credentials_file provide parsers for the config and credentials files, respectively.

This module should not be confused with the AWS Config service.

module S3_custom_command_settings : sig ... end
type t = {
  1. aws_access_key_id : string option;
  2. aws_secret_access_key : string option;
  3. aws_session_token : string option;
  4. region : Region.t option;
  5. output : string option;
  6. ca_bundle : string option;
  7. cli_auto_prompt : string option;
  8. cli_binary_format : string option;
  9. cli_history : string option;
  10. cli_pager : string option;
  11. cli_timestamp_format : string option;
  12. credential_process : string option;
  13. credential_source : string option;
  14. duration_seconds : string option;
  15. external_id : string option;
  16. max_attempts : string option;
  17. mfa_serial : string option;
  18. parameter_validation : string option;
  19. retry_mode : string option;
  20. role_arn : string option;
  21. role_session_name : string option;
  22. source_profile : string option;
  23. sso_account_id : string option;
  24. sso_region : string option;
  25. sso_role_name : string option;
  26. sso_start_url : string option;
  27. web_identity_token_file : string option;
  28. tcp_keepalive : string option;
  29. s3_custom_command_settings : S3_custom_command_settings.t option;
}
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
val empty : t
module Config_file : sig ... end
module Shared_credentials_file : sig ... end
val make : ?config_file:(string * Config_file.t) -> ?shared_credentials_file:(string * Shared_credentials_file.t) -> ?profile:string -> ?aws_access_key_id:string -> ?aws_secret_access_key:string -> ?region:Region.t -> ?output:string -> unit -> (t, string) Core.Result.t
OCaml

Innovation. Community. Security.