Typed dictionaries
Index > TimestreamWrite > Typed dictionaries
Auto-generated documentation for TimestreamWrite type annotations stubs module types-aiobotocore-timestream-write.
TagTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
DatabaseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DatabaseTypeDef
def get_value() -> DatabaseTypeDef:
return {
"Arn": ...,
}
Definition
class DatabaseTypeDef(TypedDict):
Arn: NotRequired[str],
DatabaseName: NotRequired[str],
TableCount: NotRequired[int],
KmsKeyId: NotRequired[str],
CreationTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
RetentionPropertiesTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import RetentionPropertiesTypeDef
def get_value() -> RetentionPropertiesTypeDef:
return {
"MemoryStoreRetentionPeriodInHours": ...,
"MagneticStoreRetentionPeriodInDays": ...,
}
Definition
class RetentionPropertiesTypeDef(TypedDict):
MemoryStoreRetentionPeriodInHours: int,
MagneticStoreRetentionPeriodInDays: int,
DeleteDatabaseRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DeleteDatabaseRequestRequestTypeDef
def get_value() -> DeleteDatabaseRequestRequestTypeDef:
return {
"DatabaseName": ...,
}
DeleteTableRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DeleteTableRequestRequestTypeDef
def get_value() -> DeleteTableRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
}
DescribeDatabaseRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DescribeDatabaseRequestRequestTypeDef
def get_value() -> DescribeDatabaseRequestRequestTypeDef:
return {
"DatabaseName": ...,
}
EndpointTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"Address": ...,
"CachePeriodInMinutes": ...,
}
DescribeTableRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DescribeTableRequestRequestTypeDef
def get_value() -> DescribeTableRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
}
DimensionTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DimensionTypeDef
def get_value() -> DimensionTypeDef:
return {
"Name": ...,
"Value": ...,
}
Definition
class DimensionTypeDef(TypedDict):
Name: str,
Value: str,
DimensionValueType: NotRequired[DimensionValueTypeType], # (1)
ListDatabasesRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListDatabasesRequestRequestTypeDef
def get_value() -> ListDatabasesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDatabasesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTablesRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListTablesRequestRequestTypeDef
def get_value() -> ListTablesRequestRequestTypeDef:
return {
"DatabaseName": ...,
}
Definition
class ListTablesRequestRequestTypeDef(TypedDict):
DatabaseName: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
S3ConfigurationTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import S3ConfigurationTypeDef
def get_value() -> S3ConfigurationTypeDef:
return {
"BucketName": ...,
}
Definition
class S3ConfigurationTypeDef(TypedDict):
BucketName: NotRequired[str],
ObjectKeyPrefix: NotRequired[str],
EncryptionOption: NotRequired[S3EncryptionOptionType], # (1)
KmsKeyId: NotRequired[str],
MeasureValueTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import MeasureValueTypeDef
def get_value() -> MeasureValueTypeDef:
return {
"Name": ...,
"Value": ...,
"Type": ...,
}
Definition
class MeasureValueTypeDef(TypedDict):
Name: str,
Value: str,
Type: MeasureValueTypeType, # (1)
RecordsIngestedTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import RecordsIngestedTypeDef
def get_value() -> RecordsIngestedTypeDef:
return {
"Total": ...,
}
Definition
class RecordsIngestedTypeDef(TypedDict):
Total: NotRequired[int],
MemoryStore: NotRequired[int],
MagneticStore: NotRequired[int],
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateDatabaseRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import UpdateDatabaseRequestRequestTypeDef
def get_value() -> UpdateDatabaseRequestRequestTypeDef:
return {
"DatabaseName": ...,
"KmsKeyId": ...,
}
CreateDatabaseRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import CreateDatabaseRequestRequestTypeDef
def get_value() -> CreateDatabaseRequestRequestTypeDef:
return {
"DatabaseName": ...,
}
Definition
class CreateDatabaseRequestRequestTypeDef(TypedDict):
DatabaseName: str,
KmsKeyId: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateDatabaseResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import CreateDatabaseResponseTypeDef
def get_value() -> CreateDatabaseResponseTypeDef:
return {
"Database": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDatabaseResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DescribeDatabaseResponseTypeDef
def get_value() -> DescribeDatabaseResponseTypeDef:
return {
"Database": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDatabasesResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListDatabasesResponseTypeDef
def get_value() -> ListDatabasesResponseTypeDef:
return {
"Databases": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatabasesResponseTypeDef(TypedDict):
Databases: List[DatabaseTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
UpdateDatabaseResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import UpdateDatabaseResponseTypeDef
def get_value() -> UpdateDatabaseResponseTypeDef:
return {
"Database": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeEndpointsResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DescribeEndpointsResponseTypeDef
def get_value() -> DescribeEndpointsResponseTypeDef:
return {
"Endpoints": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEndpointsResponseTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MagneticStoreRejectedDataLocationTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import MagneticStoreRejectedDataLocationTypeDef
def get_value() -> MagneticStoreRejectedDataLocationTypeDef:
return {
"S3Configuration": ...,
}
Definition
class MagneticStoreRejectedDataLocationTypeDef(TypedDict):
S3Configuration: NotRequired[S3ConfigurationTypeDef], # (1)
RecordTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import RecordTypeDef
def get_value() -> RecordTypeDef:
return {
"Dimensions": ...,
}
Definition
class RecordTypeDef(TypedDict):
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
MeasureName: NotRequired[str],
MeasureValue: NotRequired[str],
MeasureValueType: NotRequired[MeasureValueTypeType], # (2)
Time: NotRequired[str],
TimeUnit: NotRequired[TimeUnitType], # (3)
Version: NotRequired[int],
MeasureValues: NotRequired[Sequence[MeasureValueTypeDef]], # (4)
- See DimensionTypeDef
- See MeasureValueTypeType
- See TimeUnitType
- See MeasureValueTypeDef
WriteRecordsResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import WriteRecordsResponseTypeDef
def get_value() -> WriteRecordsResponseTypeDef:
return {
"RecordsIngested": ...,
"ResponseMetadata": ...,
}
Definition
class WriteRecordsResponseTypeDef(TypedDict):
RecordsIngested: RecordsIngestedTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MagneticStoreWritePropertiesTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import MagneticStoreWritePropertiesTypeDef
def get_value() -> MagneticStoreWritePropertiesTypeDef:
return {
"EnableMagneticStoreWrites": ...,
}
Definition
class MagneticStoreWritePropertiesTypeDef(TypedDict):
EnableMagneticStoreWrites: bool,
MagneticStoreRejectedDataLocation: NotRequired[MagneticStoreRejectedDataLocationTypeDef], # (1)
WriteRecordsRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import WriteRecordsRequestRequestTypeDef
def get_value() -> WriteRecordsRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
"Records": ...,
}
Definition
class WriteRecordsRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
Records: Sequence[RecordTypeDef], # (1)
CommonAttributes: NotRequired[RecordTypeDef], # (2)
- See RecordTypeDef
- See RecordTypeDef
CreateTableRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import CreateTableRequestRequestTypeDef
def get_value() -> CreateTableRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
}
Definition
class CreateTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
RetentionProperties: NotRequired[RetentionPropertiesTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
MagneticStoreWriteProperties: NotRequired[MagneticStoreWritePropertiesTypeDef], # (3)
TableTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import TableTypeDef
def get_value() -> TableTypeDef:
return {
"Arn": ...,
}
Definition
class TableTypeDef(TypedDict):
Arn: NotRequired[str],
TableName: NotRequired[str],
DatabaseName: NotRequired[str],
TableStatus: NotRequired[TableStatusType], # (1)
RetentionProperties: NotRequired[RetentionPropertiesTypeDef], # (2)
CreationTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
MagneticStoreWriteProperties: NotRequired[MagneticStoreWritePropertiesTypeDef], # (3)
UpdateTableRequestRequestTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import UpdateTableRequestRequestTypeDef
def get_value() -> UpdateTableRequestRequestTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
}
Definition
class UpdateTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
RetentionProperties: NotRequired[RetentionPropertiesTypeDef], # (1)
MagneticStoreWriteProperties: NotRequired[MagneticStoreWritePropertiesTypeDef], # (2)
CreateTableResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import CreateTableResponseTypeDef
def get_value() -> CreateTableResponseTypeDef:
return {
"Table": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
DescribeTableResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import DescribeTableResponseTypeDef
def get_value() -> DescribeTableResponseTypeDef:
return {
"Table": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
ListTablesResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import ListTablesResponseTypeDef
def get_value() -> ListTablesResponseTypeDef:
return {
"Tables": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTablesResponseTypeDef(TypedDict):
Tables: List[TableTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
UpdateTableResponseTypeDef
Usage Example
from types_aiobotocore_timestream_write.type_defs import UpdateTableResponseTypeDef
def get_value() -> UpdateTableResponseTypeDef:
return {
"Table": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef