Skip to content

Type definitions#

Index > S3Tables > Type definitions

Auto-generated documentation for S3Tables type annotations stubs module mypy-boto3-s3tables.

CreateNamespaceRequestRequestTypeDef#

# CreateNamespaceRequestRequestTypeDef definition

class CreateNamespaceRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateTableBucketRequestRequestTypeDef#

# CreateTableBucketRequestRequestTypeDef definition

class CreateTableBucketRequestRequestTypeDef(TypedDict):
    name: str,

CreateTableRequestRequestTypeDef#

# CreateTableRequestRequestTypeDef definition

class CreateTableRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    format: OpenTableFormatType,  # (1)
  1. See OpenTableFormatType

DeleteNamespaceRequestRequestTypeDef#

# DeleteNamespaceRequestRequestTypeDef definition

class DeleteNamespaceRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,

DeleteTableBucketPolicyRequestRequestTypeDef#

# DeleteTableBucketPolicyRequestRequestTypeDef definition

class DeleteTableBucketPolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,

DeleteTableBucketRequestRequestTypeDef#

# DeleteTableBucketRequestRequestTypeDef definition

class DeleteTableBucketRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,

DeleteTablePolicyRequestRequestTypeDef#

# DeleteTablePolicyRequestRequestTypeDef definition

class DeleteTablePolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

DeleteTableRequestRequestTypeDef#

# DeleteTableRequestRequestTypeDef definition

class DeleteTableRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    versionToken: NotRequired[str],

GetNamespaceRequestRequestTypeDef#

# GetNamespaceRequestRequestTypeDef definition

class GetNamespaceRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,

GetTableBucketMaintenanceConfigurationRequestRequestTypeDef#

# GetTableBucketMaintenanceConfigurationRequestRequestTypeDef definition

class GetTableBucketMaintenanceConfigurationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,

GetTableBucketPolicyRequestRequestTypeDef#

# GetTableBucketPolicyRequestRequestTypeDef definition

class GetTableBucketPolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,

GetTableBucketRequestRequestTypeDef#

# GetTableBucketRequestRequestTypeDef definition

class GetTableBucketRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,

GetTableMaintenanceConfigurationRequestRequestTypeDef#

# GetTableMaintenanceConfigurationRequestRequestTypeDef definition

class GetTableMaintenanceConfigurationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

GetTableMaintenanceJobStatusRequestRequestTypeDef#

# GetTableMaintenanceJobStatusRequestRequestTypeDef definition

class GetTableMaintenanceJobStatusRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

TableMaintenanceJobStatusValueTypeDef#

# TableMaintenanceJobStatusValueTypeDef definition

class TableMaintenanceJobStatusValueTypeDef(TypedDict):
    status: JobStatusType,  # (1)
    lastRunTimestamp: NotRequired[datetime],
    failureMessage: NotRequired[str],
  1. See JobStatusType

GetTableMetadataLocationRequestRequestTypeDef#

# GetTableMetadataLocationRequestRequestTypeDef definition

class GetTableMetadataLocationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

GetTablePolicyRequestRequestTypeDef#

# GetTablePolicyRequestRequestTypeDef definition

class GetTablePolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

GetTableRequestRequestTypeDef#

# GetTableRequestRequestTypeDef definition

class GetTableRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,

IcebergCompactionSettingsTypeDef#

# IcebergCompactionSettingsTypeDef definition

class IcebergCompactionSettingsTypeDef(TypedDict):
    targetFileSizeMB: NotRequired[int],

IcebergSnapshotManagementSettingsTypeDef#

# IcebergSnapshotManagementSettingsTypeDef definition

class IcebergSnapshotManagementSettingsTypeDef(TypedDict):
    minSnapshotsToKeep: NotRequired[int],
    maxSnapshotAgeHours: NotRequired[int],

IcebergUnreferencedFileRemovalSettingsTypeDef#

# IcebergUnreferencedFileRemovalSettingsTypeDef definition

class IcebergUnreferencedFileRemovalSettingsTypeDef(TypedDict):
    unreferencedDays: NotRequired[int],
    nonCurrentDays: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListNamespacesRequestRequestTypeDef#

# ListNamespacesRequestRequestTypeDef definition

class ListNamespacesRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    prefix: NotRequired[str],
    continuationToken: NotRequired[str],
    maxNamespaces: NotRequired[int],

NamespaceSummaryTypeDef#

# NamespaceSummaryTypeDef definition

class NamespaceSummaryTypeDef(TypedDict):
    namespace: List[str],
    createdAt: datetime,
    createdBy: str,
    ownerAccountId: str,

ListTableBucketsRequestRequestTypeDef#

# ListTableBucketsRequestRequestTypeDef definition

class ListTableBucketsRequestRequestTypeDef(TypedDict):
    prefix: NotRequired[str],
    continuationToken: NotRequired[str],
    maxBuckets: NotRequired[int],

