package smaws-clients

  1. Overview
  2. Docs
package smaws-clients
Legend:
Library
Module
Module type
Parameter
Class
Class type
type rs =
  1. | SINGLE_REGION
  2. | MULTI_REGION
type validation_exception = {
  1. message : string option;
}
type update_table_response = {
  1. resource_arn : string;
}
type column_definition = {
  1. type_ : string;
  2. name : string;
}
type throughput_mode =
  1. | PAY_PER_REQUEST
  2. | PROVISIONED
type capacity_specification = {
  1. write_capacity_units : int option;
  2. read_capacity_units : int option;
  3. throughput_mode : throughput_mode;
}
type encryption_type =
  1. | CUSTOMER_MANAGED_KMS_KEY
  2. | AWS_OWNED_KMS_KEY
type encryption_specification = {
  1. kms_key_identifier : string option;
  2. type_ : encryption_type;
}
type point_in_time_recovery_status =
  1. | ENABLED
  2. | DISABLED
type point_in_time_recovery = {
  1. status : point_in_time_recovery_status;
}
type time_to_live_status =
  1. | ENABLED
type time_to_live = {
  1. status : time_to_live_status;
}
type client_side_timestamps_status =
  1. | ENABLED
type client_side_timestamps = {
  1. status : client_side_timestamps_status;
}
type target_tracking_scaling_policy_configuration = {
  1. target_value : float;
  2. scale_out_cooldown : int option;
  3. scale_in_cooldown : int option;
  4. disable_scale_in : bool option;
}
type auto_scaling_policy = {
  1. target_tracking_scaling_policy_configuration : target_tracking_scaling_policy_configuration option;
}
type auto_scaling_settings = {
  1. scaling_policy : auto_scaling_policy option;
  2. maximum_units : int option;
  3. minimum_units : int option;
  4. auto_scaling_disabled : bool option;
}
type auto_scaling_specification = {
  1. read_capacity_auto_scaling : auto_scaling_settings option;
  2. write_capacity_auto_scaling : auto_scaling_settings option;
}
type replica_specification = {
  1. read_capacity_auto_scaling : auto_scaling_settings option;
  2. read_capacity_units : int option;
  3. region : string;
}
type update_table_request = {
  1. replica_specifications : replica_specification list option;
  2. auto_scaling_specification : auto_scaling_specification option;
  3. client_side_timestamps : client_side_timestamps option;
  4. default_time_to_live : int option;
  5. ttl : time_to_live option;
  6. point_in_time_recovery : point_in_time_recovery option;
  7. encryption_specification : encryption_specification option;
  8. capacity_specification : capacity_specification option;
  9. add_columns : column_definition list option;
  10. table_name : string;
  11. keyspace_name : string;
}
type service_quota_exceeded_exception = {
  1. message : string option;
}
type resource_not_found_exception = {
  1. resource_arn : string option;
  2. message : string option;
}
type internal_server_exception = {
  1. message : string option;
}
type conflict_exception = {
  1. message : string option;
}
type access_denied_exception = {
  1. message : string option;
}
type untag_resource_response = unit
type tag = {
  1. value : string;
  2. key : string;
}
type untag_resource_request = {
  1. tags : tag list;
  2. resource_arn : string;
}
type tag_resource_response = unit
type tag_resource_request = {
  1. tags : tag list;
  2. resource_arn : string;
}
type table_summary = {
  1. resource_arn : string;
  2. table_name : string;
  3. keyspace_name : string;
}
type table_status =
  1. | ACTIVE
  2. | CREATING
  3. | UPDATING
  4. | DELETING
  5. | DELETED
  6. | RESTORING
  7. | INACCESSIBLE_ENCRYPTION_CREDENTIALS
type static_column = {
  1. name : string;
}
type sort_order =
  1. | ASC
  2. | DESC
