Skip to content

DataTableAttribute

Source code in docs_src/capo_connect/types/data_table_attribute.py
class DataTableAttribute(TypedDict, closed=True):
    attribute_id: NotRequired["capo_connect.types.data_table_id.DataTableId"]
    """<p>The unique identifier for the attribute within the data table.</p>"""
    name: "capo_connect.types.data_table_name.DataTableName"
    """<p>The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.</p>"""
    value_type: (
        "capo_connect.types.data_table_attribute_value_type.DataTableAttributeValueType"
    )
    """<p>The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.</p>"""
    description: NotRequired[
        "capo_connect.types.data_table_description.DataTableDescription"
    ]
    """<p>An optional description explaining the purpose and usage of this attribute.</p>"""
    data_table_id: NotRequired["capo_connect.types.data_table_id.DataTableId"]
    """<p>The unique identifier of the data table that contains this attribute.</p>"""
    data_table_arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the data table that contains this attribute.</p>"""
    primary: "capo_connect.types.boolean.Boolean"
    """<p>Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.</p>"""
    version: NotRequired["capo_connect.types.data_table_version.DataTableVersion"]
    """<p>The version identifier for this attribute, used for versioning and change tracking.</p>"""
    lock_version: NotRequired[
        "capo_connect.types.data_table_lock_version.DataTableLockVersion"
    ]
    """<p>The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.</p>"""
    last_modified_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when this attribute was last modified.</p>"""
    last_modified_region: NotRequired["capo_connect.types.region_name.RegionName"]
    """<p>The Amazon Web Services Region where this attribute was last modified, used for region replication.</p>"""
    validation: NotRequired["capo_connect.types.validation.Validation"]
    """<p>The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.</p>"""

attribute_id instance-attribute

attribute_id: NotRequired[DataTableId]

The unique identifier for the attribute within the data table.

data_table_arn instance-attribute

data_table_arn: NotRequired[ARN]

The Amazon Resource Name (ARN) of the data table that contains this attribute.

data_table_id instance-attribute

data_table_id: NotRequired[DataTableId]

The unique identifier of the data table that contains this attribute.

description instance-attribute

description: NotRequired[DataTableDescription]

An optional description explaining the purpose and usage of this attribute.

last_modified_region instance-attribute

last_modified_region: NotRequired[RegionName]

The Amazon Web Services Region where this attribute was last modified, used for region replication.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The timestamp when this attribute was last modified.

lock_version instance-attribute

lock_version: NotRequired[DataTableLockVersion]

The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.

name instance-attribute

The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.

primary instance-attribute

primary: Boolean

Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.

validation instance-attribute

validation: NotRequired[Validation]

The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.

value_type instance-attribute

The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.

version instance-attribute

version: NotRequired[DataTableVersion]

The version identifier for this attribute, used for versioning and change tracking.