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,
]

CancelQueryRequestRequestTypeDef#

# CancelQueryRequestRequestTypeDef definition

class CancelQueryRequestRequestTypeDef(TypedDict):
    QueryId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

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],
    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],

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

DatumTypeDef#

# DatumTypeDef definition

class DatumTypeDef(TypedDict):
    ScalarValue: NotRequired[str],
    TimeSeriesValue: NotRequired[List[Dict[str, Any]]],
    ArrayValue: NotRequired[List[Dict[str, Any]]],
    RowValue: NotRequired[Dict[str, Any]],
    NullValue: NotRequired[bool],

DescribeEndpointsResponseTypeDef#

# DescribeEndpointsResponseTypeDef definition

class DescribeEndpointsResponseTypeDef(TypedDict):
    Endpoints: List[EndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EndpointTypeDef
  2. See ResponseMetadataTypeDef

ErrorReportConfigurationTypeDef#

# ErrorReportConfigurationTypeDef definition

class ErrorReportConfigurationTypeDef(TypedDict):
    S3Configuration: S3ConfigurationTypeDef,  # (1)
  1. See S3ConfigurationTypeDef

ErrorReportLocationTypeDef#

# ErrorReportLocationTypeDef definition

class ErrorReportLocationTypeDef(TypedDict):
    S3ReportLocation: NotRequired[S3ReportLocationTypeDef],  # (1)
  1. See S3ReportLocationTypeDef

ExecuteScheduledQueryRequestRequestTypeDef#

# ExecuteScheduledQueryRequestRequestTypeDef definition

class ExecuteScheduledQueryRequestRequestTypeDef(TypedDict):
    ScheduledQueryArn: str,
    InvocationTime: Union[datetime, str],
    ClientToken: NotRequired[str],

ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef#

# ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef definition

class ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

QueryRequestQueryPaginateTypeDef#

# QueryRequestQueryPaginateTypeDef definition

class QueryRequestQueryPaginateTypeDef(TypedDict):
    QueryString: str,
    ClientToken: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

MixedMeasureMappingTypeDef#

# MixedMeasureMappingTypeDef definition

class MixedMeasureMappingTypeDef(TypedDict):
    MeasureValueType: MeasureValueTypeType,  # (1)
    MeasureName: NotRequired[str],
    SourceColumn: NotRequired[str],
    TargetMeasureName: NotRequired[str],
    MultiMeasureAttributeMappings: NotRequired[Sequence[MultiMeasureAttributeMappingTypeDef]],  # (2)
  1. See MeasureValueTypeType
  2. See MultiMeasureAttributeMappingTypeDef

MultiMeasureMappingsTypeDef#

# MultiMeasureMappingsTypeDef definition

class MultiMeasureMappingsTypeDef(TypedDict):
    MultiMeasureAttributeMappings: Sequence[MultiMeasureAttributeMappingTypeDef],  # (1)
    TargetMultiMeasureName: NotRequired[str],
  1. See MultiMeasureAttributeMappingTypeDef

NotificationConfigurationTypeDef#

# NotificationConfigurationTypeDef definition

class NotificationConfigurationTypeDef(TypedDict):
    SnsConfiguration: SnsConfigurationTypeDef,  # (1)
  1. See SnsConfigurationTypeDef

PrepareQueryResponseTypeDef#

# PrepareQueryResponseTypeDef definition

class PrepareQueryResponseTypeDef(TypedDict):
    QueryString: str,
    Columns: List[SelectColumnTypeDef],  # (1)
    Parameters: List[ParameterMappingTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SelectColumnTypeDef
  2. See ParameterMappingTypeDef
  3. See ResponseMetadataTypeDef

QueryResponseTypeDef#

# QueryResponseTypeDef definition

class QueryResponseTypeDef(TypedDict):
    QueryId: str,
    NextToken: str,
    Rows: List[RowTypeDef],  # (1)
    ColumnInfo: List[ColumnInfoTypeDef],  # (2)
    QueryStatus: QueryStatusTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See RowTypeDef
  2. See ColumnInfoTypeDef
  3. See QueryStatusTypeDef
  4. See ResponseMetadataTypeDef

TargetDestinationTypeDef#

# TargetDestinationTypeDef definition

class TargetDestinationTypeDef(TypedDict):
    TimestreamDestination: NotRequired[TimestreamDestinationTypeDef],  # (1)
  1. See TimestreamDestinationTypeDef

ScheduledQueryRunSummaryTypeDef#

# ScheduledQueryRunSummaryTypeDef definition

class ScheduledQueryRunSummaryTypeDef(TypedDict):
    InvocationTime: NotRequired[datetime],
    TriggerTime: NotRequired[datetime],
    RunStatus: NotRequired[ScheduledQueryRunStatusType],  # (1)
    ExecutionStats: NotRequired[ExecutionStatsTypeDef],  # (2)
    ErrorReportLocation: NotRequired[ErrorReportLocationTypeDef],  # (3)
    FailureReason: NotRequired[str],
  1. See ScheduledQueryRunStatusType
  2. See ExecutionStatsTypeDef
  3. See ErrorReportLocationTypeDef

TimestreamConfigurationTypeDef#

# TimestreamConfigurationTypeDef definition

class TimestreamConfigurationTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    TimeColumn: str,
    DimensionMappings: Sequence[DimensionMappingTypeDef],  # (1)
    MultiMeasureMappings: NotRequired[MultiMeasureMappingsTypeDef],  # (2)
    MixedMeasureMappings: NotRequired[Sequence[MixedMeasureMappingTypeDef]],  # (3)
    MeasureNameColumn: NotRequired[str],
  1. See DimensionMappingTypeDef
  2. See MultiMeasureMappingsTypeDef
  3. See MixedMeasureMappingTypeDef

ScheduledQueryTypeDef#

# ScheduledQueryTypeDef definition

class ScheduledQueryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    State: ScheduledQueryStateType,  # (1)
    CreationTime: NotRequired[datetime],
    PreviousInvocationTime: NotRequired[datetime],
    NextInvocationTime: NotRequired[datetime],
    ErrorReportConfiguration: NotRequired[ErrorReportConfigurationTypeDef],  # (2)
    TargetDestination: NotRequired[TargetDestinationTypeDef],  # (3)
    LastRunStatus: NotRequired[ScheduledQueryRunStatusType],  # (4)
  1. See ScheduledQueryStateType
  2. See ErrorReportConfigurationTypeDef
  3. See TargetDestinationTypeDef
  4. See ScheduledQueryRunStatusType

TargetConfigurationTypeDef#

# TargetConfigurationTypeDef definition

class TargetConfigurationTypeDef(TypedDict):
    TimestreamConfiguration: TimestreamConfigurationTypeDef,  # (1)
  1. See TimestreamConfigurationTypeDef

ListScheduledQueriesResponseTypeDef#

# ListScheduledQueriesResponseTypeDef definition

class ListScheduledQueriesResponseTypeDef(TypedDict):
    ScheduledQueries: List[ScheduledQueryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledQueryTypeDef
  2. See ResponseMetadataTypeDef

CreateScheduledQueryRequestRequestTypeDef#

# CreateScheduledQueryRequestRequestTypeDef definition

class CreateScheduledQueryRequestRequestTypeDef(TypedDict):
    Name: str,
    QueryString: str,
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (1)
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (2)
    ScheduledQueryExecutionRoleArn: str,
    ErrorReportConfiguration: ErrorReportConfigurationTypeDef,  # (3)
    TargetConfiguration: NotRequired[TargetConfigurationTypeDef],  # (4)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
    KmsKeyId: NotRequired[str],
  1. See ScheduleConfigurationTypeDef
  2. See NotificationConfigurationTypeDef
  3. See ErrorReportConfigurationTypeDef
  4. See TargetConfigurationTypeDef
  5. See TagTypeDef

ScheduledQueryDescriptionTypeDef#

# ScheduledQueryDescriptionTypeDef definition

class ScheduledQueryDescriptionTypeDef(TypedDict):
    Arn: str,
    Name: str,
    QueryString: str,
    State: ScheduledQueryStateType,  # (1)
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (2)
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (3)
    CreationTime: NotRequired[datetime],
    PreviousInvocationTime: NotRequired[datetime],
    NextInvocationTime: NotRequired[datetime],
    TargetConfiguration: NotRequired[TargetConfigurationTypeDef],  # (4)
    ScheduledQueryExecutionRoleArn: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ErrorReportConfiguration: NotRequired[ErrorReportConfigurationTypeDef],  # (5)
    LastRunSummary: NotRequired[ScheduledQueryRunSummaryTypeDef],  # (6)
    RecentlyFailedRuns: NotRequired[List[ScheduledQueryRunSummaryTypeDef]],  # (7)
  1. See ScheduledQueryStateType
  2. See ScheduleConfigurationTypeDef
  3. See NotificationConfigurationTypeDef
  4. See TargetConfigurationTypeDef
  5. See ErrorReportConfigurationTypeDef
  6. See ScheduledQueryRunSummaryTypeDef
  7. See ScheduledQueryRunSummaryTypeDef

DescribeScheduledQueryResponseTypeDef#

# DescribeScheduledQueryResponseTypeDef definition

class DescribeScheduledQueryResponseTypeDef(TypedDict):
    ScheduledQuery: ScheduledQueryDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduledQueryDescriptionTypeDef
  2. See ResponseMetadataTypeDef