TimestreamQueryClient#
Index > TimestreamQuery > TimestreamQueryClient
Auto-generated documentation for TimestreamQuery type annotations stubs module mypy-boto3-timestream-query.
TimestreamQueryClient#
Type annotations and code completion for boto3.client("timestream-query").
boto3 documentation
# TimestreamQueryClient usage example
from boto3.session import Session
from mypy_boto3_timestream_query.client import TimestreamQueryClient
def get_timestream-query_client() -> TimestreamQueryClient:
return Session().client("timestream-query")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("timestream-query").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("timestream-query")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.InvalidEndpointException,
client.exceptions.QueryExecutionException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_timestream_query.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("timestream-query").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_query#
Cancels a query that has been issued.
Type annotations and code completion for boto3.client("timestream-query").cancel_query method.
boto3 documentation
# cancel_query method definition
def cancel_query(
self,
*,
QueryId: str,
) -> CancelQueryResponseTypeDef: # (1)
...# cancel_query method usage example with argument unpacking
kwargs: CancelQueryRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.cancel_query(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("timestream-query").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_scheduled_query#
Create a scheduled query that will be run on your behalf at the configured schedule.
Type annotations and code completion for boto3.client("timestream-query").create_scheduled_query method.
boto3 documentation
# create_scheduled_query method definition
def create_scheduled_query(
self,
*,
Name: str,
QueryString: str,
ScheduleConfiguration: ScheduleConfigurationTypeDef, # (1)
NotificationConfiguration: NotificationConfigurationTypeDef, # (2)
ScheduledQueryExecutionRoleArn: str,
ErrorReportConfiguration: ErrorReportConfigurationTypeDef, # (3)
TargetConfiguration: Union[TargetConfigurationTypeDef, TargetConfigurationOutputTypeDef] = ..., # (4)
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (5)
KmsKeyId: str = ...,
) -> CreateScheduledQueryResponseTypeDef: # (6)
...- See ScheduleConfigurationTypeDef
- See NotificationConfigurationTypeDef
- See ErrorReportConfigurationTypeDef
- See TargetConfigurationTypeDef TargetConfigurationOutputTypeDef
- See TagTypeDef
- See CreateScheduledQueryResponseTypeDef
# create_scheduled_query method usage example with argument unpacking
kwargs: CreateScheduledQueryRequestRequestTypeDef = { # (1)
"Name": ...,
"QueryString": ...,
"ScheduleConfiguration": ...,
"NotificationConfiguration": ...,
"ScheduledQueryExecutionRoleArn": ...,
"ErrorReportConfiguration": ...,
}
parent.create_scheduled_query(**kwargs)delete_scheduled_query#
Deletes a given scheduled query.
Type annotations and code completion for boto3.client("timestream-query").delete_scheduled_query method.
boto3 documentation
# delete_scheduled_query method definition
def delete_scheduled_query(
self,
*,
ScheduledQueryArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_scheduled_query method usage example with argument unpacking
kwargs: DeleteScheduledQueryRequestRequestTypeDef = { # (1)
"ScheduledQueryArn": ...,
}
parent.delete_scheduled_query(**kwargs)describe_account_settings#
Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.
Type annotations and code completion for boto3.client("timestream-query").describe_account_settings method.
boto3 documentation
# describe_account_settings method definition
def describe_account_settings(
self,
) -> DescribeAccountSettingsResponseTypeDef: # (1)
...describe_endpoints#
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
Type annotations and code completion for boto3.client("timestream-query").describe_endpoints method.
boto3 documentation
# describe_endpoints method definition
def describe_endpoints(
self,
) -> DescribeEndpointsResponseTypeDef: # (1)
...describe_scheduled_query#
Provides detailed information about a scheduled query.
Type annotations and code completion for boto3.client("timestream-query").describe_scheduled_query method.
boto3 documentation
# describe_scheduled_query method definition
def describe_scheduled_query(
self,
*,
ScheduledQueryArn: str,
) -> DescribeScheduledQueryResponseTypeDef: # (1)
...# describe_scheduled_query method usage example with argument unpacking
kwargs: DescribeScheduledQueryRequestRequestTypeDef = { # (1)
"ScheduledQueryArn": ...,
}
parent.describe_scheduled_query(**kwargs)execute_scheduled_query#
You can use this API to run a scheduled query manually.
Type annotations and code completion for boto3.client("timestream-query").execute_scheduled_query method.