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

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.

Usage example

client = boto3.client("timestream-query")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.InvalidEndpointException,
    client.QueryExecutionException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

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

Method definition

def cancel_query(
    self,
    *,
    QueryId: str,
) -> CancelQueryResponseTypeDef:  # (1)
    ...

1. See CancelQueryResponseTypeDef

Usage example with kwargs

kwargs: CancelQueryRequestRequestTypeDef = {  # (1)
    "QueryId": ...,
}

parent.cancel_query(**kwargs)

1. See CancelQueryRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("timestream-query").close method. boto3 documentation

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

Method definition

def create_scheduled_query(
    self,
    *,
    Name: str,
    QueryString: str,
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (1)
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (2)
    ScheduledQueryExecutionRoleArn: str,
    ErrorReportConfiguration: ErrorReportConfigurationTypeDef,  # (3)
    TargetConfiguration: TargetConfigurationTypeDef = ...,  # (4)
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    KmsKeyId: str = ...,
) -> CreateScheduledQueryResponseTypeDef:  # (6)
    ...

1. See ScheduleConfigurationTypeDef
2. See NotificationConfigurationTypeDef
3. See ErrorReportConfigurationTypeDef
4. See TargetConfigurationTypeDef
5. See TagTypeDef
6. See CreateScheduledQueryResponseTypeDef

Usage example with kwargs

kwargs: CreateScheduledQueryRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "QueryString": ...,
    "ScheduleConfiguration": ...,
    "NotificationConfiguration": ...,
    "ScheduledQueryExecutionRoleArn": ...,
    "ErrorReportConfiguration": ...,
}

parent.create_scheduled_query(**kwargs)

1. See CreateScheduledQueryRequestRequestTypeDef

delete_scheduled_query

Deletes a given scheduled query.

Type annotations and code completion for boto3.client("timestream-query").delete_scheduled_query method. boto3 documentation

Method definition

def delete_scheduled_query(
    self,
    *,
    ScheduledQueryArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteScheduledQueryRequestRequestTypeDef = {  # (1)
    "ScheduledQueryArn": ...,
}

parent.delete_scheduled_query(**kwargs)

1. See DeleteScheduledQueryRequestRequestTypeDef

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

Method definition

def describe_endpoints(
    self,
) -> DescribeEndpointsResponseTypeDef:  # (1)
    ...

1. See DescribeEndpointsResponseTypeDef

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

Method definition

def describe_scheduled_query(
    self,
    *,
    ScheduledQueryArn: str,
) -> DescribeScheduledQueryResponseTypeDef:  # (1)
    ...

1. See DescribeScheduledQueryResponseTypeDef

Usage example with kwargs

kwargs: DescribeScheduledQueryRequestRequestTypeDef = {  # (1)
    "ScheduledQueryArn": ...,
}

parent.describe_scheduled_query(**kwargs)

1. See DescribeScheduledQueryRequestRequestTypeDef

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. boto3 documentation

Method definition

def execute_scheduled_query(
    self,
    *,
    ScheduledQueryArn: str,
    InvocationTime: Union[datetime, str],
    ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: ExecuteScheduledQueryRequestRequestTypeDef = {  # (1)
    "ScheduledQueryArn": ...,
    "InvocationTime": ...,
}

parent.execute_scheduled_query(**kwargs)

1. See ExecuteScheduledQueryRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("timestream-query").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_scheduled_queries

Gets a list of all scheduled queries in the caller's Amazon account and Region.

Type annotations and code completion for boto3.client("timestream-query").list_scheduled_queries method. boto3 documentation

Method definition

def list_scheduled_queries(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListScheduledQueriesResponseTypeDef:  # (1)
    ...

1. See ListScheduledQueriesResponseTypeDef

Usage example with kwargs

kwargs: ListScheduledQueriesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_scheduled_queries(**kwargs)

1. See ListScheduledQueriesRequestRequestTypeDef

list_tags_for_resource

List all tags on a Timestream query resource.

Type annotations and code completion for boto3.client("timestream-query").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

prepare_query

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.

Type annotations and code completion for boto3.client("timestream-query").prepare_query method. boto3 documentation

Method definition

def prepare_query(
    self,
    *,
    QueryString: str,
    ValidateOnly: bool = ...,
) -> PrepareQueryResponseTypeDef:  # (1)
    ...

1. See PrepareQueryResponseTypeDef

Usage example with kwargs

kwargs: PrepareQueryRequestRequestTypeDef = {  # (1)
    "QueryString": ...,
}

parent.prepare_query(**kwargs)

1. See PrepareQueryRequestRequestTypeDef

query

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.

Type annotations and code completion for boto3.client("timestream-query").query method. boto3 documentation

Method definition

def query(
    self,
    *,
    QueryString: str,
    ClientToken: str = ...,
    NextToken: str = ...,
    MaxRows: int = ...,
) -> QueryResponseTypeDef:  # (1)
    ...

1. See QueryResponseTypeDef

Usage example with kwargs

kwargs: QueryRequestRequestTypeDef = {  # (1)
    "QueryString": ...,
}

parent.query(**kwargs)

1. See QueryRequestRequestTypeDef

tag_resource

Associate a set of tags with a Timestream resource.

Type annotations and code completion for boto3.client("timestream-query").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the association of tags from a Timestream query resource.

Type annotations and code completion for boto3.client("timestream-query").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_scheduled_query

Update a scheduled query.

Type annotations and code completion for boto3.client("timestream-query").update_scheduled_query method. boto3 documentation

Method definition

def update_scheduled_query(
    self,
    *,
    ScheduledQueryArn: str,
    State: ScheduledQueryStateType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ScheduledQueryStateType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateScheduledQueryRequestRequestTypeDef = {  # (1)
    "ScheduledQueryArn": ...,
    "State": ...,
}

parent.update_scheduled_query(**kwargs)

1. See UpdateScheduledQueryRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("timestream-query").get_paginator method with overloads.

• client.get_paginator("list_scheduled_queries") -> ListScheduledQueriesPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("query") -> QueryPaginator