ForecastQueryServiceClient#

Index > ForecastQueryService > ForecastQueryServiceClient

Auto-generated documentation for ForecastQueryService type annotations stubs module mypy-boto3-forecastquery.

ForecastQueryServiceClient#

Type annotations and code completion for boto3.client("forecastquery"). boto3 documentation

# ForecastQueryServiceClient usage example

from boto3.session import Session
from mypy_boto3_forecastquery.client import ForecastQueryServiceClient

def get_forecastquery_client() -> ForecastQueryServiceClient:
    return Session().client("forecastquery")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("forecastquery").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("forecastquery")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InvalidInputException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.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 boto3.client("forecastquery").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url#

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

Type annotations and code completion for boto3.client("forecastquery").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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 boto3.client("forecastquery").query_forecast method. boto3 documentation

# query_forecast method definition

def query_forecast(
    self,
    *,
    ForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: str = ...,
    EndDate: str = ...,
    NextToken: str = ...,
) -> QueryForecastResponseTypeDef:  # (1)
    ...

See QueryForecastResponseTypeDef

# query_forecast method usage example with argument unpacking

kwargs: QueryForecastRequestRequestTypeDef = {  # (1)
    "ForecastArn": ...,
    "Filters": ...,
}

parent.query_forecast(**kwargs)

See QueryForecastRequestRequestTypeDef

query_what_if_forecast#

Retrieves a what-if forecast.

Type annotations and code completion for boto3.client("forecastquery").query_what_if_forecast method. boto3 documentation

# query_what_if_forecast method definition

def query_what_if_forecast(
    self,
    *,
    WhatIfForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: str = ...,
    EndDate: str = ...,
    NextToken: str = ...,
) -> QueryWhatIfForecastResponseTypeDef:  # (1)
    ...

See QueryWhatIfForecastResponseTypeDef

# query_what_if_forecast method usage example with argument unpacking

kwargs: QueryWhatIfForecastRequestRequestTypeDef = {  # (1)
    "WhatIfForecastArn": ...,
    "Filters": ...,
}

parent.query_what_if_forecast(**kwargs)

See QueryWhatIfForecastRequestRequestTypeDef