Skip to content

TimestreamWriteClient

Index > TimestreamWrite > TimestreamWriteClient

Auto-generated documentation for TimestreamWrite type annotations stubs module mypy-boto3-timestream-write.

TimestreamWriteClient

Type annotations and code completion for boto3.client("timestream-write"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_timestream_write.client import TimestreamWriteClient

def get_timestream-write_client() -> TimestreamWriteClient:
    return Session().client("timestream-write")

Exceptions

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

Usage example
client = boto3.client("timestream-write")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.InvalidEndpointException,
    client.RejectedRecordsException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_timestream_write.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("timestream-write").can_paginate method. boto3 documentation

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("timestream-write").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_database

Creates a new Timestream database.

Type annotations and code completion for boto3.client("timestream-write").create_database method. boto3 documentation

Method definition
def create_database(
    self,
    *,
    DatabaseName: str,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDatabaseResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDatabaseResponseTypeDef
Usage example with kwargs
kwargs: CreateDatabaseRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
}

parent.create_database(**kwargs)
  1. See CreateDatabaseRequestRequestTypeDef

create_table

The CreateTable operation adds a new table to an existing database in your account.

Type annotations and code completion for boto3.client("timestream-write").create_table method. boto3 documentation

Method definition
def create_table(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    RetentionProperties: RetentionPropertiesTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    MagneticStoreWriteProperties: MagneticStoreWritePropertiesTypeDef = ...,  # (3)
) -> CreateTableResponseTypeDef:  # (4)
    ...
  1. See RetentionPropertiesTypeDef
  2. See TagTypeDef
  3. See MagneticStoreWritePropertiesTypeDef
  4. See CreateTableResponseTypeDef
Usage example with kwargs
kwargs: CreateTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

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

delete_database

Deletes a given Timestream database.

Type annotations and code completion for boto3.client("timestream-write").delete_database method. boto3 documentation

Method definition
def delete_database(
    self,
    *,
    DatabaseName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDatabaseRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
}

parent.delete_database(**kwargs)
  1. See DeleteDatabaseRequestRequestTypeDef

delete_table

Deletes a given Timestream table.

Type annotations and code completion for boto3.client("timestream-write").delete_table method. boto3 documentation

Method definition
def delete_table(
    self,
    *,
    DatabaseName: str,
    TableName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

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

describe_database

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database.

Type annotations and code completion for boto3.client("timestream-write").describe_database method. boto3 documentation

Method definition
def describe_database(
    self,
    *,
    DatabaseName: str,
) -> DescribeDatabaseResponseTypeDef:  # (1)
    ...
  1. See DescribeDatabaseResponseTypeDef
Usage example with kwargs
kwargs: DescribeDatabaseRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
}

parent.describe_database(**kwargs)
  1. See DescribeDatabaseRequestRequestTypeDef

describe_endpoints

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.

Type annotations and code completion for boto3.client("timestream-write").describe_endpoints method. boto3 documentation

Method definition
def describe_endpoints(
    self,
) -> DescribeEndpointsResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointsResponseTypeDef

describe_table

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store.

Type annotations and code completion for boto3.client("timestream-write").describe_table method. boto3 documentation

Method definition
def describe_table(
    self,
    *,
    DatabaseName: str,
    TableName: str,
) -> DescribeTableResponseTypeDef:  # (1)
    ...
  1. See DescribeTableResponseTypeDef
Usage example with kwargs
kwargs: DescribeTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

parent.describe_table(**kwargs)
  1. See DescribeTableRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("timestream-write").generate_presigned_url method. boto3 documentation

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

list_databases

Returns a list of your Timestream databases.

Type annotations and code completion for boto3.client("timestream-write").list_databases method. boto3 documentation

Method definition
def list_databases(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatabasesResponseTypeDef:  # (1)
    ...
  1. See ListDatabasesResponseTypeDef
Usage example with kwargs
kwargs: ListDatabasesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_databases(**kwargs)
  1. See ListDatabasesRequestRequestTypeDef

list_tables

A list of tables, along with the name, status and retention properties of each table.

Type annotations and code completion for boto3.client("timestream-write").list_tables method. boto3 documentation

Method definition
def list_tables(
    self,
    *,
    DatabaseName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTablesResponseTypeDef:  # (1)
    ...
  1. See ListTablesResponseTypeDef
Usage example with kwargs
kwargs: ListTablesRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
}

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

list_tags_for_resource

List all tags on a Timestream resource.

Type annotations and code completion for boto3.client("timestream-write").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Associate a set of tags with a Timestream resource.

Type annotations and code completion for boto3.client("timestream-write").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the association of tags from a Timestream resource.

Type annotations and code completion for boto3.client("timestream-write").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_database

Modifies the KMS key for an existing database.

Type annotations and code completion for boto3.client("timestream-write").update_database method. boto3 documentation

Method definition
def update_database(
    self,
    *,
    DatabaseName: str,
    KmsKeyId: str,
) -> UpdateDatabaseResponseTypeDef:  # (1)
    ...
  1. See UpdateDatabaseResponseTypeDef
Usage example with kwargs
kwargs: UpdateDatabaseRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "KmsKeyId": ...,
}

parent.update_database(**kwargs)
  1. See UpdateDatabaseRequestRequestTypeDef

update_table

Modifies the retention duration of the memory store and magnetic store for your Timestream table.

Type annotations and code completion for boto3.client("timestream-write").update_table method. boto3 documentation

Method definition
def update_table(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    RetentionProperties: RetentionPropertiesTypeDef = ...,  # (1)
    MagneticStoreWriteProperties: MagneticStoreWritePropertiesTypeDef = ...,  # (2)
) -> UpdateTableResponseTypeDef:  # (3)
    ...
  1. See RetentionPropertiesTypeDef
  2. See MagneticStoreWritePropertiesTypeDef
  3. See UpdateTableResponseTypeDef
Usage example with kwargs
kwargs: UpdateTableRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

parent.update_table(**kwargs)
  1. See UpdateTableRequestRequestTypeDef

write_records

The WriteRecords operation enables you to write your time series data into Timestream.

Type annotations and code completion for boto3.client("timestream-write").write_records method. boto3 documentation

Method definition
def write_records(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    Records: Sequence[RecordTypeDef],  # (1)
    CommonAttributes: RecordTypeDef = ...,  # (2)
) -> WriteRecordsResponseTypeDef:  # (3)
    ...
  1. See RecordTypeDef
  2. See RecordTypeDef
  3. See WriteRecordsResponseTypeDef
Usage example with kwargs
kwargs: WriteRecordsRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "Records": ...,
}

parent.write_records(**kwargs)
  1. See WriteRecordsRequestRequestTypeDef