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,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
ColumnInfoTypeDef#
# ColumnInfoTypeDef definition
class ColumnInfoTypeDef(TypedDict):
Type: TypeTypeDef, # (1)
Name: NotRequired[str],
- 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)
- See DatumTypeDef
TimeSeriesDataPointTypeDef#
# TimeSeriesDataPointTypeDef definition
class TimeSeriesDataPointTypeDef(TypedDict):
Time: str,
Value: DatumTypeDef, # (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)
S3ConfigurationTypeDef#
# S3ConfigurationTypeDef definition
class S3ConfigurationTypeDef(TypedDict):
BucketName: str,
ObjectKeyPrefix: NotRequired[str],
EncryptionOption: NotRequired[S3EncryptionOptionType], # (1)
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],
SnsConfigurationTypeDef#
# SnsConfigurationTypeDef definition
class SnsConfigurationTypeDef(TypedDict):
TopicArn: str,
ParameterMappingTypeDef#
# ParameterMappingTypeDef definition
class ParameterMappingTypeDef(TypedDict):
Name: str,
Type: TypeTypeDef, # (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],
- 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]]],
- See ScalarTypeType
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateScheduledQueryRequestRequestTypeDef#
# UpdateScheduledQueryRequestRequestTypeDef definition
class UpdateScheduledQueryRequestRequestTypeDef(TypedDict):
ScheduledQueryArn: str,
State: ScheduledQueryStateType, # (1)
CancelQueryResponseTypeDef#
# CancelQueryResponseTypeDef definition
class CancelQueryResponseTypeDef(TypedDict):
CancellationMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateScheduledQueryResponseTypeDef#
# CreateScheduledQueryResponseTypeDef definition
class CreateScheduledQueryResponseTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (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)
ErrorReportConfigurationTypeDef#
# ErrorReportConfigurationTypeDef definition
class ErrorReportConfigurationTypeDef(TypedDict):
S3Configuration: S3ConfigurationTypeDef, # (1)
ErrorReportLocationTypeDef#
# ErrorReportLocationTypeDef definition
class ErrorReportLocationTypeDef(TypedDict):
S3ReportLocation: NotRequired[S3ReportLocationTypeDef], # (1)
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)
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
ResourceARN: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryRequestQueryPaginateTypeDef#
# QueryRequestQueryPaginateTypeDef definition
class QueryRequestQueryPaginateTypeDef(TypedDict):
QueryString: str,
ClientToken: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
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],
NotificationConfigurationTypeDef#
# NotificationConfigurationTypeDef definition
class NotificationConfigurationTypeDef(TypedDict):
SnsConfiguration: SnsConfigurationTypeDef, # (1)
PrepareQueryResponseTypeDef#
# PrepareQueryResponseTypeDef definition
class PrepareQueryResponseTypeDef(TypedDict):
QueryString: str,
Columns: List[SelectColumnTypeDef], # (1)
Parameters: List[ParameterMappingTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
QueryResponseTypeDef#
# QueryResponseTypeDef definition
class QueryResponseTypeDef(TypedDict):
QueryId: str,
NextToken: str,
Rows: List[RowTypeDef], # (1)
ColumnInfo: List[ColumnInfoTypeDef], # (2)
QueryStatus: QueryStatusTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See RowTypeDef
- See ColumnInfoTypeDef
- See QueryStatusTypeDef
- See ResponseMetadataTypeDef
TargetDestinationTypeDef#
# TargetDestinationTypeDef definition
class TargetDestinationTypeDef(TypedDict):
TimestreamDestination: NotRequired[TimestreamDestinationTypeDef], # (1)
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],
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],
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)
- See ScheduledQueryStateType
- See ErrorReportConfigurationTypeDef
- See TargetDestinationTypeDef
- See ScheduledQueryRunStatusType
TargetConfigurationTypeDef#
# TargetConfigurationTypeDef definition
class TargetConfigurationTypeDef(TypedDict):
TimestreamConfiguration: TimestreamConfigurationTypeDef, # (1)
ListScheduledQueriesResponseTypeDef#
# ListScheduledQueriesResponseTypeDef definition
class ListScheduledQueriesResponseTypeDef(TypedDict):
ScheduledQueries: List[ScheduledQueryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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],
- See ScheduleConfigurationTypeDef
- See NotificationConfigurationTypeDef
- See ErrorReportConfigurationTypeDef
- See TargetConfigurationTypeDef
- 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)
- See ScheduledQueryStateType
- See ScheduleConfigurationTypeDef
- See NotificationConfigurationTypeDef
- See TargetConfigurationTypeDef
- See ErrorReportConfigurationTypeDef
- See ScheduledQueryRunSummaryTypeDef
- See ScheduledQueryRunSummaryTypeDef
DescribeScheduledQueryResponseTypeDef#
# DescribeScheduledQueryResponseTypeDef definition
class DescribeScheduledQueryResponseTypeDef(TypedDict):
ScheduledQuery: ScheduledQueryDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)