TimestreamQuery module#
Index > TimestreamQuery
Auto-generated documentation for TimestreamQuery type annotations stubs module mypy-boto3-timestream-query.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and TimestreamQuery
.
From PyPI with pip#
Install boto3-stubs
for TimestreamQuery
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[timestream-query]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[timestream-query]'
# standalone installation
python -m pip install mypy-boto3-timestream-query
How to uninstall#
python -m pip uninstall -y mypy-boto3-timestream-query
Usage#
Code samples can be found in Examples.
TimestreamQueryClient#
Type annotations and code completion for boto3.client("timestream-query")
as TimestreamQueryClient
boto3 documentation
# TimestreamQueryClient usage example
from boto3.session import Session
from mypy_boto3_timestream_query.client import TimestreamQueryClient
def get_client() -> TimestreamQueryClient:
return Session().client("timestream-query")
Paginators#
Type annotations and code completion for paginators
from boto3.client("timestream-query").get_paginator("...")
.
# ListScheduledQueriesPaginator usage example
from boto3.session import Session
from mypy_boto3_timestream_query.paginator import ListScheduledQueriesPaginator
def get_list_scheduled_queries_paginator() -> ListScheduledQueriesPaginator:
return Session().client("timestream-query").get_paginator("list_scheduled_queries"))
Literals#
Type annotations for literals used in methods and schemas.
# DimensionValueTypeType usage example
from mypy_boto3_timestream_query.literals import DimensionValueTypeType
def get_value() -> DimensionValueTypeType:
return "VARCHAR"
- DimensionValueTypeType
- ListScheduledQueriesPaginatorName
- ListTagsForResourcePaginatorName
- MeasureValueTypeType
- QueryPaginatorName
- S3EncryptionOptionType
- ScalarMeasureValueTypeType
- ScalarTypeType
- ScheduledQueryRunStatusType
- ScheduledQueryStateType
- TimestreamQueryServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# CancelQueryRequestRequestTypeDef usage example
from mypy_boto3_timestream_query.type_defs import CancelQueryRequestRequestTypeDef
def get_value() -> CancelQueryRequestRequestTypeDef:
return {
"QueryId": ...,
}
- CancelQueryRequestRequestTypeDef
- CancelQueryResponseTypeDef
- ColumnInfoTypeDef
- ScheduleConfigurationTypeDef
- TagTypeDef
- CreateScheduledQueryResponseTypeDef
- RowTypeDef
- TimeSeriesDataPointTypeDef
- DeleteScheduledQueryRequestRequestTypeDef
- EndpointTypeDef
- DescribeScheduledQueryRequestRequestTypeDef
- DimensionMappingTypeDef
- EmptyResponseMetadataTypeDef
- S3ConfigurationTypeDef
- S3ReportLocationTypeDef
- ExecuteScheduledQueryRequestRequestTypeDef
- ExecutionStatsTypeDef
- ListScheduledQueriesRequestListScheduledQueriesPaginateTypeDef
- ListScheduledQueriesRequestRequestTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- MultiMeasureAttributeMappingTypeDef
- SnsConfigurationTypeDef
- PaginatorConfigTypeDef
- ParameterMappingTypeDef
- PrepareQueryRequestRequestTypeDef
- SelectColumnTypeDef
- QueryRequestQueryPaginateTypeDef
- QueryRequestRequestTypeDef
- QueryStatusTypeDef
- ResponseMetadataTypeDef
- TimestreamDestinationTypeDef
- TypeTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateScheduledQueryRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- DatumTypeDef
- DescribeEndpointsResponseTypeDef
- ErrorReportConfigurationTypeDef
- ErrorReportLocationTypeDef
- MixedMeasureMappingTypeDef
- MultiMeasureMappingsTypeDef
- NotificationConfigurationTypeDef
- PrepareQueryResponseTypeDef
- QueryResponseTypeDef
- TargetDestinationTypeDef
- ScheduledQueryRunSummaryTypeDef
- TimestreamConfigurationTypeDef
- ScheduledQueryTypeDef
- TargetConfigurationTypeDef
- ListScheduledQueriesResponseTypeDef
- CreateScheduledQueryRequestRequestTypeDef
- ScheduledQueryDescriptionTypeDef
- DescribeScheduledQueryResponseTypeDef