Skip to content

Type definitions#

Index > TimestreamWrite > Type definitions

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

SchemaUnionTypeDef#

# SchemaUnionTypeDef definition

SchemaUnionTypeDef = Union[
    SchemaTypeDef,  # (1)
    SchemaOutputTypeDef,  # (2)
]
  1. See SchemaTypeDef
  2. See SchemaOutputTypeDef

DataModelConfigurationUnionTypeDef#

# DataModelConfigurationUnionTypeDef definition

DataModelConfigurationUnionTypeDef = Union[
    DataModelConfigurationTypeDef,  # (1)
    DataModelConfigurationOutputTypeDef,  # (2)
]
  1. See DataModelConfigurationTypeDef
  2. See DataModelConfigurationOutputTypeDef

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],
  1. See BatchLoadStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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)
  1. See DimensionValueTypeType

ListBatchLoadTasksRequestRequestTypeDef#

# ListBatchLoadTasksRequestRequestTypeDef definition

class ListBatchLoadTasksRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    TaskStatus: NotRequired[BatchLoadStatusType],  # (1)
  1. See BatchLoadStatusType

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],
  1. See S3EncryptionOptionType

MeasureValueTypeDef#

# MeasureValueTypeDef definition

class MeasureValueTypeDef(TypedDict):
    Name: str,
    Value: str,
    Type: MeasureValueTypeType,  # (1)
  1. See MeasureValueTypeType

MultiMeasureAttributeMappingTypeDef#

# MultiMeasureAttributeMappingTypeDef definition

class MultiMeasureAttributeMappingTypeDef(TypedDict):
    SourceColumn: str,
    TargetMultiMeasureAttributeName: NotRequired[str],
    MeasureValueType: NotRequired[ScalarMeasureValueTypeType],  # (1)
  1. See ScalarMeasureValueTypeType

PartitionKeyTypeDef#

# PartitionKeyTypeDef definition

class PartitionKeyTypeDef(TypedDict):
    Type: PartitionKeyTypeType,  # (1)
    Name: NotRequired[str],
    EnforcementInRecord: NotRequired[PartitionKeyEnforcementLevelType],  # (2)
  1. See PartitionKeyTypeType
  2. See PartitionKeyEnforcementLevelType

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],
  1. See S3EncryptionOptionType

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)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)