Smaws_Client_KeyspacesStreams.Typestype nonrec validation_exception = {error_code : validation_exception_type option;An error occurred validating your request. See the error message for details.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;The input fails to satisfy the constraints specified by the service. Check the error details and modify your request.
*)}The request validation failed because one or more input parameters failed validation.
This exception occurs when there are syntax errors in the request, field constraints are violated, or required parameters are missing. To help you fix the issue, the exception message provides details about which parameter failed and why.
type nonrec throttling_exception = {message : Smaws_Lib.Smithy_api.Types.string_ option;The request was denied due to request throttling. Reduce the frequency of requests and try again.
*)}The request rate is too high and exceeds the service's throughput limits.
This exception occurs when you send too many requests in a short period of time. Implement exponential backoff in your retry strategy to handle this exception. Reducing your request frequency or distributing requests more evenly can help avoid throughput exceptions.
This exception can also occur when more than two processes are reading from the same stream shard at the same time. Ensure that only one process reads from a stream shard at the same time.
type nonrec stream = {stream_label : Smaws_Lib.Smithy_api.Types.string_;A unique identifier for this stream that can be used in stream operations.
*)table_name : table_name;The name of the table associated with this stream.
*)keyspace_name : keyspace_name;The name of the keyspace containing the table associated with this stream.
*)stream_arn : stream_arn;The Amazon Resource Name (ARN) that uniquely identifies this stream.
*)}Represents a change data capture stream for an Amazon Keyspaces table, which enables tracking and processing of data changes.
type nonrec stream_list = stream listtype nonrec shard_id_list = shard_id listtype nonrec shard_filter = {shard_id : shard_id option;The identifier of a specific shard used to filter results based on the specified filter type.
*)type_ : shard_filter_type option;The type of shard filter to use, which determines how the shardId parameter is interpreted.
*)}A filter used to limit the shards returned by a GetStream operation.
type nonrec sequence_number_range = {ending_sequence_number : sequence_number option;The ending sequence number of the range, which may be null for open-ended ranges.
*)starting_sequence_number : sequence_number option;The starting sequence number of the range.
*)}Defines a range of sequence numbers within a change data capture stream's shard for Amazon Keyspaces.
type nonrec shard = {parent_shard_ids : shard_id_list option;The identifiers of parent shards that this shard evolved from, if this shard was created through resharding.
*)sequence_number_range : sequence_number_range option;The range of sequence numbers contained within this shard.
*)shard_id : shard_id option;A unique identifier for this shard within the stream.
*)}Represents a uniquely identified group of change records within a change data capture stream for Amazon Keyspaces.
type nonrec shard_description_list = shard listtype nonrec resource_not_found_exception = {message : Smaws_Lib.Smithy_api.Types.string_ option;The requested resource wasn't found. Verify that the resource exists and try again.
*)}The requested resource doesn't exist or could not be found.
This exception occurs when you attempt to access a keyspace, table, stream, or other Amazon Keyspaces resource that doesn't exist or that has been deleted. Verify that the resource identifier is correct and that the resource exists in your account.
type nonrec keyspaces_metadata = {write_time : Smaws_Lib.Smithy_api.Types.string_ option;The timestamp at which the associated data was written to the database.
*)expiration_time : Smaws_Lib.Smithy_api.Types.string_ option;The time at which the associated data will expire, based on the time-to-live (TTL) setting.
*)}Contains metadata information associated with Amazon Keyspaces cells and rows.
type keyspaces_cell = {metadata : keyspaces_metadata option;Metadata associated with this cell, such as time-to-live (TTL) expiration time and write timestamp.
*)value : keyspaces_cell_value option;The value stored in this cell, which can be of various data types supported by Amazon Keyspaces.
*)}Represents a cell in an Amazon Keyspaces table, containing both the value and metadata about the cell.
and keyspaces_cell_list = keyspaces_cell listand keyspaces_cell_map = keyspaces_cell_map_definition listand keyspaces_cell_map_definition = {metadata : keyspaces_metadata option;Metadata for this specific key-value pair within the map, such as timestamps and TTL information.
*)value : keyspaces_cell_value option;The value associated with the key in this map entry.
*)key : keyspaces_cell_value option;The key of this map entry in the Amazon Keyspaces cell.
*)}Represents a key-value pair within a map data type in Amazon Keyspaces, including the associated metadata.
and keyspaces_cell_value = | UdtT of keyspaces_udt_mapA user-defined type (UDT) value consisting of named fields, each with its own data type.
*)| VarintT of Smaws_Lib.Smithy_api.Types.string_An integer value within the +/-10^38 range.
*)| VarcharT of Smaws_Lib.Smithy_api.Types.string_A UTF-8 encoded string value, functionally equivalent to text type.
*)| UuidT of Smaws_Lib.Smithy_api.Types.string_A universally unique identifier (UUID) value.
*)| TupleT of keyspaces_cell_listA fixed-length ordered list of elements, where each element can be of a different data type.
*)| TinyintT of Smaws_Lib.Smithy_api.Types.string_An 8-bit signed integer value.
*)| TimeuuidT of Smaws_Lib.Smithy_api.Types.string_A universally unique identifier (UUID) that includes a timestamp component, ensuring both uniqueness and time ordering.
*)| TimestampT of Smaws_Lib.Smithy_api.Types.string_A timestamp value representing date and time with millisecond precision.
*)| TimeT of Smaws_Lib.Smithy_api.Types.string_A time value without a date component, with nanosecond precision.
*)| TextT of Smaws_Lib.Smithy_api.Types.string_A UTF-8 encoded string value.
*)| SmallintT of Smaws_Lib.Smithy_api.Types.string_A 16-bit signed integer value.
*)| SetT of keyspaces_cell_listAn unordered collection of unique elements.
*)| MapT of keyspaces_cell_mapA collection of key-value pairs where each key is unique.
*)| ListT of keyspaces_cell_listAn ordered collection of elements that can contain duplicate values.
*)| IntT of Smaws_Lib.Smithy_api.Types.string_A 32-bit signed integer value.
*)| InetT of Smaws_Lib.Smithy_api.Types.string_An IP address value, either IPv4 or IPv6 format.
*)| FloatT of Smaws_Lib.Smithy_api.Types.string_A 32-bit single-precision floating point value.
*)| DurationT of Smaws_Lib.Smithy_api.Types.string_A duration value with nanosecond precision, representing a period of time encoded as 32-bit months, 32-bit days, and 64-bit nanoseconds.
*)| DoubleT of Smaws_Lib.Smithy_api.Types.string_A 64-bit double-precision floating point value.
*)| DecimalT of Smaws_Lib.Smithy_api.Types.string_A variable-precision decimal number value.
*)| DateT of Smaws_Lib.Smithy_api.Types.string_A date value without a time component, represented as days since epoch (January 1, 1970).
*)| CounterT of Smaws_Lib.Smithy_api.Types.string_A distributed counter value that can be incremented and decremented.
*)| BoolT of Smaws_Lib.Smithy_api.Types.boolean_A Boolean value, either true or false.
| BlobT of Smaws_Lib.Smithy_api.Types.blobA binary large object (BLOB) value stored as a Base64-encoded string.
*)| BigintT of Smaws_Lib.Smithy_api.Types.string_A 64-bit signed integer value.
*)| AsciiT of Smaws_Lib.Smithy_api.Types.string_A value of ASCII text type, containing US-ASCII characters.
*)Represents the value of a cell in an Amazon Keyspaces table, supporting various data types with type-specific fields.
and keyspaces_udt_map =
(Smaws_Lib.Smithy_api.Types.string_ * keyspaces_cell) listtype nonrec keyspaces_keys_map =
(Smaws_Lib.Smithy_api.Types.string_ * keyspaces_cell_value) listtype nonrec keyspaces_cells =
(Smaws_Lib.Smithy_api.Types.string_ * keyspaces_cell) listtype nonrec keyspaces_row = {row_metadata : keyspaces_metadata option;Metadata that applies to the entire row, such as timestamps and TTL information.
*)static_cells : keyspaces_cells option;A map of static column cells shared by all rows with the same partition key, where keys are column names and values are the corresponding cells.
*)value_cells : keyspaces_cells option;A map of regular (non-static) column cells in the row, where keys are column names and values are the corresponding cells.
*)}Represents a row in an Amazon Keyspaces table, containing regular column values, static column values, and row-level metadata.
type nonrec record = {sequence_number : sequence_number option;A unique identifier assigned to this record within the shard, used for ordering and tracking purposes.
*)old_image : keyspaces_row option;The state of the row before the change operation that generated this record.
*)new_image : keyspaces_row option;The state of the row after the change operation that generated this record.
*)clustering_keys : keyspaces_keys_map option;The clustering key columns and their values for the affected row, which determine the order of rows within a partition.
*)partition_keys : keyspaces_keys_map option;The partition key columns and their values for the affected row.
*)origin : origin_type option;The origin or source of this change data capture record.
*)created_at : date option;The timestamp indicating when this change data capture record was created.
*)event_version : Smaws_Lib.Smithy_api.Types.string_ option;The version of the record format, used to track the evolution of the record structure over time.
*)}Represents a change data capture record for a row in an Amazon Keyspaces table, containing both the new and old states of the row.
type nonrec record_list = record listtype nonrec list_streams_output = {next_token : stream_arn_token option;A pagination token that can be used in a subsequent ListStreams request. This token is returned if the response contains more streams than can be returned in a single response based on the maxResults parameter.
streams : stream_list option;An array of stream objects, each containing summary information about a stream including its ARN, status, and associated table information. This list includes all streams that match the request criteria.
*)}type nonrec list_streams_input = {next_token : stream_arn_token option;An optional pagination token provided by a previous ListStreams operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.
max_results : Smaws_Lib.Smithy_api.Types.integer option;The maximum number of streams to return in a single ListStreams request. The default value is 100. The minimum value is 1 and the maximum value is 100.
table_name : table_name option;The name of the table for which to list streams. Must be used together with keyspaceName. If specified, only streams associated with this specific table are returned.
keyspace_name : keyspace_name option;The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.
*)}type nonrec internal_server_exception = {message : Smaws_Lib.Smithy_api.Types.string_ option;The service encountered an internal error. Try your request again.
*)}The Amazon Keyspaces service encountered an unexpected error while processing the request.
This internal server error is not related to your request parameters. Retry your request after a brief delay. If the issue persists, contact Amazon Web Services Support with details of your request to help identify and resolve the problem.
type nonrec access_denied_exception = {message : Smaws_Lib.Smithy_api.Types.string_ option;You don't have sufficient permissions to perform this action.
*)}You don't have sufficient access permissions to perform this operation.
This exception occurs when your IAM user or role lacks the required permissions to access the Amazon Keyspaces resource or perform the requested action. Check your IAM policies and ensure they grant the necessary permissions.
type nonrec get_stream_output = {next_token : shard_id_token option;A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.
shards : shard_description_list option;An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.
*)table_name : table_name;The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.
*)keyspace_name : keyspace_name;The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.
*)creation_request_date_time : date;The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.
*)stream_view_type : stream_view_type;The format of the data records in this stream. Currently, this can be one of the following options:
NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.NEW_IMAGE - the version of the row after the change.OLD_IMAGE - the version of the row before the change.KEYS_ONLY - the partition and clustering keys of the row that was changed.stream_status : stream_status;The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.
stream_label : Smaws_Lib.Smithy_api.Types.string_;A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.
*)stream_arn : stream_arn;The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.
*)}type nonrec get_stream_input = {next_token : shard_id_token option;An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.
shard_filter : shard_filter option;Optional filter criteria to apply when retrieving shards. You can filter shards based on their parent shardID to get a list of children shards to narrow down the results returned by the GetStream operation.
max_results : Smaws_Lib.Smithy_api.Types.integer option;The maximum number of shard objects to return in a single GetStream request. The default value is 100. The minimum value is 1 and the maximum value is 100.
stream_arn : stream_arn;The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.
*)}type nonrec get_shard_iterator_output = {shard_iterator : shard_iterator option;The unique identifier for the shard iterator. This value is used in the GetRecords operation to retrieve data records from the specified shard. Each shard iterator expires 15 minutes after it is returned to the requester.
}type nonrec get_shard_iterator_input = {sequence_number : sequence_number option;The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.
shard_iterator_type : shard_iterator_type;Determines how the shard iterator is positioned. Must be one of the following:
TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data.shard_id : shard_id;The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.
*)stream_arn : stream_arn;The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.
*)}type nonrec iterator_description = {iterator_position : iterator_position option;Indicates the current iterator's position within the shard. The possible values are:
AT_TIP - No more records are currently available.BEHIND_TIP - Additional records may be available.Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.
}Provides information about the current iterator.
type nonrec get_records_output = {iterator_description : iterator_description option;Provides information about the current iterator at the time GetRecords request was processed by Keyspaces.
*)next_shard_iterator : shard_iterator option;The next position in the shard from which to start sequentially reading data records. If null, the shard has been closed and the requested iterator will not return any more data.
*)change_records : record_list option;An array of change data records retrieved from the specified shard. Each record represents a single data modification (insert, update, or delete) to a row in the Amazon Keyspaces table. Records include the primary key columns and information about what data was modified.
*)}type nonrec get_records_input = {max_results : Smaws_Lib.Smithy_api.Types.integer option;The maximum number of records to return in a single GetRecords request. The default value is 100. You can specify a limit between 1 and 1000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.
shard_iterator : shard_iterator;The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 15 minutes after creation.
}