type partition_key = {
  1. name : string;
}
type clustering_key = {
  1. order_by : sort_order;
  2. name : string;
}
type schema_definition = {
  1. static_columns : static_column list option;
  2. clustering_keys : clustering_key list option;
  3. partition_keys : partition_key list;
  4. all_columns : column_definition list;
}
type restore_table_response = {
  1. restored_table_ar_n : string;
}
type restore_table_request = {
  1. replica_specifications : replica_specification list option;
  2. auto_scaling_specification : auto_scaling_specification option;
  3. tags_override : tag list option;
  4. point_in_time_recovery_override : point_in_time_recovery option;
  5. encryption_specification_override : encryption_specification option;
  6. capacity_specification_override : capacity_specification option;
  7. restore_timestamp : float option;
  8. target_table_name : string;
  9. target_keyspace_name : string;
  10. source_table_name : string;
  11. source_keyspace_name : string;
}
type replication_specification = {
  1. region_list : string list option;
  2. replication_strategy : rs;
}
type capacity_specification_summary = {
  1. last_update_to_pay_per_request_timestamp : float option;
  2. write_capacity_units : int option;
  3. read_capacity_units : int option;
  4. throughput_mode : throughput_mode;
}
type replica_specification_summary = {
  1. capacity_specification : capacity_specification_summary option;
  2. status : table_status option;
  3. region : string option;
}
type replica_auto_scaling_specification = {
  1. auto_scaling_specification : auto_scaling_specification option;
  2. region : string option;
}
type point_in_time_recovery_summary = {
  1. earliest_restorable_timestamp : float option;
  2. status : point_in_time_recovery_status;
}
type list_tags_for_resource_response = {
  1. tags : tag list option;
  2. next_token : string option;
}
type list_tags_for_resource_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. resource_arn : string;
}
type list_tables_response = {
  1. tables : table_summary list option;
  2. next_token : string option;
}
type list_tables_request = {
  1. keyspace_name : string;
  2. max_results : int option;
  3. next_token : string option;
}
type keyspace_summary = {
  1. replication_regions : string list option;
  2. replication_strategy : rs;
  3. resource_arn : string;
  4. keyspace_name : string;
}
type list_keyspaces_response = {
  1. keyspaces : keyspace_summary list;
  2. next_token : string option;
}
type list_keyspaces_request = {
  1. max_results : int option;
  2. next_token : string option;
}
type get_table_auto_scaling_settings_response = {
  1. replica_specifications : replica_auto_scaling_specification list option;
  2. auto_scaling_specification : auto_scaling_specification option;
  3. resource_arn : string;
  4. table_name : string;
  5. keyspace_name : string;
}
type get_table_auto_scaling_settings_request = {
  1. table_name : string;
  2. keyspace_name : string;
}
type comment = {
  1. message : string;
}
type get_table_response = {
  1. replica_specifications : replica_specification_summary list option;
  2. client_side_timestamps : client_side_timestamps option;
  3. comment : comment option;
  4. default_time_to_live : int option;
  5. ttl : time_to_live option;
  6. point_in_time_recovery : point_in_time_recovery_summary option;
  7. encryption_specification : encryption_specification option;
  8. capacity_specification : capacity_specification_summary option;
  9. schema_definition : schema_definition option;
  10. status : table_status option;
  11. creation_timestamp : float option;
  12. resource_arn : string;
  13. table_name : string;
  14. keyspace_name : string;
}
type get_table_request = {
  1. table_name : string;
  2. keyspace_name : string;
}
type get_keyspace_response = {
  1. replication_regions : string list option;
  2. replication_strategy : rs;
  3. resource_arn : string;
  4. keyspace_name : string;
}
type get_keyspace_request = {
  1. keyspace_name : string;
}
type delete_table_response = unit
type delete_table_request = {
  1. table_name : string;
  2. keyspace_name : string;
}
type delete_keyspace_response = unit
type delete_keyspace_request = {
  1. keyspace_name : string;
}
type create_table_response = {
  1. resource_arn : string;
}
type create_table_request = {
  1. replica_specifications : replica_specification list option;
  2. auto_scaling_specification : auto_scaling_specification option;
  3. client_side_timestamps : client_side_timestamps option;
  4. tags : tag list option;
  5. default_time_to_live : int option;
  6. ttl : time_to_live option;
  7. point_in_time_recovery : point_in_time_recovery option;
  8. encryption_specification : encryption_specification option;
  9. capacity_specification : capacity_specification option;
  10. comment : comment option;
  11. schema_definition : schema_definition;
  12. table_name : string;
  13. keyspace_name : string;
}
type create_keyspace_response = {
  1. resource_arn : string;
}
type create_keyspace_request = {
  1. replication_specification : replication_specification option;
  2. tags : tag list option;
  3. keyspace_name : string;
}
type base_document = Smaws_Lib.Json.t
val make_update_table_response : resource_arn:string -> unit -> update_table_response
val make_column_definition : type_:string -> name:string -> unit -> column_definition
val make_capacity_specification : ?write_capacity_units:int -> ?read_capacity_units:int -> throughput_mode:throughput_mode -> unit -> capacity_specification
val make_encryption_specification : ?kms_key_identifier:string -> type_:encryption_type -> unit -> encryption_specification
val make_point_in_time_recovery : status:point_in_time_recovery_status -> unit -> point_in_time_recovery
val make_time_to_live : status:time_to_live_status -> unit -> time_to_live
val make_client_side_timestamps : status:client_side_timestamps_status -> unit -> client_side_timestamps
val make_target_tracking_scaling_policy_configuration : ?scale_out_cooldown:int -> ?scale_in_cooldown:int -> ?disable_scale_in:bool -> target_value:float -> unit -> target_tracking_scaling_policy_configuration
val make_auto_scaling_policy : ?target_tracking_scaling_policy_configuration: target_tracking_scaling_policy_configuration -> unit -> auto_scaling_policy
val make_auto_scaling_settings : ?scaling_policy:auto_scaling_policy -> ?maximum_units:int -> ?minimum_units:int -> ?auto_scaling_disabled:bool -> unit -> auto_scaling_settings
val make_auto_scaling_specification : ?read_capacity_auto_scaling:auto_scaling_settings -> ?write_capacity_auto_scaling:auto_scaling_settings -> unit -> auto_scaling_specification
val make_replica_specification : ?read_capacity_auto_scaling:auto_scaling_settings -> ?read_capacity_units:int -> region:string -> unit -> replica_specification
val make_update_table_request : ?replica_specifications:replica_specification list -> ?auto_scaling_specification:auto_scaling_specification -> ?client_side_timestamps:client_side_timestamps -> ?default_time_to_live:int -> ?ttl:time_to_live -> ?point_in_time_recovery:point_in_time_recovery -> ?encryption_specification:encryption_specification -> ?capacity_specification:capacity_specification -> ?add_columns:column_definition list -> table_name:string -> keyspace_name:string -> unit -> update_table_request
val make_untag_resource_response : unit -> untag_resource_response
val make_tag : value:string -> key:string -> unit -> tag
val make_untag_resource_request : tags:tag list -> resource_arn:string -> unit -> untag_resource_request
val make_tag_resource_response : unit -> tag_resource_response
val make_tag_resource_request : tags:tag list -> resource_arn:string -> unit -> tag_resource_request
val make_table_summary : resource_arn:string -> table_name:string -> keyspace_name:string -> unit -> table_summary
val make_static_column : name:string -> unit -> static_column
val make_partition_key : name:string -> unit -> partition_key
val make_clustering_key : order_by:sort_order -> name:string -> unit -> clustering_key
val make_schema_definition : ?static_columns:static_column list -> ?clustering_keys:clustering_key list -> partition_keys:partition_key list -> all_columns:column_definition list -> unit -> schema_definition
val make_restore_table_response : restored_table_ar_n:string -> unit -> restore_table_response
val make_restore_table_request : ?replica_specifications:replica_specification list -> ?auto_scaling_specification:auto_scaling_specification -> ?tags_override:tag list -> ?point_in_time_recovery_override:point_in_time_recovery -> ?encryption_specification_override:encryption_specification -> ?capacity_specification_override:capacity_specification -> ?restore_timestamp:float -> target_table_name:string -> target_keyspace_name:string -> source_table_name:string -> source_keyspace_name:string -> unit -> restore_table_request
val make_replication_specification : ?region_list:string list -> replication_strategy:rs -> unit -> replication_specification
val make_capacity_specification_summary : ?last_update_to_pay_per_request_timestamp:float -> ?write_capacity_units:int -> ?read_capacity_units:int -> throughput_mode:throughput_mode -> unit -> capacity_specification_summary
val make_replica_specification_summary : ?capacity_specification:capacity_specification_summary -> ?status:table_status -> ?region:string -> unit -> replica_specification_summary
val make_replica_auto_scaling_specification : ?auto_scaling_specification:auto_scaling_specification -> ?region:string -> unit -> replica_auto_scaling_specification
val make_point_in_time_recovery_summary : ?earliest_restorable_timestamp:float -> status:point_in_time_recovery_status -> unit -> point_in_time_recovery_summary
val make_list_tags_for_resource_response : ?tags:tag list -> ?next_token:string -> unit -> list_tags_for_resource_response
val make_list_tags_for_resource_request : ?max_results:int -> ?next_token:string -> resource_arn:string -> unit -> list_tags_for_resource_request
val make_list_tables_response : ?tables:table_summary list -> ?next_token:string -> unit -> list_tables_response
val make_list_tables_request : ?max_results:int -> ?next_token:string -> keyspace_name:string -> unit -> list_tables_request
val make_keyspace_summary : ?replication_regions:string list -> replication_strategy:rs -> resource_arn:string -> keyspace_name:string -> unit -> keyspace_summary
val make_list_keyspaces_response : ?next_token:string -> keyspaces:keyspace_summary list -> unit -> list_keyspaces_response
val make_list_keyspaces_request : ?max_results:int -> ?next_token:string -> unit -> list_keyspaces_request
val make_get_table_auto_scaling_settings_response : ?replica_specifications:replica_auto_scaling_specification list -> ?auto_scaling_specification:auto_scaling_specification -> resource_arn:string -> table_name:string -> keyspace_name:string -> unit -> get_table_auto_scaling_settings_response
val make_get_table_auto_scaling_settings_request : table_name:string -> keyspace_name:string -> unit -> get_table_auto_scaling_settings_request
val make_comment : message:string -> unit -> comment
val make_get_table_response : ?replica_specifications:replica_specification_summary list -> ?client_side_timestamps:client_side_timestamps -> ?comment:comment -> ?default_time_to_live:int -> ?ttl:time_to_live -> ?point_in_time_recovery:point_in_time_recovery_summary -> ?encryption_specification:encryption_specification -> ?capacity_specification:capacity_specification_summary -> ?schema_definition:schema_definition -> ?status:table_status -> ?creation_timestamp:float -> resource_arn:string -> table_name:string -> keyspace_name:string -> unit -> get_table_response
val make_get_table_request : table_name:string -> keyspace_name:string -> unit -> get_table_request
val make_get_keyspace_response : ?replication_regions:string list -> replication_strategy:rs -> resource_arn:string -> keyspace_name:string -> unit -> get_keyspace_response
val make_get_keyspace_request : keyspace_name:string -> unit -> get_keyspace_request
val make_delete_table_response : unit -> delete_table_response
val make_delete_table_request : table_name:string -> keyspace_name:string -> unit -> delete_table_request
val make_delete_keyspace_response : unit -> delete_keyspace_response
val make_delete_keyspace_request : keyspace_name:string -> unit -> delete_keyspace_request
val make_create_table_response : resource_arn:string -> unit -> create_table_response
val make_create_table_request : ?replica_specifications:replica_specification list -> ?auto_scaling_specification:auto_scaling_specification -> ?client_side_timestamps:client_side_timestamps -> ?tags:tag list -> ?default_time_to_live:int -> ?ttl:time_to_live -> ?point_in_time_recovery:point_in_time_recovery -> ?encryption_specification:encryption_specification -> ?capacity_specification:capacity_specification -> ?comment:comment -> schema_definition:schema_definition -> table_name:string -> keyspace_name:string -> unit -> create_table_request
val make_create_keyspace_response : resource_arn:string -> unit -> create_keyspace_response
val make_create_keyspace_request : ?replication_specification:replication_specification -> ?tags:tag list -> keyspace_name:string -> unit -> create_keyspace_request
module UpdateTable : sig ... end
module UntagResource : sig ... end
module TagResource : sig ... end
module RestoreTable : sig ... end
module ListTagsForResource : sig ... end
module ListTables : sig ... end
module ListKeyspaces : sig ... end
module GetTableAutoScalingSettings : sig ... end
module GetTable : sig ... end
module GetKeyspace : sig ... end
module DeleteTable : sig ... end
module DeleteKeyspace : sig ... end
module CreateTable : sig ... end
module CreateKeyspace : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct