Skip to content

S3TablesClient#

Index > S3Tables > S3TablesClient

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

S3TablesClient#

Type annotations and code completion for boto3.client("s3tables"). boto3 documentation

# S3TablesClient usage example

from boto3.session import Session
from types_boto3_s3tables.client import S3TablesClient

def get_s3tables_client() -> S3TablesClient:
    return Session().client("s3tables")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("s3tables").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("s3tables")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_s3tables.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("s3tables").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("s3tables").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_namespace#

Creates a namespace.

Type annotations and code completion for boto3.client("s3tables").create_namespace method. boto3 documentation

# create_namespace method definition

def create_namespace(
    self,
    *,
    tableBucketARN: str,
    namespace: Sequence[str],
) -> CreateNamespaceResponseTypeDef:  # (1)
    ...
  1. See CreateNamespaceResponseTypeDef 
# create_namespace method usage example with argument unpacking

kwargs: CreateNamespaceRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
}

parent.create_namespace(**kwargs)
  1. See CreateNamespaceRequestRequestTypeDef

create_table#

Creates a new table associated with the given namespace in a table bucket.

Type annotations and code completion for boto3.client("s3tables").create_table method. boto3 documentation

# create_table method definition

def create_table(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    format: OpenTableFormatType,  # (1)
) -> CreateTableResponseTypeDef:  # (2)
    ...
  1. See OpenTableFormatType
  2. See CreateTableResponseTypeDef 
# create_table method usage example with argument unpacking

kwargs: CreateTableRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
    "format": ...,
}

parent.create_table(**kwargs)
  1. See CreateTableRequestRequestTypeDef

create_table_bucket#

Creates a table bucket.

Type annotations and code completion for boto3.client("s3tables").create_table_bucket method. boto3 documentation

# create_table_bucket method definition

def create_table_bucket(
    self,
    *,
    name: str,
) -> CreateTableBucketResponseTypeDef:  # (1)
    ...
  1. See CreateTableBucketResponseTypeDef 
# create_table_bucket method usage example with argument unpacking

kwargs: CreateTableBucketRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_table_bucket(**kwargs)
  1. See CreateTableBucketRequestRequestTypeDef

delete_namespace#

Deletes a namespace.

Type annotations and code completion for boto3.client("s3tables").delete_namespace method. boto3 documentation

# delete_namespace method definition

def delete_namespace(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_namespace method usage example with argument unpacking

kwargs: DeleteNamespaceRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
}

parent.delete_namespace(**kwargs)
  1. See DeleteNamespaceRequestRequestTypeDef

delete_table#

Deletes a table.

Type annotations and code completion for boto3.client("s3tables").delete_table method. boto3 documentation

# delete_table method definition

