Type definitions#
Index > TimestreamWrite > Type definitions
Auto-generated documentation for TimestreamWrite type annotations stubs module mypy-boto3-timestream-write.
BatchLoadProgressReportTypeDef#
# BatchLoadProgressReportTypeDef definition
class BatchLoadProgressReportTypeDef(TypedDict):
RecordsProcessed: NotRequired[int],
RecordsIngested: NotRequired[int],
ParseFailures: NotRequired[int],
RecordIngestionFailures: NotRequired[int],
FileFailures: NotRequired[int],
BytesMetered: NotRequired[int],
BatchLoadTaskTypeDef#
# BatchLoadTaskTypeDef definition
class BatchLoadTaskTypeDef(TypedDict):
TaskId: NotRequired[str],
TaskStatus: NotRequired[BatchLoadStatusType], # (1)
DatabaseName: NotRequired[str],
TableName: NotRequired[str],
CreationTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ResumableUntil: NotRequired[datetime],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
DatabaseTypeDef#
# DatabaseTypeDef definition
class DatabaseTypeDef(TypedDict):
Arn: NotRequired[str],
DatabaseName: NotRequired[str],
TableCount: NotRequired[int],
KmsKeyId: NotRequired[str],
CreationTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
RetentionPropertiesTypeDef#
# RetentionPropertiesTypeDef definition
class RetentionPropertiesTypeDef(TypedDict):
MemoryStoreRetentionPeriodInHours: int,
MagneticStoreRetentionPeriodInDays: int,
CsvConfigurationTypeDef#
# CsvConfigurationTypeDef definition
class CsvConfigurationTypeDef(TypedDict):
ColumnSeparator: NotRequired[str],
EscapeChar: NotRequired[str],
QuoteChar: NotRequired[str],
NullValue: NotRequired[str],
TrimWhiteSpace: NotRequired[bool],
DataModelS3ConfigurationTypeDef#
# DataModelS3ConfigurationTypeDef definition
class DataModelS3ConfigurationTypeDef(TypedDict):
BucketName: NotRequired[str],
ObjectKey: NotRequired[str],
DimensionMappingTypeDef#
# DimensionMappingTypeDef definition
class DimensionMappingTypeDef(TypedDict):
SourceColumn: NotRequired[str],
DestinationColumn: NotRequired[str],
DataSourceS3ConfigurationTypeDef#
# DataSourceS3ConfigurationTypeDef definition
class DataSourceS3ConfigurationTypeDef(TypedDict):
BucketName: str,
ObjectKeyPrefix: NotRequired[str],
DeleteDatabaseRequestRequestTypeDef#
# DeleteDatabaseRequestRequestTypeDef definition
class DeleteDatabaseRequestRequestTypeDef(TypedDict):
DatabaseName: str,
DeleteTableRequestRequestTypeDef#
# DeleteTableRequestRequestTypeDef definition
class DeleteTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
DescribeBatchLoadTaskRequestRequestTypeDef#
# DescribeBatchLoadTaskRequestRequestTypeDef definition
class DescribeBatchLoadTaskRequestRequestTypeDef(TypedDict):
TaskId: str,
DescribeDatabaseRequestRequestTypeDef#
# DescribeDatabaseRequestRequestTypeDef definition
class DescribeDatabaseRequestRequestTypeDef(TypedDict):
DatabaseName: str,
EndpointTypeDef#
# EndpointTypeDef definition
class EndpointTypeDef(TypedDict):
Address: str,
CachePeriodInMinutes: int,
DescribeTableRequestRequestTypeDef#
# DescribeTableRequestRequestTypeDef definition
class DescribeTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
DimensionTypeDef#
# DimensionTypeDef definition
class DimensionTypeDef(TypedDict):
Name: str,
Value: str,
DimensionValueType: NotRequired[DimensionValueTypeType], # (1)
ListBatchLoadTasksRequestRequestTypeDef#
# ListBatchLoadTasksRequestRequestTypeDef definition
class ListBatchLoadTasksRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
TaskStatus: NotRequired[BatchLoadStatusType], # (1)
ListDatabasesRequestRequestTypeDef#
# ListDatabasesRequestRequestTypeDef definition
class ListDatabasesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTablesRequestRequestTypeDef#
# ListTablesRequestRequestTypeDef definition
class ListTablesRequestRequestTypeDef(TypedDict):
DatabaseName: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
S3ConfigurationTypeDef#
# S3ConfigurationTypeDef definition
class S3ConfigurationTypeDef(TypedDict):
BucketName: NotRequired[str],
ObjectKeyPrefix: NotRequired[str],
EncryptionOption: NotRequired[S3EncryptionOptionType], # (1)
KmsKeyId: NotRequired[str],
MeasureValueTypeDef#
# MeasureValueTypeDef definition
class MeasureValueTypeDef(TypedDict):
Name: str,
Value: str,
Type: MeasureValueTypeType, # (1)
MultiMeasureAttributeMappingTypeDef#
# MultiMeasureAttributeMappingTypeDef definition
class MultiMeasureAttributeMappingTypeDef(TypedDict):
SourceColumn: str,
TargetMultiMeasureAttributeName: NotRequired[str],
MeasureValueType: NotRequired[ScalarMeasureValueTypeType], # (1)
PartitionKeyTypeDef#
# PartitionKeyTypeDef definition
class PartitionKeyTypeDef(TypedDict):
Type: PartitionKeyTypeType, # (1)
Name: NotRequired[str],
EnforcementInRecord: NotRequired[PartitionKeyEnforcementLevelType], # (2)
RecordsIngestedTypeDef#
# RecordsIngestedTypeDef definition
class RecordsIngestedTypeDef(TypedDict):
Total: NotRequired[int],
MemoryStore: NotRequired[int],
MagneticStore: NotRequired[int],
ReportS3ConfigurationTypeDef#
# ReportS3ConfigurationTypeDef definition
class ReportS3ConfigurationTypeDef(TypedDict):
BucketName: str,
ObjectKeyPrefix: NotRequired[str],
EncryptionOption: NotRequired[S3EncryptionOptionType], # (1)
KmsKeyId: NotRequired[str],
ResumeBatchLoadTaskRequestRequestTypeDef#
# ResumeBatchLoadTaskRequestRequestTypeDef definition
class ResumeBatchLoadTaskRequestRequestTypeDef(TypedDict):
TaskId: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateDatabaseRequestRequestTypeDef#
# UpdateDatabaseRequestRequestTypeDef definition
class UpdateDatabaseRequestRequestTypeDef(TypedDict):
DatabaseName: str,
KmsKeyId: str,
CreateBatchLoadTaskResponseTypeDef#
# CreateBatchLoadTaskResponseTypeDef definition
class CreateBatchLoadTaskResponseTypeDef(TypedDict):
TaskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListBatchLoadTasksResponseTypeDef#
# ListBatchLoadTasksResponseTypeDef definition
class ListBatchLoadTasksResponseTypeDef(TypedDict):
NextToken: str,
BatchLoadTasks: List[BatchLoadTaskTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDatabaseRequestRequestTypeDef#
# CreateDatabaseRequestRequestTypeDef definition
class CreateDatabaseRequestRequestTypeDef(TypedDict):
DatabaseName: str,
KmsKeyId: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateDatabaseResponseTypeDef#
# CreateDatabaseResponseTypeDef definition
class CreateDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDatabaseResponseTypeDef#
# DescribeDatabaseResponseTypeDef definition
class DescribeDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatabasesResponseTypeDef#
# ListDatabasesResponseTypeDef definition
class ListDatabasesResponseTypeDef(TypedDict):
Databases: List[DatabaseTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDatabaseResponseTypeDef#
# UpdateDatabaseResponseTypeDef definition
class UpdateDatabaseResponseTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DataSourceConfigurationTypeDef#
# DataSourceConfigurationTypeDef definition
class DataSourceConfigurationTypeDef(TypedDict):
DataSourceS3Configuration: DataSourceS3ConfigurationTypeDef, # (1)
DataFormat: BatchLoadDataFormatType, # (3)
CsvConfiguration: NotRequired[CsvConfigurationTypeDef], # (2)
DescribeEndpointsResponseTypeDef#
# DescribeEndpointsResponseTypeDef definition
class DescribeEndpointsResponseTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MagneticStoreRejectedDataLocationTypeDef#
# MagneticStoreRejectedDataLocationTypeDef definition
class MagneticStoreRejectedDataLocationTypeDef(TypedDict):
S3Configuration: NotRequired[S3ConfigurationTypeDef], # (1)
RecordTypeDef#
# RecordTypeDef 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
MixedMeasureMappingTypeDef#
# MixedMeasureMappingTypeDef definition
class MixedMeasureMappingTypeDef(TypedDict):
MeasureValueType: MeasureValueTypeType, # (1)
MeasureName: NotRequired[str],
SourceColumn: NotRequired[str],
TargetMeasureName: NotRequired[str],
MultiMeasureAttributeMappings: NotRequired[Sequence[MultiMeasureAttributeMappingTypeDef]], # (2)
MultiMeasureMappingsTypeDef#
# MultiMeasureMappingsTypeDef definition
class MultiMeasureMappingsTypeDef(TypedDict):
MultiMeasureAttributeMappings: Sequence[MultiMeasureAttributeMappingTypeDef], # (1)
TargetMultiMeasureName: NotRequired[str],
SchemaTypeDef#
# SchemaTypeDef definition
class SchemaTypeDef(TypedDict):
CompositePartitionKey: NotRequired[Sequence[PartitionKeyTypeDef]], # (1)
WriteRecordsResponseTypeDef#
# WriteRecordsResponseTypeDef definition
class WriteRecordsResponseTypeDef(TypedDict):
RecordsIngested: RecordsIngestedTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReportConfigurationTypeDef#
# ReportConfigurationTypeDef definition
class ReportConfigurationTypeDef(TypedDict):
ReportS3Configuration: NotRequired[ReportS3ConfigurationTypeDef], # (1)
MagneticStoreWritePropertiesTypeDef#
# MagneticStoreWritePropertiesTypeDef definition
class MagneticStoreWritePropertiesTypeDef(TypedDict):
EnableMagneticStoreWrites: bool,
MagneticStoreRejectedDataLocation: NotRequired[MagneticStoreRejectedDataLocationTypeDef], # (1)
WriteRecordsRequestRequestTypeDef#
# WriteRecordsRequestRequestTypeDef definition
class WriteRecordsRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
Records: Sequence[RecordTypeDef], # (1)
CommonAttributes: NotRequired[RecordTypeDef], # (2)
- See RecordTypeDef
- See RecordTypeDef
DataModelTypeDef#
# DataModelTypeDef definition
class DataModelTypeDef(TypedDict):
DimensionMappings: Sequence[DimensionMappingTypeDef], # (2)
TimeColumn: NotRequired[str],
TimeUnit: NotRequired[TimeUnitType], # (1)
MultiMeasureMappings: NotRequired[MultiMeasureMappingsTypeDef], # (3)
MixedMeasureMappings: NotRequired[Sequence[MixedMeasureMappingTypeDef]], # (4)
MeasureNameColumn: NotRequired[str],
- See TimeUnitType
- See DimensionMappingTypeDef
- See MultiMeasureMappingsTypeDef
- See MixedMeasureMappingTypeDef
CreateTableRequestRequestTypeDef#
# CreateTableRequestRequestTypeDef definition
class CreateTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
RetentionProperties: NotRequired[RetentionPropertiesTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
MagneticStoreWriteProperties: NotRequired[MagneticStoreWritePropertiesTypeDef], # (3)
Schema: NotRequired[SchemaTypeDef], # (4)
- See RetentionPropertiesTypeDef
- See TagTypeDef
- See MagneticStoreWritePropertiesTypeDef
- See SchemaTypeDef
TableTypeDef#
# TableTypeDef 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)
Schema: NotRequired[SchemaTypeDef], # (4)
- See TableStatusType
- See RetentionPropertiesTypeDef
- See MagneticStoreWritePropertiesTypeDef
- See SchemaTypeDef
UpdateTableRequestRequestTypeDef#
# UpdateTableRequestRequestTypeDef definition
class UpdateTableRequestRequestTypeDef(TypedDict):
DatabaseName: str,
TableName: str,
RetentionProperties: NotRequired[RetentionPropertiesTypeDef], # (1)
MagneticStoreWriteProperties: NotRequired[MagneticStoreWritePropertiesTypeDef], # (2)
Schema: NotRequired[SchemaTypeDef], # (3)
DataModelConfigurationTypeDef#
# DataModelConfigurationTypeDef definition
class DataModelConfigurationTypeDef(TypedDict):
DataModel: NotRequired[DataModelTypeDef], # (1)
DataModelS3Configuration: NotRequired[DataModelS3ConfigurationTypeDef], # (2)
CreateTableResponseTypeDef#
# CreateTableResponseTypeDef definition
class CreateTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
DescribeTableResponseTypeDef#
# DescribeTableResponseTypeDef definition
class DescribeTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
ListTablesResponseTypeDef#
# ListTablesResponseTypeDef definition
class ListTablesResponseTypeDef(TypedDict):
Tables: List[TableTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
UpdateTableResponseTypeDef#
# UpdateTableResponseTypeDef definition
class UpdateTableResponseTypeDef(TypedDict):
Table: TableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TableTypeDef
- See ResponseMetadataTypeDef
BatchLoadTaskDescriptionTypeDef#
# BatchLoadTaskDescriptionTypeDef definition
class BatchLoadTaskDescriptionTypeDef(TypedDict):
TaskId: NotRequired[str],
ErrorMessage: NotRequired[str],
DataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef], # (1)
ProgressReport: NotRequired[BatchLoadProgressReportTypeDef], # (2)
ReportConfiguration: NotRequired[ReportConfigurationTypeDef], # (3)
DataModelConfiguration: NotRequired[DataModelConfigurationTypeDef], # (4)
TargetDatabaseName: NotRequired[str],
TargetTableName: NotRequired[str],
TaskStatus: NotRequired[BatchLoadStatusType], # (5)
RecordVersion: NotRequired[int],
CreationTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ResumableUntil: NotRequired[datetime],
- See DataSourceConfigurationTypeDef
- See BatchLoadProgressReportTypeDef
- See ReportConfigurationTypeDef
- See DataModelConfigurationTypeDef
- See BatchLoadStatusType
CreateBatchLoadTaskRequestRequestTypeDef#
# CreateBatchLoadTaskRequestRequestTypeDef definition
class CreateBatchLoadTaskRequestRequestTypeDef(TypedDict):
DataSourceConfiguration: DataSourceConfigurationTypeDef, # (1)
ReportConfiguration: ReportConfigurationTypeDef, # (2)
TargetDatabaseName: str,
TargetTableName: str,
ClientToken: NotRequired[str],
DataModelConfiguration: NotRequired[DataModelConfigurationTypeDef], # (3)
RecordVersion: NotRequired[int],
DescribeBatchLoadTaskResponseTypeDef#
# DescribeBatchLoadTaskResponseTypeDef definition
class DescribeBatchLoadTaskResponseTypeDef(TypedDict):
BatchLoadTaskDescription: BatchLoadTaskDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)