Smaws_Client_Keyspaces (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_update_table_response : 
  resource_arn:Types.ar_n ->
  unit ->
  Types.update_table_response

val make_column_definition : 
  type_:Types.generic_string ->
  name:Types.generic_string ->
  unit ->
  Types.column_definition

val make_capacity_specification : 
  ?write_capacity_units:Types.capacity_units ->
  ?read_capacity_units:Types.capacity_units ->
  throughput_mode:Types.throughput_mode ->
  unit ->
  Types.capacity_specification

val make_encryption_specification : 
  ?kms_key_identifier:Types.kms_key_ar_n ->
  type_:Types.encryption_type ->
  unit ->
  Types.encryption_specification

val make_point_in_time_recovery : 
  status:Types.point_in_time_recovery_status ->
  unit ->
  Types.point_in_time_recovery

val make_time_to_live : 
  status:Types.time_to_live_status ->
  unit ->
  Types.time_to_live

val make_client_side_timestamps : 
  status:Types.client_side_timestamps_status ->
  unit ->
  Types.client_side_timestamps

val make_target_tracking_scaling_policy_configuration : 
  ?scale_out_cooldown:Types.integer_object ->
  ?scale_in_cooldown:Types.integer_object ->
  ?disable_scale_in:Types.boolean_object ->
  target_value:Types.double_object ->
  unit ->
  Types.target_tracking_scaling_policy_configuration

val make_auto_scaling_policy : 
  ?target_tracking_scaling_policy_configuration:
    Types.target_tracking_scaling_policy_configuration ->
  unit ->
  Types.auto_scaling_policy

val make_auto_scaling_settings : 
  ?scaling_policy:Types.auto_scaling_policy ->
  ?maximum_units:Types.capacity_units ->
  ?minimum_units:Types.capacity_units ->
  ?auto_scaling_disabled:Types.boolean_object ->
  unit ->
  Types.auto_scaling_settings

val make_auto_scaling_specification : 
  ?read_capacity_auto_scaling:Types.auto_scaling_settings ->
  ?write_capacity_auto_scaling:Types.auto_scaling_settings ->
  unit ->
  Types.auto_scaling_specification

val make_replica_specification : 
  ?read_capacity_auto_scaling:Types.auto_scaling_settings ->
  ?read_capacity_units:Types.capacity_units ->
  region:Types.region ->
  unit ->
  Types.replica_specification

val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag

val make_cdc_specification : 
  ?propagate_tags:Types.cdc_propagate_tags ->
  ?tags:Types.tag_list ->
  ?view_type:Types.view_type ->
  status:Types.cdc_status ->
  unit ->
  Types.cdc_specification

val make_update_table_request : 
  ?cdc_specification:Types.cdc_specification ->
  ?replica_specifications:Types.replica_specification_list ->
  ?auto_scaling_specification:Types.auto_scaling_specification ->
  ?client_side_timestamps:Types.client_side_timestamps ->
  ?default_time_to_live:Types.default_time_to_live ->
  ?ttl:Types.time_to_live ->
  ?point_in_time_recovery:Types.point_in_time_recovery ->
  ?encryption_specification:Types.encryption_specification ->
  ?capacity_specification:Types.capacity_specification ->
  ?add_columns:Types.column_definition_list ->
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.update_table_request

val make_update_keyspace_response : 
  resource_arn:Types.ar_n ->
  unit ->
  Types.update_keyspace_response

val make_replication_specification : 
  ?region_list:Types.region_list ->
  replication_strategy:Types.rs ->
  unit ->
  Types.replication_specification

val make_update_keyspace_request : 
  ?client_side_timestamps:Types.client_side_timestamps ->
  replication_specification:Types.replication_specification ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.update_keyspace_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tags:Types.tag_list ->
  resource_arn:Types.ar_n ->
  unit ->
  Types.untag_resource_request

val make_tag_resource_response : unit -> unit

val make_tag_resource_request : 
  tags:Types.tag_list ->
  resource_arn:Types.ar_n ->
  unit ->
  Types.tag_resource_request

val make_table_summary : 
  resource_arn:Types.ar_n ->
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.table_summary

val make_static_column : 
  name:Types.generic_string ->
  unit ->
  Types.static_column

val make_partition_key : 
  name:Types.generic_string ->
  unit ->
  Types.partition_key

val make_clustering_key : 
  order_by:Types.sort_order ->
  name:Types.generic_string ->
  unit ->
  Types.clustering_key

val make_schema_definition : 
  ?static_columns:Types.static_column_list ->
  ?clustering_keys:Types.clustering_key_list ->
  partition_keys:Types.partition_key_list ->
  all_columns:Types.column_definition_list ->
  unit ->
  Types.schema_definition

val make_restore_table_response : 
  restored_table_ar_n:Types.ar_n ->
  unit ->
  Types.restore_table_response

val make_restore_table_request : 
  ?replica_specifications:Types.replica_specification_list ->
  ?auto_scaling_specification:Types.auto_scaling_specification ->
  ?tags_override:Types.tag_list ->
  ?point_in_time_recovery_override:Types.point_in_time_recovery ->
  ?encryption_specification_override:Types.encryption_specification ->
  ?capacity_specification_override:Types.capacity_specification ->
  ?restore_timestamp:Types.timestamp ->
  target_table_name:Types.table_name ->
  target_keyspace_name:Types.keyspace_name ->
  source_table_name:Types.table_name ->
  source_keyspace_name:Types.keyspace_name ->
  unit ->
  Types.restore_table_request

val make_replication_group_status : 
  ?tables_replication_progress:Types.tables_replication_progress ->
  keyspace_status:Types.keyspace_status ->
  region:Types.region ->
  unit ->
  Types.replication_group_status

val make_capacity_specification_summary : 
  ?last_update_to_pay_per_request_timestamp:Types.timestamp ->
  ?write_capacity_units:Types.capacity_units ->
  ?read_capacity_units:Types.capacity_units ->
  throughput_mode:Types.throughput_mode ->
  unit ->
  Types.capacity_specification_summary

val make_replica_specification_summary : 
  ?capacity_specification:Types.capacity_specification_summary ->
  ?status:Types.table_status ->
  ?region:Types.region ->
  unit ->
  Types.replica_specification_summary

val make_replica_auto_scaling_specification : 
  ?auto_scaling_specification:Types.auto_scaling_specification ->
  ?region:Types.region ->
  unit ->
  Types.replica_auto_scaling_specification

val make_point_in_time_recovery_summary : 
  ?earliest_restorable_timestamp:Types.timestamp ->
  status:Types.point_in_time_recovery_status ->
  unit ->
  Types.point_in_time_recovery_summary

val make_list_types_response : 
  ?next_token:Types.next_token ->
  types:Types.type_name_list ->
  unit ->
  Types.list_types_response

val make_list_types_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.list_types_request

val make_list_tags_for_resource_response : 
  ?tags:Types.tag_list ->
  ?next_token:Types.next_token ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  resource_arn:Types.ar_n ->
  unit ->
  Types.list_tags_for_resource_request

val make_list_tables_response : 
  ?tables:Types.table_summary_list ->
  ?next_token:Types.next_token ->
  unit ->
  Types.list_tables_response

val make_list_tables_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.list_tables_request

val make_keyspace_summary : 
  ?replication_regions:Types.region_list ->
  replication_strategy:Types.rs ->
  resource_arn:Types.ar_n ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.keyspace_summary

val make_list_keyspaces_response : 
  ?next_token:Types.next_token ->
  keyspaces:Types.keyspace_summary_list ->
  unit ->
  Types.list_keyspaces_response

val make_list_keyspaces_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  unit ->
  Types.list_keyspaces_request

val make_field_definition : 
  type_:Types.generic_string ->
  name:Types.generic_string ->
  unit ->
  Types.field_definition

val make_get_type_response : 
  ?max_nesting_depth:Types.depth ->
  ?direct_parent_types:Types.type_name_list ->
  ?direct_referring_tables:Types.table_name_list ->
  ?status:Types.type_status ->
  ?last_modified_timestamp:Types.timestamp ->
  ?field_definitions:Types.field_list ->
  keyspace_arn:Types.ar_n ->
  type_name:Types.type_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_type_response

val make_get_type_request : 
  type_name:Types.type_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_type_request

val make_get_table_auto_scaling_settings_response : 
  ?replica_specifications:Types.replica_auto_scaling_specification_list ->
  ?auto_scaling_specification:Types.auto_scaling_specification ->
  resource_arn:Types.ar_n ->
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_table_auto_scaling_settings_response

val make_get_table_auto_scaling_settings_request : 
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_table_auto_scaling_settings_request

val make_comment : 
  message:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.comment

val make_cdc_specification_summary : 
  ?view_type:Types.view_type ->
  status:Types.cdc_status ->
  unit ->
  Types.cdc_specification_summary

val make_get_table_response : 
  ?cdc_specification:Types.cdc_specification_summary ->
  ?latest_stream_arn:Types.stream_arn ->
  ?replica_specifications:Types.replica_specification_summary_list ->
  ?client_side_timestamps:Types.client_side_timestamps ->
  ?comment:Types.comment ->
  ?default_time_to_live:Types.default_time_to_live ->
  ?ttl:Types.time_to_live ->
  ?point_in_time_recovery:Types.point_in_time_recovery_summary ->
  ?encryption_specification:Types.encryption_specification ->
  ?capacity_specification:Types.capacity_specification_summary ->
  ?schema_definition:Types.schema_definition ->
  ?status:Types.table_status ->
  ?creation_timestamp:Types.timestamp ->
  resource_arn:Types.ar_n ->
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_table_response

val make_get_table_request : 
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_table_request

val make_get_keyspace_response : 
  ?replication_group_statuses:Types.replication_group_status_list ->
  ?replication_regions:Types.region_list ->
  replication_strategy:Types.rs ->
  resource_arn:Types.ar_n ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_keyspace_response

val make_get_keyspace_request : 
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.get_keyspace_request

val make_delete_type_response : 
  type_name:Types.type_name ->
  keyspace_arn:Types.ar_n ->
  unit ->
  Types.delete_type_response

val make_delete_type_request : 
  type_name:Types.type_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.delete_type_request

val make_delete_table_response : unit -> unit

val make_delete_table_request : 
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.delete_table_request

val make_delete_keyspace_response : unit -> unit

val make_delete_keyspace_request : 
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.delete_keyspace_request

val make_create_type_response : 
  type_name:Types.type_name ->
  keyspace_arn:Types.ar_n ->
  unit ->
  Types.create_type_response

val make_create_type_request : 
  field_definitions:Types.field_list ->
  type_name:Types.type_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.create_type_request

val make_create_table_response : 
  resource_arn:Types.ar_n ->
  unit ->
  Types.create_table_response

val make_create_table_request : 
  ?cdc_specification:Types.cdc_specification ->
  ?replica_specifications:Types.replica_specification_list ->
  ?auto_scaling_specification:Types.auto_scaling_specification ->
  ?client_side_timestamps:Types.client_side_timestamps ->
  ?tags:Types.tag_list ->
  ?default_time_to_live:Types.default_time_to_live ->
  ?ttl:Types.time_to_live ->
  ?point_in_time_recovery:Types.point_in_time_recovery ->
  ?encryption_specification:Types.encryption_specification ->
  ?capacity_specification:Types.capacity_specification ->
  ?comment:Types.comment ->
  schema_definition:Types.schema_definition ->
  table_name:Types.table_name ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.create_table_request

val make_create_keyspace_response : 
  resource_arn:Types.ar_n ->
  unit ->
  Types.create_keyspace_response

val make_create_keyspace_request : 
  ?replication_specification:Types.replication_specification ->
  ?tags:Types.tag_list ->
  keyspace_name:Types.keyspace_name ->
  unit ->
  Types.create_keyspace_request

Operations

module CreateKeyspace : sig ... end

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

module CreateTable : sig ... end

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

module CreateType : sig ... end

The CreateType operation creates a new user-defined type in the specified keyspace.

module DeleteKeyspace : sig ... end

The DeleteKeyspace operation deletes a keyspace and all of its tables.

module DeleteTable : sig ... end

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

module DeleteType : sig ... end

The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.

module GetKeyspace : sig ... end

Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.

module GetTable : sig ... end

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

module GetTableAutoScalingSettings : sig ... end

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.

module GetType : sig ... end

The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.

module ListKeyspaces : sig ... end

The ListKeyspaces operation returns a list of keyspaces.

module ListTables : sig ... end

The ListTables operation returns a list of tables for a specified keyspace.

module ListTagsForResource : sig ... end

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

module ListTypes : sig ... end

The ListTypes operation returns a list of types for a specified keyspace.

module RestoreTable : sig ... end

Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

module TagResource : sig ... end

Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

module UntagResource : sig ... end

Removes the association of tags from a Amazon Keyspaces resource.

module UpdateKeyspace : sig ... end

Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

module UpdateTable : sig ... end

Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

module Json_serializers : sig ... end

module Json_deserializers : sig ... end