Typed dictionaries#
Index > TimestreamQuery > Typed dictionaries
Auto-generated documentation for TimestreamQuery type annotations stubs module mypy-boto3-timestream-query.
CancelQueryRequestRequestTypeDef#
# CancelQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import CancelQueryRequestRequestTypeDef
def get_value() -> CancelQueryRequestRequestTypeDef:
return {
"QueryId": ...,
}
# CancelQueryRequestRequestTypeDef definition
class CancelQueryRequestRequestTypeDef(TypedDict):
QueryId: str,
CancelQueryResponseTypeDef#
# CancelQueryResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import CancelQueryResponseTypeDef
def get_value() -> CancelQueryResponseTypeDef:
return {
"CancellationMessage": ...,
"ResponseMetadata": ...,
}
# CancelQueryResponseTypeDef definition
class CancelQueryResponseTypeDef(TypedDict):
CancellationMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ColumnInfoTypeDef#
# ColumnInfoTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ColumnInfoTypeDef
def get_value() -> ColumnInfoTypeDef:
return {
"Type": ...,
}
# ColumnInfoTypeDef definition
class ColumnInfoTypeDef(TypedDict):
Type: TypeTypeDef, # (1)
Name: NotRequired[str],
- See TypeTypeDef
ScheduleConfigurationTypeDef#
# ScheduleConfigurationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ScheduleConfigurationTypeDef
def get_value() -> ScheduleConfigurationTypeDef:
return {
"ScheduleExpression": ...,
}
# ScheduleConfigurationTypeDef definition
class ScheduleConfigurationTypeDef(TypedDict):
ScheduleExpression: str,
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_timestream_query.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
CreateScheduledQueryResponseTypeDef#
# CreateScheduledQueryResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import CreateScheduledQueryResponseTypeDef
def get_value() -> CreateScheduledQueryResponseTypeDef:
return {
"Arn": ...,
"ResponseMetadata": ...,
}
# CreateScheduledQueryResponseTypeDef definition
class CreateScheduledQueryResponseTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RowTypeDef#
# RowTypeDef usage example
from mypy_boto3_timestream_query.type_defs import RowTypeDef
def get_value() -> RowTypeDef:
return {
"Data": ...,
}
# RowTypeDef definition
class RowTypeDef(TypedDict):
Data: List[DatumTypeDef], # (1)
- See DatumTypeDef
TimeSeriesDataPointTypeDef#
# TimeSeriesDataPointTypeDef usage example
from mypy_boto3_timestream_query.type_defs import TimeSeriesDataPointTypeDef
def get_value() -> TimeSeriesDataPointTypeDef:
return {
"Time": ...,
"Value": ...,
}
# TimeSeriesDataPointTypeDef definition
class TimeSeriesDataPointTypeDef(TypedDict):
Time: str,
Value: DatumTypeDef, # (1)
- See DatumTypeDef
DeleteScheduledQueryRequestRequestTypeDef#
# DeleteScheduledQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import DeleteScheduledQueryRequestRequestTypeDef
def get_value() -> DeleteScheduledQueryRequestRequestTypeDef:
return {
"ScheduledQueryArn": ...,
}
# DeleteScheduledQueryRequestRequestTypeDef definition
class DeleteScheduledQueryRequestRequestTypeDef(TypedDict):
ScheduledQueryArn: str,
EndpointTypeDef#
# EndpointTypeDef usage example
from mypy_boto3_timestream_query.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"Address": ...,
"CachePeriodInMinutes": ...,
}
# EndpointTypeDef definition
class EndpointTypeDef(TypedDict):
Address: str,
CachePeriodInMinutes: int,
DescribeScheduledQueryRequestRequestTypeDef#
# DescribeScheduledQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import DescribeScheduledQueryRequestRequestTypeDef
def get_value() -> DescribeScheduledQueryRequestRequestTypeDef:
return {
"ScheduledQueryArn": ...,
}
# DescribeScheduledQueryRequestRequestTypeDef definition
class DescribeScheduledQueryRequestRequestTypeDef(TypedDict):
ScheduledQueryArn: str,
DimensionMappingTypeDef#
# DimensionMappingTypeDef usage example
from mypy_boto3_timestream_query.type_defs import DimensionMappingTypeDef
def get_value() -> DimensionMappingTypeDef:
return {
"Name": ...,
"DimensionValueType": ...,
}
# DimensionMappingTypeDef definition
class DimensionMappingTypeDef(TypedDict):
Name: str,
DimensionValueType: DimensionValueTypeType, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_timestream_query.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
S3ConfigurationTypeDef#
# S3ConfigurationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import S3ConfigurationTypeDef
def get_value() -> S3ConfigurationTypeDef:
return {
"BucketName": ...,
}
# S3ConfigurationTypeDef definition
class S3ConfigurationTypeDef(TypedDict):
BucketName: str,
ObjectKeyPrefix: NotRequired[str],
EncryptionOption: NotRequired[S3EncryptionOptionType], # (1)
S3ReportLocationTypeDef#
# S3ReportLocationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import S3ReportLocationTypeDef
def get_value() -> S3ReportLocationTypeDef:
return {
"BucketName": ...,
}
# S3ReportLocationTypeDef definition
class S3ReportLocationTypeDef(TypedDict):
BucketName: NotRequired[str],
ObjectKey: NotRequired[str],
ExecuteScheduledQueryRequestRequestTypeDef#
# ExecuteScheduledQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ExecuteScheduledQueryRequestRequestTypeDef
def get_value() -> ExecuteScheduledQueryRequestRequestTypeDef:
return {
"ScheduledQueryArn": ...,
"InvocationTime": ...,
}
# ExecuteScheduledQueryRequestRequestTypeDef definition
class ExecuteScheduledQueryRequestRequestTypeDef(TypedDict):
ScheduledQueryArn: str,
InvocationTime: Union[datetime, str],
ClientToken: NotRequired[str],
ExecutionStatsTypeDef#
# ExecutionStatsTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ExecutionStatsTypeDef
def get_value() -> ExecutionStatsTypeDef:
return {
"ExecutionTimeInMillis": ...,
}
# ExecutionStatsTypeDef definition
class ExecutionStatsTypeDef(TypedDict):
ExecutionTimeInMillis: NotRequired[int],
DataWrites: NotRequired[int],
BytesMetered: NotRequired[int],
RecordsIngested: NotRequired[int],
QueryResultRows: NotRequired[int],
ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef#
# ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef
def get_value() -> ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef definition
class ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListScheduledQueriesRequestRequestTypeDef#
# ListScheduledQueriesRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesRequestRequestTypeDef
def get_value() -> ListScheduledQueriesRequestRequestTypeDef:
return {
"MaxResults": ...,
}
# ListScheduledQueriesRequestRequestTypeDef definition
class ListScheduledQueriesRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
ResourceARN: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MultiMeasureAttributeMappingTypeDef#
# MultiMeasureAttributeMappingTypeDef usage example
from mypy_boto3_timestream_query.type_defs import MultiMeasureAttributeMappingTypeDef
def get_value() -> MultiMeasureAttributeMappingTypeDef:
return {
"SourceColumn": ...,
"MeasureValueType": ...,
}
# MultiMeasureAttributeMappingTypeDef definition
class MultiMeasureAttributeMappingTypeDef(TypedDict):
SourceColumn: str,
MeasureValueType: ScalarMeasureValueTypeType, # (1)
TargetMultiMeasureAttributeName: NotRequired[str],
SnsConfigurationTypeDef#
# SnsConfigurationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import SnsConfigurationTypeDef
def get_value() -> SnsConfigurationTypeDef:
return {
"TopicArn": ...,
}
# SnsConfigurationTypeDef definition
class SnsConfigurationTypeDef(TypedDict):
TopicArn: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_timestream_query.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ParameterMappingTypeDef#
# ParameterMappingTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ParameterMappingTypeDef
def get_value() -> ParameterMappingTypeDef:
return {
"Name": ...,
"Type": ...,
}
# ParameterMappingTypeDef definition
class ParameterMappingTypeDef(TypedDict):
Name: str,
Type: TypeTypeDef, # (1)
- See TypeTypeDef
PrepareQueryRequestRequestTypeDef#
# PrepareQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import PrepareQueryRequestRequestTypeDef
def get_value() -> PrepareQueryRequestRequestTypeDef:
return {
"QueryString": ...,
}
# PrepareQueryRequestRequestTypeDef definition
class PrepareQueryRequestRequestTypeDef(TypedDict):
QueryString: str,
ValidateOnly: NotRequired[bool],
SelectColumnTypeDef#
# SelectColumnTypeDef usage example
from mypy_boto3_timestream_query.type_defs import SelectColumnTypeDef
def get_value() -> SelectColumnTypeDef:
return {
"Name": ...,
}
# SelectColumnTypeDef definition
class SelectColumnTypeDef(TypedDict):
Name: NotRequired[str],
Type: NotRequired[TypeTypeDef], # (1)
DatabaseName: NotRequired[str],
TableName: NotRequired[str],
Aliased: NotRequired[bool],
- See TypeTypeDef
QueryRequestQueryPaginateTypeDef#
# QueryRequestQueryPaginateTypeDef usage example
from mypy_boto3_timestream_query.type_defs import QueryRequestQueryPaginateTypeDef
def get_value() -> QueryRequestQueryPaginateTypeDef:
return {
"QueryString": ...,
}
# QueryRequestQueryPaginateTypeDef definition
class QueryRequestQueryPaginateTypeDef(TypedDict):
QueryString: str,
ClientToken: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryRequestRequestTypeDef#
# QueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import QueryRequestRequestTypeDef
def get_value() -> QueryRequestRequestTypeDef:
return {
"QueryString": ...,
}
# QueryRequestRequestTypeDef definition
class QueryRequestRequestTypeDef(TypedDict):
QueryString: str,
ClientToken: NotRequired[str],
NextToken: NotRequired[str],
MaxRows: NotRequired[int],
QueryStatusTypeDef#
# QueryStatusTypeDef usage example
from mypy_boto3_timestream_query.type_defs import QueryStatusTypeDef
def get_value() -> QueryStatusTypeDef:
return {
"ProgressPercentage": ...,
}
# QueryStatusTypeDef definition
class QueryStatusTypeDef(TypedDict):
ProgressPercentage: NotRequired[float],
CumulativeBytesScanned: NotRequired[int],
CumulativeBytesMetered: NotRequired[int],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TimestreamDestinationTypeDef#
# TimestreamDestinationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import TimestreamDestinationTypeDef
def get_value() -> TimestreamDestinationTypeDef:
return {
"DatabaseName": ...,
}
# TimestreamDestinationTypeDef definition
class TimestreamDestinationTypeDef(TypedDict):
DatabaseName: NotRequired[str],
TableName: NotRequired[str],
TypeTypeDef#
# TypeTypeDef usage example
from mypy_boto3_timestream_query.type_defs import TypeTypeDef
def get_value() -> TypeTypeDef:
return {
"ScalarType": ...,
}
# TypeTypeDef definition
class TypeTypeDef(TypedDict):
ScalarType: NotRequired[ScalarTypeType], # (1)
ArrayColumnInfo: NotRequired[ColumnInfoTypeDef], # (2)
TimeSeriesMeasureValueColumnInfo: NotRequired[ColumnInfoTypeDef], # (2)
RowColumnInfo: NotRequired[List[ColumnInfoTypeDef]], # (4)
- See ScalarTypeType
- See ColumnInfoTypeDef
- See ColumnInfoTypeDef
- See ColumnInfoTypeDef
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateScheduledQueryRequestRequestTypeDef#
# UpdateScheduledQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import UpdateScheduledQueryRequestRequestTypeDef
def get_value() -> UpdateScheduledQueryRequestRequestTypeDef:
return {
"ScheduledQueryArn": ...,
"State": ...,
}
# UpdateScheduledQueryRequestRequestTypeDef definition
class UpdateScheduledQueryRequestRequestTypeDef(TypedDict):
ScheduledQueryArn: str,
State: ScheduledQueryStateType, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
DatumTypeDef#
# DatumTypeDef usage example
from mypy_boto3_timestream_query.type_defs import DatumTypeDef
def get_value() -> DatumTypeDef:
return {
"ScalarValue": ...,
}
# DatumTypeDef definition
class DatumTypeDef(TypedDict):
ScalarValue: NotRequired[str],
TimeSeriesValue: NotRequired[List[TimeSeriesDataPointTypeDef]], # (1)
ArrayValue: NotRequired[List[DatumTypeDef]], # (2)
RowValue: NotRequired[RowTypeDef], # (3)
NullValue: NotRequired[bool],
- See TimeSeriesDataPointTypeDef
- See DatumTypeDef
- See RowTypeDef
DescribeEndpointsResponseTypeDef#
# DescribeEndpointsResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import DescribeEndpointsResponseTypeDef
def get_value() -> DescribeEndpointsResponseTypeDef:
return {
"Endpoints": ...,
"ResponseMetadata": ...,
}
# DescribeEndpointsResponseTypeDef definition
class DescribeEndpointsResponseTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ErrorReportConfigurationTypeDef#
# ErrorReportConfigurationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ErrorReportConfigurationTypeDef
def get_value() -> ErrorReportConfigurationTypeDef:
return {
"S3Configuration": ...,
}
# ErrorReportConfigurationTypeDef definition
class ErrorReportConfigurationTypeDef(TypedDict):
S3Configuration: S3ConfigurationTypeDef, # (1)
ErrorReportLocationTypeDef#
# ErrorReportLocationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ErrorReportLocationTypeDef
def get_value() -> ErrorReportLocationTypeDef:
return {
"S3ReportLocation": ...,
}
# ErrorReportLocationTypeDef definition
class ErrorReportLocationTypeDef(TypedDict):
S3ReportLocation: NotRequired[S3ReportLocationTypeDef], # (1)
MixedMeasureMappingTypeDef#
# MixedMeasureMappingTypeDef usage example
from mypy_boto3_timestream_query.type_defs import MixedMeasureMappingTypeDef
def get_value() -> MixedMeasureMappingTypeDef:
return {
"MeasureValueType": ...,
}
# MixedMeasureMappingTypeDef definition
class MixedMeasureMappingTypeDef(TypedDict):
MeasureValueType: MeasureValueTypeType, # (1)
MeasureName: NotRequired[str],
SourceColumn: NotRequired[str],
TargetMeasureName: NotRequired[str],
MultiMeasureAttributeMappings: NotRequired[Sequence[MultiMeasureAttributeMappingTypeDef]], # (2)
MultiMeasureMappingsTypeDef#
# MultiMeasureMappingsTypeDef usage example
from mypy_boto3_timestream_query.type_defs import MultiMeasureMappingsTypeDef
def get_value() -> MultiMeasureMappingsTypeDef:
return {
"MultiMeasureAttributeMappings": ...,
}
# MultiMeasureMappingsTypeDef definition
class MultiMeasureMappingsTypeDef(TypedDict):
MultiMeasureAttributeMappings: Sequence[MultiMeasureAttributeMappingTypeDef], # (1)
TargetMultiMeasureName: NotRequired[str],
NotificationConfigurationTypeDef#
# NotificationConfigurationTypeDef usage example
from mypy_boto3_timestream_query.type_defs import NotificationConfigurationTypeDef
def get_value() -> NotificationConfigurationTypeDef:
return {
"SnsConfiguration": ...,
}
# NotificationConfigurationTypeDef definition
class NotificationConfigurationTypeDef(TypedDict):
SnsConfiguration: SnsConfigurationTypeDef, # (1)
PrepareQueryResponseTypeDef#
# PrepareQueryResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import PrepareQueryResponseTypeDef
def get_value() -> PrepareQueryResponseTypeDef:
return {
"QueryString": ...,
"Columns": ...,
"Parameters": ...,
"ResponseMetadata": ...,
}
# PrepareQueryResponseTypeDef definition
class PrepareQueryResponseTypeDef(TypedDict):
QueryString: str,
Columns: List[SelectColumnTypeDef], # (1)
Parameters: List[ParameterMappingTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
QueryResponseTypeDef#
# QueryResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import QueryResponseTypeDef
def get_value() -> QueryResponseTypeDef:
return {
"QueryId": ...,
"NextToken": ...,
"Rows": ...,
"ColumnInfo": ...,
"QueryStatus": ...,
"ResponseMetadata": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import TargetDestinationTypeDef
def get_value() -> TargetDestinationTypeDef:
return {
"TimestreamDestination": ...,
}
# TargetDestinationTypeDef definition
class TargetDestinationTypeDef(TypedDict):
TimestreamDestination: NotRequired[TimestreamDestinationTypeDef], # (1)
ScheduledQueryRunSummaryTypeDef#
# ScheduledQueryRunSummaryTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ScheduledQueryRunSummaryTypeDef
def get_value() -> ScheduledQueryRunSummaryTypeDef:
return {
"InvocationTime": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import TimestreamConfigurationTypeDef
def get_value() -> TimestreamConfigurationTypeDef:
return {
"DatabaseName": ...,
"TableName": ...,
"TimeColumn": ...,
"DimensionMappings": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import ScheduledQueryTypeDef
def get_value() -> ScheduledQueryTypeDef:
return {
"Arn": ...,
"Name": ...,
"State": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import TargetConfigurationTypeDef
def get_value() -> TargetConfigurationTypeDef:
return {
"TimestreamConfiguration": ...,
}
# TargetConfigurationTypeDef definition
class TargetConfigurationTypeDef(TypedDict):
TimestreamConfiguration: TimestreamConfigurationTypeDef, # (1)
ListScheduledQueriesResponseTypeDef#
# ListScheduledQueriesResponseTypeDef usage example
from mypy_boto3_timestream_query.type_defs import ListScheduledQueriesResponseTypeDef
def get_value() -> ListScheduledQueriesResponseTypeDef:
return {
"ScheduledQueries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListScheduledQueriesResponseTypeDef definition
class ListScheduledQueriesResponseTypeDef(TypedDict):
ScheduledQueries: List[ScheduledQueryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateScheduledQueryRequestRequestTypeDef#
# CreateScheduledQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import CreateScheduledQueryRequestRequestTypeDef
def get_value() -> CreateScheduledQueryRequestRequestTypeDef:
return {
"Name": ...,
"QueryString": ...,
"ScheduleConfiguration": ...,
"NotificationConfiguration": ...,
"ScheduledQueryExecutionRoleArn": ...,
"ErrorReportConfiguration": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import ScheduledQueryDescriptionTypeDef
def get_value() -> ScheduledQueryDescriptionTypeDef:
return {
"Arn": ...,
"Name": ...,
"QueryString": ...,
"State": ...,
"ScheduleConfiguration": ...,
"NotificationConfiguration": ...,
}
# 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 usage example
from mypy_boto3_timestream_query.type_defs import DescribeScheduledQueryResponseTypeDef
def get_value() -> DescribeScheduledQueryResponseTypeDef:
return {
"ScheduledQuery": ...,
"ResponseMetadata": ...,
}
# DescribeScheduledQueryResponseTypeDef definition
class DescribeScheduledQueryResponseTypeDef(TypedDict):
ScheduledQuery: ScheduledQueryDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)