Skip to content

GetTableResponse

Source code in docs_src/capo_keyspaces/types/get_table_response.py
class GetTableResponse(TypedDict, closed=True):
    keyspace_name: "capo_keyspaces.types.keyspace_name.KeyspaceName"
    """<p>The name of the keyspace that the specified table is stored in.</p>"""
    table_name: "capo_keyspaces.types.table_name.TableName"
    """<p>The name of the specified table.</p>"""
    resource_arn: "capo_keyspaces.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the specified table.</p>"""
    creation_timestamp: NotRequired["capo_keyspaces.types.timestamp.Timestamp"]
    """<p>The creation timestamp of the specified table.</p>"""
    status: NotRequired["capo_keyspaces.types.table_status.TableStatus"]
    """<p>The current status of the specified table.</p>"""
    schema_definition: NotRequired[
        "capo_keyspaces.types.schema_definition.SchemaDefinition"
    ]
    """<p>The schema definition of the specified table.</p>"""
    capacity_specification: NotRequired[
        "capo_keyspaces.types.capacity_specification_summary.CapacitySpecificationSummary"
    ]
    """<p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> </p> </li> </ul>"""
    encryption_specification: NotRequired[
        "capo_keyspaces.types.encryption_specification.EncryptionSpecification"
    ]
    """<p>The encryption settings of the specified table.</p>"""
    point_in_time_recovery: NotRequired[
        "capo_keyspaces.types.point_in_time_recovery_summary.PointInTimeRecoverySummary"
    ]
    """<p>The point-in-time recovery status of the specified table.</p>"""
    ttl: NotRequired["capo_keyspaces.types.time_to_live.TimeToLive"]
    """<p>The custom Time to Live settings of the specified table.</p>"""
    default_time_to_live: NotRequired[
        "capo_keyspaces.types.default_time_to_live.DefaultTimeToLive"
    ]
    """<p>The default Time to Live settings in seconds of the specified table.</p>"""
    comment: NotRequired["capo_keyspaces.types.comment.Comment"]
    """<p>The the description of the specified table.</p>"""
    client_side_timestamps: NotRequired[
        "capo_keyspaces.types.client_side_timestamps.ClientSideTimestamps"
    ]
    """<p> The client-side timestamps setting of the table.</p>"""
    replica_specifications: NotRequired[
        "capo_keyspaces.types.replica_specification_summary_list.ReplicaSpecificationSummaryList"
    ]
    """<p>Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.</p>"""
    latest_stream_arn: NotRequired["capo_keyspaces.types.stream_arn.StreamArn"]
    """<p>The Amazon Resource Name (ARN) of the stream.</p>"""
    cdc_specification: NotRequired[
        "capo_keyspaces.types.cdc_specification_summary.CdcSpecificationSummary"
    ]
    """<p>The CDC stream settings of the table.</p>"""
    warm_throughput_specification: NotRequired[
        "capo_keyspaces.types.warm_throughput_specification_summary.WarmThroughputSpecificationSummary"
    ]
    """<p>The warm throughput settings for the table, including the current status and configured read and write capacity units.</p>"""

capacity_specification instance-attribute

capacity_specification: NotRequired[CapacitySpecificationSummary]

The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST

  • throughputMode:PROVISIONED

cdc_specification instance-attribute

cdc_specification: NotRequired[CdcSpecificationSummary]

The CDC stream settings of the table.

client_side_timestamps instance-attribute

client_side_timestamps: NotRequired[ClientSideTimestamps]

The client-side timestamps setting of the table.

comment instance-attribute

comment: NotRequired[Comment]

The the description of the specified table.

creation_timestamp instance-attribute

creation_timestamp: NotRequired[Timestamp]

The creation timestamp of the specified table.

default_time_to_live instance-attribute

default_time_to_live: NotRequired[DefaultTimeToLive]

The default Time to Live settings in seconds of the specified table.

encryption_specification instance-attribute

encryption_specification: NotRequired[EncryptionSpecification]

The encryption settings of the specified table.

keyspace_name instance-attribute

keyspace_name: KeyspaceName

The name of the keyspace that the specified table is stored in.

latest_stream_arn instance-attribute

latest_stream_arn: NotRequired[StreamArn]

The Amazon Resource Name (ARN) of the stream.

point_in_time_recovery instance-attribute

point_in_time_recovery: NotRequired[PointInTimeRecoverySummary]

The point-in-time recovery status of the specified table.

replica_specifications instance-attribute

replica_specifications: NotRequired[ReplicaSpecificationSummaryList]

Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.

resource_arn instance-attribute

resource_arn: ARN

The Amazon Resource Name (ARN) of the specified table.

schema_definition instance-attribute

schema_definition: NotRequired[SchemaDefinition]

The schema definition of the specified table.

status instance-attribute

status: NotRequired[TableStatus]

The current status of the specified table.

table_name instance-attribute

table_name: TableName

The name of the specified table.

ttl instance-attribute

ttl: NotRequired[TimeToLive]

The custom Time to Live settings of the specified table.

warm_throughput_specification instance-attribute

warm_throughput_specification: NotRequired[WarmThroughputSpecificationSummary]

The warm throughput settings for the table, including the current status and configured read and write capacity units.