TimestreamWriteClient
Index > TimestreamWrite > TimestreamWriteClient
Auto-generated documentation for TimestreamWrite type annotations stubs module types-aiobotocore-timestream-write.
TimestreamWriteClient
Type annotations and code completion for session.client("timestream-write")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_timestream_write.client import TimestreamWriteClient
session = Session()
async with session.client("timestream-write") as client:
client: TimestreamWriteClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("timestream-write").exceptions
structure.
async with session.client("timestream-write") as client:
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)
from types_aiobotocore_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 session.client("timestream-write").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("timestream-write").close
method.
boto3 documentation
create_database
Creates a new Timestream database.
Type annotations and code completion for session.client("timestream-write").create_database
method.
boto3 documentation
await def create_database(
self,
*,
DatabaseName: str,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDatabaseResponseTypeDef: # (2)
...
kwargs: CreateDatabaseRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
}
parent.create_database(**kwargs)
create_table
The CreateTable operation adds a new table to an existing database in your account.
Type annotations and code completion for session.client("timestream-write").create_table
method.
boto3 documentation
await def create_table(
self,
*,
DatabaseName: str,
TableName: str,
RetentionProperties: RetentionPropertiesTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
MagneticStoreWriteProperties: MagneticStoreWritePropertiesTypeDef = ..., # (3)
) -> CreateTableResponseTypeDef: # (4)
...
- See RetentionPropertiesTypeDef
- See TagTypeDef
- See MagneticStoreWritePropertiesTypeDef
- See CreateTableResponseTypeDef
kwargs: CreateTableRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.create_table(**kwargs)
delete_database
Deletes a given Timestream database.
Type annotations and code completion for session.client("timestream-write").delete_database
method.
boto3 documentation
await def delete_database(
self,
*,
DatabaseName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDatabaseRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
}
parent.delete_database(**kwargs)
delete_table
Deletes a given Timestream table.
Type annotations and code completion for session.client("timestream-write").delete_table
method.
boto3 documentation
await def delete_table(
self,
*,
DatabaseName: str,
TableName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteTableRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.delete_table(**kwargs)
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 session.client("timestream-write").describe_database
method.
boto3 documentation
await def describe_database(
self,
*,
DatabaseName: str,
) -> DescribeDatabaseResponseTypeDef: # (1)
...
kwargs: DescribeDatabaseRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
}
parent.describe_database(**kwargs)
describe_endpoints
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
Type annotations and code completion for session.client("timestream-write").describe_endpoints
method.
boto3 documentation
await def describe_endpoints(
self,
) -> DescribeEndpointsResponseTypeDef: # (1)
...
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 session.client("timestream-write").describe_table
method.
boto3 documentation
await def describe_table(
self,
*,
DatabaseName: str,
TableName: str,
) -> DescribeTableResponseTypeDef: # (1)
...
kwargs: DescribeTableRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.describe_table(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("timestream-write").generate_presigned_url
method.
boto3 documentation
await 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 session.client("timestream-write").list_databases
method.
boto3 documentation
await def list_databases(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDatabasesResponseTypeDef: # (1)
...
kwargs: ListDatabasesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_databases(**kwargs)
list_tables
A list of tables, along with the name, status and retention properties of each table.
Type annotations and code completion for session.client("timestream-write").list_tables
method.
boto3 documentation
await def list_tables(
self,
*,
DatabaseName: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTablesResponseTypeDef: # (1)
...
kwargs: ListTablesRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
}
parent.list_tables(**kwargs)
list_tags_for_resource
List all tags on a Timestream resource.
Type annotations and code completion for session.client("timestream-write").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource
Associate a set of tags with a Timestream resource.
Type annotations and code completion for session.client("timestream-write").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes the association of tags from a Timestream resource.
Type annotations and code completion for session.client("timestream-write").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_database
Modifies the KMS key for an existing database.
Type annotations and code completion for session.client("timestream-write").update_database
method.
boto3 documentation
await def update_database(
self,
*,
DatabaseName: str,
KmsKeyId: str,
) -> UpdateDatabaseResponseTypeDef: # (1)
...
kwargs: UpdateDatabaseRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"KmsKeyId": ...,
}
parent.update_database(**kwargs)
update_table
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
Type annotations and code completion for session.client("timestream-write").update_table
method.
boto3 documentation
await def update_table(
self,
*,
DatabaseName: str,
TableName: str,
RetentionProperties: RetentionPropertiesTypeDef = ..., # (1)
MagneticStoreWriteProperties: MagneticStoreWritePropertiesTypeDef = ..., # (2)
) -> UpdateTableResponseTypeDef: # (3)
...
- See RetentionPropertiesTypeDef
- See MagneticStoreWritePropertiesTypeDef
- See UpdateTableResponseTypeDef
kwargs: UpdateTableRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.update_table(**kwargs)
write_records
The WriteRecords operation enables you to write your time series data into Timestream.
Type annotations and code completion for session.client("timestream-write").write_records
method.
boto3 documentation
await def write_records(
self,
*,
DatabaseName: str,
TableName: str,
Records: Sequence[RecordTypeDef], # (1)
CommonAttributes: RecordTypeDef = ..., # (2)
) -> WriteRecordsResponseTypeDef: # (3)
...
- See RecordTypeDef
- See RecordTypeDef
- See WriteRecordsResponseTypeDef
kwargs: WriteRecordsRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"Records": ...,
}
parent.write_records(**kwargs)
__aenter__
Type annotations and code completion for session.client("timestream-write").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("timestream-write").__aexit__
method.
boto3 documentation