ForecastQueryServiceClient#
Index > ForecastQueryService > ForecastQueryServiceClient
Auto-generated documentation for ForecastQueryService type annotations stubs module types-aiobotocore-forecastquery.
ForecastQueryServiceClient#
Type annotations and code completion for session.create_client("forecastquery")
boto3 documentation
ForecastQueryServiceClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_forecastquery.client import ForecastQueryServiceClient
session = get_session()
async with session.create_client("forecastquery") as client:
client: ForecastQueryServiceClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("forecastquery").exceptions
structure.
ForecastQueryServiceClient.exceptions usage example
async with session.create_client("forecastquery") as client:
try:
do_something(client)
except (
client.ClientError,
client.InvalidInputException,
client.InvalidNextTokenException,
client.LimitExceededException,
client.ResourceInUseException,
client.ResourceNotFoundException,
) as e:
print(e)
ForecastQueryServiceClient usage type checking example
from types_aiobotocore_forecastquery.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("forecastquery").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("forecastquery").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("forecastquery").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
query_forecast#
Retrieves a forecast for a single item, filtered by the supplied criteria.
Type annotations and code completion for session.create_client("forecastquery").query_forecast
method.
boto3 documentation
# query_forecast method definition
await def query_forecast(
self,
*,
ForecastArn: str,
Filters: Mapping[str, str],
StartDate: str = ...,
EndDate: str = ...,
NextToken: str = ...,
) -> QueryForecastResponseTypeDef: # (1)
...
# query_forecast method usage example with argument unpacking
kwargs: QueryForecastRequestRequestTypeDef = { # (1)
"ForecastArn": ...,
"Filters": ...,
}
parent.query_forecast(**kwargs)
query_what_if_forecast#
Retrieves a what-if forecast.
Type annotations and code completion for session.create_client("forecastquery").query_what_if_forecast
method.
boto3 documentation
# query_what_if_forecast method definition
await def query_what_if_forecast(
self,
*,
WhatIfForecastArn: str,
Filters: Mapping[str, str],
StartDate: str = ...,
EndDate: str = ...,
NextToken: str = ...,
) -> QueryWhatIfForecastResponseTypeDef: # (1)
...
# query_what_if_forecast method usage example with argument unpacking
kwargs: QueryWhatIfForecastRequestRequestTypeDef = { # (1)
"WhatIfForecastArn": ...,
"Filters": ...,
}
parent.query_what_if_forecast(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("forecastquery").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ForecastQueryServiceClient:
...
__aexit__#
Type annotations and code completion for session.create_client("forecastquery").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...