Skip to content

Type definitions#

Index > TimestreamQuery > Type definitions

Auto-generated documentation for TimestreamQuery type annotations stubs module mypy-boto3-timestream-query.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TargetConfigurationUnionTypeDef#

# TargetConfigurationUnionTypeDef definition

TargetConfigurationUnionTypeDef = Union[
    TargetConfigurationTypeDef,  # (1)
    TargetConfigurationOutputTypeDef,  # (2)
]
  1. See TargetConfigurationTypeDef
  2. See TargetConfigurationOutputTypeDef

CancelQueryRequestRequestTypeDef#

# CancelQueryRequestRequestTypeDef definition

class CancelQueryRequestRequestTypeDef(TypedDict):
    QueryId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ColumnInfoTypeDef#

# ColumnInfoTypeDef definition

class ColumnInfoTypeDef(TypedDict):
    Type: TypeTypeDef,  # (1)
    Name: NotRequired[str],
  1. See TypeTypeDef

ScheduleConfigurationTypeDef#

# ScheduleConfigurationTypeDef definition

class ScheduleConfigurationTypeDef(TypedDict):
    ScheduleExpression: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

RowTypeDef#

# RowTypeDef definition

class RowTypeDef(TypedDict):
    Data: List[DatumTypeDef],  # (1)
  1. See DatumTypeDef

TimeSeriesDataPointTypeDef#

# TimeSeriesDataPointTypeDef definition

class TimeSeriesDataPointTypeDef(TypedDict):
    Time: str,
    Value: DatumTypeDef,  # (1)
  1. See DatumTypeDef

DeleteScheduledQueryRequestRequestTypeDef#

# DeleteScheduledQueryRequestRequestTypeDef definition

class DeleteScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    Address: str,
    CachePeriodInMinutes: int,

DescribeScheduledQueryRequestRequestTypeDef#

# DescribeScheduledQueryRequestRequestTypeDef definition

class DescribeScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,

DimensionMappingTypeDef#

# DimensionMappingTypeDef definition

class DimensionMappingTypeDef(TypedDict):
    Name: str,
    DimensionValueType: DimensionValueTypeType,  # (1)
  1. See DimensionValueTypeType

S3ConfigurationTypeDef#

# S3ConfigurationTypeDef definition

class S3ConfigurationTypeDef(TypedDict):
    BucketName: str,
    ObjectKeyPrefix: NotRequired[str],
    EncryptionOption: NotRequired[S3EncryptionOptionType],  # (1)
  1. See S3EncryptionOptionType

S3ReportLocationTypeDef#

# S3ReportLocationTypeDef definition

class S3ReportLocationTypeDef(TypedDict):
    BucketName: NotRequired[str],
    ObjectKey: NotRequired[str],

ExecutionStatsTypeDef#

# ExecutionStatsTypeDef definition

class ExecutionStatsTypeDef(TypedDict):
    ExecutionTimeInMillis: NotRequired[int],
    DataWrites: NotRequired[int],
    BytesMetered: NotRequired[int],
    CumulativeBytesScanned: NotRequired[int],
    RecordsIngested: NotRequired[int],
    QueryResultRows: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListScheduledQueriesRequestRequestTypeDef#

# ListScheduledQueriesRequestRequestTypeDef definition

class ListScheduledQueriesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MultiMeasureAttributeMappingTypeDef#

# MultiMeasureAttributeMappingTypeDef definition

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

SnsConfigurationTypeDef#

# SnsConfigurationTypeDef definition

class SnsConfigurationTypeDef(TypedDict):
    TopicArn: str,

ParameterMappingTypeDef#

# ParameterMappingTypeDef definition

class ParameterMappingTypeDef(TypedDict):
    Name: str,
    Type: TypeTypeDef,  # (1)
  1. See TypeTypeDef

PrepareQueryRequestRequestTypeDef#

# PrepareQueryRequestRequestTypeDef definition

class PrepareQueryRequestRequestTypeDef(TypedDict):
    QueryString: str,
    ValidateOnly: NotRequired[bool],

SelectColumnTypeDef#

# SelectColumnTypeDef definition

class SelectColumnTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[TypeTypeDef],  # (1)
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Aliased: NotRequired[bool],
  1. See TypeTypeDef

QueryRequestRequestTypeDef#

# QueryRequestRequestTypeDef definition

class QueryRequestRequestTypeDef(TypedDict):
    QueryString: str,
    ClientToken: NotRequired[str],
    NextToken: NotRequired[str],
    MaxRows: NotRequired[int],

QueryStatusTypeDef#

# QueryStatusTypeDef definition

class QueryStatusTypeDef(TypedDict):
    ProgressPercentage: NotRequired[float],
    CumulativeBytesScanned: NotRequired[int],
    CumulativeBytesMetered: NotRequired[int],

TimestreamDestinationTypeDef#

# TimestreamDestinationTypeDef definition

class TimestreamDestinationTypeDef(TypedDict):
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],

TypeTypeDef#

# TypeTypeDef definition

class TypeTypeDef(TypedDict):
    ScalarType: NotRequired[ScalarTypeType],  # (1)
    ArrayColumnInfo: NotRequired[Dict[str, Any]],
    TimeSeriesMeasureValueColumnInfo: NotRequired[Dict[str, Any]],
    RowColumnInfo: NotRequired[List[Dict[str, Any]]],
  1. See ScalarTypeType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateAccountSettingsRequestRequestTypeDef#

# UpdateAccountSettingsRequestRequestTypeDef definition

class UpdateAccountSettingsRequestRequestTypeDef(TypedDict):
    MaxQueryTCU: NotRequired[int],
    QueryPricingModel: NotRequired[QueryPricingModelType],  # (1)
  1. See QueryPricingModelType

UpdateScheduledQueryRequestRequestTypeDef#

# UpdateScheduledQueryRequestRequestTypeDef definition

class UpdateScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,
    State: ScheduledQueryStateType,  # (1)
  1. See ScheduledQueryStateType

CancelQueryResponseTypeDef#

# CancelQueryResponseTypeDef definition

class CancelQueryResponseTypeDef(TypedDict):
    CancellationMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateScheduledQueryResponseTypeDef#

# CreateScheduledQueryResponseTypeDef definition

class CreateScheduledQueryResponseTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountSettingsResponseTypeDef#

# DescribeAccountSettingsResponseTypeDef definition

class DescribeAccountSettingsResponseTypeDef(TypedDict):
    MaxQueryTCU: int,
    QueryPricingModel: QueryPricingModelType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryPricingModelType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

UpdateAccountSettingsResponseTypeDef#

# UpdateAccountSettingsResponseTypeDef definition

class UpdateAccountSettingsResponseTypeDef(TypedDict):
    MaxQ