TableBucketSummaryTypeDef#

# TableBucketSummaryTypeDef definition

class TableBucketSummaryTypeDef(TypedDict):
    arn: str,
    name: str,
    ownerAccountId: str,
    createdAt: datetime,

ListTablesRequestRequestTypeDef#

# ListTablesRequestRequestTypeDef definition

class ListTablesRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: NotRequired[str],
    prefix: NotRequired[str],
    continuationToken: NotRequired[str],
    maxTables: NotRequired[int],

TableSummaryTypeDef#

# TableSummaryTypeDef definition

class TableSummaryTypeDef(TypedDict):
    namespace: List[str],
    name: str,
    type: TableTypeType,  # (1)
    tableARN: str,
    createdAt: datetime,
    modifiedAt: datetime,
  1. See TableTypeType

PutTableBucketPolicyRequestRequestTypeDef#

# PutTableBucketPolicyRequestRequestTypeDef definition

class PutTableBucketPolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    resourcePolicy: str,

PutTablePolicyRequestRequestTypeDef#

# PutTablePolicyRequestRequestTypeDef definition

class PutTablePolicyRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    resourcePolicy: str,

RenameTableRequestRequestTypeDef#

# RenameTableRequestRequestTypeDef definition

class RenameTableRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    newNamespaceName: NotRequired[str],
    newName: NotRequired[str],
    versionToken: NotRequired[str],

UpdateTableMetadataLocationRequestRequestTypeDef#

# UpdateTableMetadataLocationRequestRequestTypeDef definition

class UpdateTableMetadataLocationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    versionToken: str,
    metadataLocation: str,

CreateNamespaceResponseTypeDef#

# CreateNamespaceResponseTypeDef definition

class CreateNamespaceResponseTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTableBucketResponseTypeDef#

# CreateTableBucketResponseTypeDef definition

class CreateTableBucketResponseTypeDef(TypedDict):
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTableResponseTypeDef#

# CreateTableResponseTypeDef definition

class CreateTableResponseTypeDef(TypedDict):
    tableARN: str,
    versionToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetNamespaceResponseTypeDef#

# GetNamespaceResponseTypeDef definition

class GetNamespaceResponseTypeDef(TypedDict):
    namespace: List[str],
    createdAt: datetime,
    createdBy: str,
    ownerAccountId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTableBucketPolicyResponseTypeDef#

# GetTableBucketPolicyResponseTypeDef definition

class GetTableBucketPolicyResponseTypeDef(TypedDict):
    resourcePolicy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTableBucketResponseTypeDef#

# GetTableBucketResponseTypeDef definition

class GetTableBucketResponseTypeDef(TypedDict):
    arn: str,
    name: str,
    ownerAccountId: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTableMetadataLocationResponseTypeDef#

# GetTableMetadataLocationResponseTypeDef definition

class GetTableMetadataLocationResponseTypeDef(TypedDict):
    versionToken: str,
    metadataLocation: str,
    warehouseLocation: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTablePolicyResponseTypeDef#

# GetTablePolicyResponseTypeDef definition

class GetTablePolicyResponseTypeDef(TypedDict):
    resourcePolicy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTableResponseTypeDef#

# GetTableResponseTypeDef definition

class GetTableResponseTypeDef(TypedDict):
    name: str,
    type: TableTypeType,  # (1)
    tableARN: str,
    namespace: List[str],
    versionToken: str,
    metadataLocation: str,
    warehouseLocation: str,
    createdAt: datetime,
    createdBy: str,
    managedByService: str,
    modifiedAt: datetime,
    modifiedBy: str,
    ownerAccountId: str,
    format: OpenTableFormatType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TableTypeType
  2. See OpenTableFormatType
  3. See ResponseMetadataTypeDef

UpdateTableMetadataLocationResponseTypeDef#

# UpdateTableMetadataLocationResponseTypeDef definition

class UpdateTableMetadataLocationResponseTypeDef(TypedDict):
    name: str,
    tableARN: str,
    namespace: List[str],
    versionToken: str,
    metadataLocation: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTableMaintenanceJobStatusResponseTypeDef#

# GetTableMaintenanceJobStatusResponseTypeDef definition