def delete_table(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    versionToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_table method usage example with argument unpacking

kwargs: DeleteTableRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.delete_table(**kwargs)
  1. See DeleteTableRequestRequestTypeDef

delete_table_bucket#

Deletes a table bucket.

Type annotations and code completion for boto3.client("s3tables").delete_table_bucket method. boto3 documentation

# delete_table_bucket method definition

def delete_table_bucket(
    self,
    *,
    tableBucketARN: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_table_bucket method usage example with argument unpacking

kwargs: DeleteTableBucketRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.delete_table_bucket(**kwargs)
  1. See DeleteTableBucketRequestRequestTypeDef

delete_table_bucket_policy#

Deletes a table bucket policy.

Type annotations and code completion for boto3.client("s3tables").delete_table_bucket_policy method. boto3 documentation

# delete_table_bucket_policy method definition

def delete_table_bucket_policy(
    self,
    *,
    tableBucketARN: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_table_bucket_policy method usage example with argument unpacking

kwargs: DeleteTableBucketPolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.delete_table_bucket_policy(**kwargs)
  1. See DeleteTableBucketPolicyRequestRequestTypeDef

delete_table_policy#

Deletes a table policy.

Type annotations and code completion for boto3.client("s3tables").delete_table_policy method. boto3 documentation

# delete_table_policy method definition

def delete_table_policy(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_table_policy method usage example with argument unpacking

kwargs: DeleteTablePolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.delete_table_policy(**kwargs)
  1. See DeleteTablePolicyRequestRequestTypeDef

get_namespace#

Gets details about a namespace.

Type annotations and code completion for boto3.client("s3tables").get_namespace method. boto3 documentation

# get_namespace method definition

def get_namespace(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
) -> GetNamespaceResponseTypeDef:  # (1)
    ...
  1. See GetNamespaceResponseTypeDef 
# get_namespace method usage example with argument unpacking

kwargs: GetNamespaceRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
}

parent.get_namespace(**kwargs)
  1. See GetNamespaceRequestRequestTypeDef

get_table#

Gets details about a table.

Type annotations and code completion for boto3.client("s3tables").get_table method. boto3 documentation

# get_table method definition

def get_table(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> GetTableResponseTypeDef:  # (1)
    ...
  1. See GetTableResponseTypeDef 
# get_table method usage example with argument unpacking

kwargs: GetTableRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_table(**kwargs)
  1. See GetTableRequestRequestTypeDef

get_table_bucket#

Gets details on a table bucket.

Type annotations and code completion for boto3.client("s3tables").get_table_bucket method. boto3 documentation

# get_table_bucket method definition

def get_table_bucket(
    self,
    *,
    tableBucketARN: str,
) -> GetTableBucketResponseTypeDef:  # (1)
    ...
  1. See GetTableBucketResponseTypeDef 
# get_table_bucket method usage example with argument unpacking

kwargs: GetTableBucketRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.get_table_bucket(**kwargs)
  1. See GetTableBucketRequestRequestTypeDef

get_table_bucket_maintenance_configuration#

Gets details about a maintenance configuration for a given table bucket.

Type annotations and code completion for boto3.client("s3tables").get_table_bucket_maintenance_configuration method. boto3 documentation

# get_table_bucket_maintenance_configuration method definition

def get_table_bucket_maintenance_configuration(
    self,
    *,
    tableBucketARN: str,
) -> GetTableBucketMaintenanceConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetTableBucketMaintenanceConfigurationResponseTypeDef 
# get_table_bucket_maintenance_configuration method usage example with argument unpacking

kwargs: GetTableBucketMaintenanceConfigurationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.get_table_bucket_maintenance_configuration(**kwargs)
  1. See GetTableBucketMaintenanceConfigurationRequestRequestTypeDef

get_table_bucket_policy#

Gets details about a table bucket policy.

Type annotations and code completion for boto3.client("s3tables").get_table_bucket_policy method. boto3 documentation

# get_table_bucket_policy method definition

def get_table_bucket_policy(
    self,
    *,
    tableBucketARN: str,
) -> GetTableBucketPolicyResponseTypeDef:  # (1)
    ...
  1. See GetTableBucketPolicyResponseTypeDef 
# get_table_bucket_policy method usage example with argument unpacking

kwargs: GetTableBucketPolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.get_table_bucket_policy(**kwargs)
  1. See GetTableBucketPolicyRequestRequestTypeDef

get_table_maintenance_configuration#

Gets details about the maintenance configuration of a table.

Type annotations and code completion for boto3.client("s3tables").get_table_maintenance_configuration method. boto3 documentation

# get_table_maintenance_configuration method definition

def get_table_maintenance_configuration(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> GetTableMaintenanceConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetTableMaintenanceConfigurationResponseTypeDef 
# get_table_maintenance_configuration method usage example with argument unpacking

kwargs: GetTableMaintenanceConfigurationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_table_maintenance_configuration(**kwargs)
  1. See GetTableMaintenanceConfigurationRequestRequestTypeDef

get_table_maintenance_job_status#

Gets the status of a maintenance job for a table.

Type annotations and code completion for boto3.client("s3tables").get_table_maintenance_job_status method. boto3 documentation

# get_table_maintenance_job_status method definition

def get_table_maintenance_job_status(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> GetTableMaintenanceJobStatusResponseTypeDef:  # (1)
    ...
  1. See GetTableMaintenanceJobStatusResponseTypeDef 
# get_table_maintenance_job_status method usage example with argument unpacking

kwargs: GetTableMaintenanceJobStatusRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_table_maintenance_job_status(**kwargs)
  1. See GetTableMaintenanceJobStatusRequestRequestTypeDef

get_table_metadata_location#

Gets the location of the table metadata.

Type annotations and code completion for boto3.client("s3tables").get_table_metadata_location method. boto3 documentation

# get_table_metadata_location method definition

def get_table_metadata_location(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> GetTableMetadataLocationResponseTypeDef:  # (1)
    ...
  1. See GetTableMetadataLocationResponseTypeDef 
# get_table_metadata_location method usage example with argument unpacking

kwargs: GetTableMetadataLocationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_table_metadata_location(**kwargs)
  1. See GetTableMetadataLocationRequestRequestTypeDef

get_table_policy#

Gets details about a table policy.

Type annotations and code completion for boto3.client("s3tables").get_table_policy method. boto3 documentation

# get_table_policy method definition

def get_table_policy(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
) -> GetTablePolicyResponseTypeDef:  # (1)
    ...
  1. See GetTablePolicyResponseTypeDef 
# get_table_policy method usage example with argument unpacking

kwargs: GetTablePolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_table_policy(**kwargs)
  1. See GetTablePolicyRequestRequestTypeDef

list_namespaces#

Lists the namespaces within a table bucket.

Type annotations and code completion for boto3.client("s3tables").list_namespaces method. boto3 documentation

# list_namespaces method definition

def list_namespaces(
    self,
    *,
    tableBucketARN: str,
    prefix: str = ...,
    continuationToken: str = ...,
    maxNamespaces: int = ...,
) -> ListNamespacesResponseTypeDef:  # (1)
    ...
  1. See ListNamespacesResponseTypeDef 
# list_namespaces method usage example with argument unpacking

kwargs: ListNamespacesRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.list_namespaces(**kwargs)
  1. See ListNamespacesRequestRequestTypeDef

list_table_buckets#

Lists table buckets for your account.

Type annotations and code completion for boto3.client("s3tables").list_table_buckets method. boto3 documentation

# list_table_buckets method definition

def list_table_buckets(
    self,
    *,
    prefix: str = ...,
    continuationToken: str = ...,
    maxBuckets: int = ...,
) -> ListTableBucketsResponseTypeDef:  # (1)
    ...
  1. See ListTableBucketsResponseTypeDef 
# list_table_buckets method usage example with argument unpacking

kwargs: ListTableBucketsRequestRequestTypeDef = {  # (1)
    "prefix": ...,
}

parent.list_table_buckets(**kwargs)
  1. See ListTableBucketsRequestRequestTypeDef

list_tables#

List tables in the given table bucket.

Type annotations and code completion for boto3.client("s3tables").list_tables method. boto3 documentation

# list_tables method definition

def list_tables(
    self,
    *,
    tableBucketARN: str,
    namespace: str = ...,
    prefix: str = ...,
    continuationToken: str = ...,
    maxTables: int = ...,
) -> ListTablesResponseTypeDef:  # (1)
    ...
  1. See ListTablesResponseTypeDef 
# list_tables method usage example with argument unpacking

kwargs: ListTablesRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
}

parent.list_tables(**kwargs)
  1. See ListTablesRequestRequestTypeDef

put_table_bucket_maintenance_configuration#

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.

Type annotations and code completion for boto3.client("s3tables").put_table_bucket_maintenance_configuration method. boto3 documentation

# put_table_bucket_maintenance_configuration method definition

def put_table_bucket_maintenance_configuration(
    self,
    *,
    tableBucketARN: str,
    type: TableBucketMaintenanceTypeType,  # (1)
    value: TableBucketMaintenanceConfigurationValueTypeDef,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See TableBucketMaintenanceTypeType
  2. See TableBucketMaintenanceConfigurationValueTypeDef
  3. See EmptyResponseMetadataTypeDef 
# put_table_bucket_maintenance_configuration method usage example with argument unpacking

kwargs: PutTableBucketMaintenanceConfigurationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "type": ...,
    "value": ...,
}

parent.put_table_bucket_maintenance_configuration(**kwargs)
  1. See PutTableBucketMaintenanceConfigurationRequestRequestTypeDef

put_table_bucket_policy#

Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket.

Type annotations and code completion for boto3.client("s3tables").put_table_bucket_policy method. boto3 documentation

# put_table_bucket_policy method definition

def put_table_bucket_policy(
    self,
    *,
    tableBucketARN: str,
    resourcePolicy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# put_table_bucket_policy method usage example with argument unpacking

kwargs: PutTableBucketPolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "resourcePolicy": ...,
}

parent.put_table_bucket_policy(**kwargs)
  1. See PutTableBucketPolicyRequestRequestTypeDef

put_table_maintenance_configuration#

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.

Type annotations and code completion for boto3.client("s3tables").put_table_maintenance_configuration method. boto3 documentation

# put_table_maintenance_configuration method definition

def put_table_maintenance_configuration(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    type: TableMaintenanceTypeType,  # (1)
    value: TableMaintenanceConfigurationValueTypeDef,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See TableMaintenanceTypeType
  2. See TableMaintenanceConfigurationValueTypeDef
  3. See EmptyResponseMetadataTypeDef 
# put_table_maintenance_configuration method usage example with argument unpacking

kwargs: PutTableMaintenanceConfigurationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
    "type": ...,
    "value": ...,
}

parent.put_table_maintenance_configuration(**kwargs)
  1. See PutTableMaintenanceConfigurationRequestRequestTypeDef

put_table_policy#

Creates a new maintenance configuration or replaces an existing table policy for a table.

Type annotations and code completion for boto3.client("s3tables").put_table_policy method. boto3 documentation

# put_table_policy method definition

def put_table_policy(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    resourcePolicy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# put_table_policy method usage example with argument unpacking

kwargs: PutTablePolicyRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
    "resourcePolicy": ...,
}

parent.put_table_policy(**kwargs)
  1. See PutTablePolicyRequestRequestTypeDef

rename_table#

Renames a table or a namespace.

Type annotations and code completion for boto3.client("s3tables").rename_table method. boto3 documentation

# rename_table method definition

def rename_table(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    newNamespaceName: str = ...,
    newName: str = ...,
    versionToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# rename_table method usage example with argument unpacking

kwargs: RenameTableRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
}

parent.rename_table(**kwargs)
  1. See RenameTableRequestRequestTypeDef

update_table_metadata_location#

Updates the metadata location for a table.

Type annotations and code completion for boto3.client("s3tables").update_table_metadata_location method. boto3 documentation

# update_table_metadata_location method definition

def update_table_metadata_location(
    self,
    *,
    tableBucketARN: str,
    namespace: str,
    name: str,
    versionToken: str,
    metadataLocation: str,
) -> UpdateTableMetadataLocationResponseTypeDef:  # (1)
    ...
  1. See UpdateTableMetadataLocationResponseTypeDef 
# update_table_metadata_location method usage example with argument unpacking

kwargs: UpdateTableMetadataLocationRequestRequestTypeDef = {  # (1)
    "tableBucketARN": ...,
    "namespace": ...,
    "name": ...,
    "versionToken": ...,
    "metadataLocation": ...,
}

parent.update_table_metadata_location(**kwargs)
  1. See UpdateTableMetadataLocationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("s3tables").get_paginator method with overloads.