class GetTableMaintenanceJobStatusResponseTypeDef(TypedDict):
    tableARN: str,
    status: Dict[TableMaintenanceJobTypeType, TableMaintenanceJobStatusValueTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableMaintenanceJobTypeType TableMaintenanceJobStatusValueTypeDef
  2. See ResponseMetadataTypeDef

TableMaintenanceSettingsTypeDef#

# TableMaintenanceSettingsTypeDef definition

class TableMaintenanceSettingsTypeDef(TypedDict):
    icebergCompaction: NotRequired[IcebergCompactionSettingsTypeDef],  # (1)
    icebergSnapshotManagement: NotRequired[IcebergSnapshotManagementSettingsTypeDef],  # (2)
  1. See IcebergCompactionSettingsTypeDef
  2. See IcebergSnapshotManagementSettingsTypeDef

TableBucketMaintenanceSettingsTypeDef#

# TableBucketMaintenanceSettingsTypeDef definition

class TableBucketMaintenanceSettingsTypeDef(TypedDict):
    icebergUnreferencedFileRemoval: NotRequired[IcebergUnreferencedFileRemovalSettingsTypeDef],  # (1)
  1. See IcebergUnreferencedFileRemovalSettingsTypeDef

ListNamespacesRequestListNamespacesPaginateTypeDef#

# ListNamespacesRequestListNamespacesPaginateTypeDef definition

class ListNamespacesRequestListNamespacesPaginateTypeDef(TypedDict):
    tableBucketARN: str,
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTableBucketsRequestListTableBucketsPaginateTypeDef#

# ListTableBucketsRequestListTableBucketsPaginateTypeDef definition

class ListTableBucketsRequestListTableBucketsPaginateTypeDef(TypedDict):
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTablesRequestListTablesPaginateTypeDef#

# ListTablesRequestListTablesPaginateTypeDef definition

class ListTablesRequestListTablesPaginateTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: NotRequired[str],
    prefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListNamespacesResponseTypeDef#

# ListNamespacesResponseTypeDef definition

class ListNamespacesResponseTypeDef(TypedDict):
    namespaces: List[NamespaceSummaryTypeDef],  # (1)
    continuationToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NamespaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTableBucketsResponseTypeDef#

# ListTableBucketsResponseTypeDef definition

class ListTableBucketsResponseTypeDef(TypedDict):
    tableBuckets: List[TableBucketSummaryTypeDef],  # (1)
    continuationToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableBucketSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTablesResponseTypeDef#

# ListTablesResponseTypeDef definition

class ListTablesResponseTypeDef(TypedDict):
    tables: List[TableSummaryTypeDef],  # (1)
    continuationToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableSummaryTypeDef
  2. See ResponseMetadataTypeDef

TableMaintenanceConfigurationValueTypeDef#

# TableMaintenanceConfigurationValueTypeDef definition

class TableMaintenanceConfigurationValueTypeDef(TypedDict):
    status: NotRequired[MaintenanceStatusType],  # (1)
    settings: NotRequired[TableMaintenanceSettingsTypeDef],  # (2)
  1. See MaintenanceStatusType
  2. See TableMaintenanceSettingsTypeDef

TableBucketMaintenanceConfigurationValueTypeDef#

# TableBucketMaintenanceConfigurationValueTypeDef definition

class TableBucketMaintenanceConfigurationValueTypeDef(TypedDict):
    status: NotRequired[MaintenanceStatusType],  # (1)
    settings: NotRequired[TableBucketMaintenanceSettingsTypeDef],  # (2)
  1. See MaintenanceStatusType
  2. See TableBucketMaintenanceSettingsTypeDef

GetTableMaintenanceConfigurationResponseTypeDef#

# GetTableMaintenanceConfigurationResponseTypeDef definition

class GetTableMaintenanceConfigurationResponseTypeDef(TypedDict):
    tableARN: str,
    configuration: Dict[TableMaintenanceTypeType, TableMaintenanceConfigurationValueTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableMaintenanceTypeType TableMaintenanceConfigurationValueTypeDef
  2. See ResponseMetadataTypeDef

PutTableMaintenanceConfigurationRequestRequestTypeDef#

# PutTableMaintenanceConfigurationRequestRequestTypeDef definition

class PutTableMaintenanceConfigurationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    namespace: str,
    name: str,
    type: TableMaintenanceTypeType,  # (1)
    value: TableMaintenanceConfigurationValueTypeDef,  # (2)
  1. See TableMaintenanceTypeType
  2. See TableMaintenanceConfigurationValueTypeDef

GetTableBucketMaintenanceConfigurationResponseTypeDef#

# GetTableBucketMaintenanceConfigurationResponseTypeDef definition

class GetTableBucketMaintenanceConfigurationResponseTypeDef(TypedDict):
    tableBucketARN: str,
    configuration: Dict[TableBucketMaintenanceTypeType, TableBucketMaintenanceConfigurationValueTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableBucketMaintenanceTypeType TableBucketMaintenanceConfigurationValueTypeDef
  2. See ResponseMetadataTypeDef

PutTableBucketMaintenanceConfigurationRequestRequestTypeDef#

# PutTableBucketMaintenanceConfigurationRequestRequestTypeDef definition

class PutTableBucketMaintenanceConfigurationRequestRequestTypeDef(TypedDict):
    tableBucketARN: str,
    type: TableBucketMaintenanceTypeType,  # (1)
    value: TableBucketMaintenanceConfigurationValueTypeDef,  # (2)
  1. See TableBucketMaintenanceTypeType
  2. See TableBucketMaintenanceConfigurationValueTypeDef