ForecastQueryService ¶

Table of Contents

ForecastQueryService

Client ¶

class ForecastQueryService.Client¶

A low-level client representing Amazon Forecast Query Service

Provides APIs for creating and managing Amazon Forecast resources.

client = session.create_client('forecastquery')

These are the available methods:

can_paginate()
close()
get_paginator()
get_waiter()
query_forecast()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

close()¶: Closes underlying endpoint connections.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

query_forecast(**kwargs)¶

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

To get the full forecast, use the CreateForecastExportJob operation.

Note

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

See also: AWS API Documentation

Request Syntax

response = client.query_forecast(
    ForecastArn='string',
    StartDate='string',
    EndDate='string',
    Filters={
        'string': 'string'
    },
    NextToken='string'
)

Parameters

ForecastArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the forecast to query.
StartDate (string) -- The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
EndDate (string) -- The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
Filters (dict) --
[REQUIRED]

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full forecast, use the CreateForecastExportJob operation.
- (string) --
  - (string) --
NextToken (string) -- If the result of the previous request was truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Return type

dict

Returns

Response Syntax

{
    'Forecast': {
        'Predictions': {
            'string': [
                {
                    'Timestamp': 'string',
                    'Value': 123.0
                },
            ]
        }
    }
}

Response Structure

(dict) --
- Forecast (dict) --
  
  The forecast.
  - Predictions (dict) --
    
    The forecast.
    
    The string of the string-to-array map is one of the following values:
    - p10
    - p50
    - p90
    - (string) --
      - (list) --
        
        (dict) --
        
        The forecast value for a specific date. Part of the Forecast object.
        
        Timestamp (string) --
        
        The timestamp of the specific forecast.
        
        Value (float) --
        
        The forecast value.

Exceptions

ForecastQueryService.Client.exceptions.ResourceNotFoundException
ForecastQueryService.Client.exceptions.ResourceInUseException
ForecastQueryService.Client.exceptions.InvalidInputException
ForecastQueryService.Client.exceptions.LimitExceededException
ForecastQueryService.Client.exceptions.InvalidNextTokenException

Client Exceptions ¶

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

ForecastQueryService.Client.exceptions.InvalidInputException
ForecastQueryService.Client.exceptions.InvalidNextTokenException
ForecastQueryService.Client.exceptions.LimitExceededException
ForecastQueryService.Client.exceptions.ResourceInUseException
ForecastQueryService.Client.exceptions.ResourceNotFoundException

class ForecastQueryService.Client.exceptions.InvalidInputException¶

The value is invalid or is too long.

Example

try:
  ...
except client.exceptions.InvalidInputException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) --

The value is invalid or is too long.
- Message (string) --
- Error (dict) -- Normalized access to common exception attributes.
  - Code (string) -- An identifier specifying the exception type.
  - Message (string) -- A descriptive message explaining why the exception occured.

class ForecastQueryService.Client.exceptions.InvalidNextTokenException¶

The token is not valid. Tokens expire after 24 hours.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) --

The token is not valid. Tokens expire after 24 hours.
- Message (string) --
- Error (dict) -- Normalized access to common exception attributes.
  - Code (string) -- An identifier specifying the exception type.
  - Message (string) -- A descriptive message explaining why the exception occured.

class ForecastQueryService.Client.exceptions.LimitExceededException¶

The limit on the number of requests per second has been exceeded.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) --

The limit on the number of requests per second has been exceeded.
- Message (string) --
- Error (dict) -- Normalized access to common exception attributes.
  - Code (string) -- An identifier specifying the exception type.
  - Message (string) -- A descriptive message explaining why the exception occured.

class ForecastQueryService.Client.exceptions.ResourceInUseException¶

The specified resource is in use.

Example

try:
  ...
except client.exceptions.ResourceInUseException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) --

The specified resource is in use.
- Message (string) --
- Error (dict) -- Normalized access to common exception attributes.
  - Code (string) -- An identifier specifying the exception type.
  - Message (string) -- A descriptive message explaining why the exception occured.

class ForecastQueryService.Client.exceptions.ResourceNotFoundException¶

We can't find that resource. Check the information that you've provided and try again.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) --

We can't find that resource. Check the information that you've provided and try again.
- Message (string) --
- Error (dict) -- Normalized access to common exception attributes.
  - Code (string) -- An identifier specifying the exception type.
  - Message (string) -- A descriptive message explaining why the exception occured.

Paginators ¶

The available paginators are:

Table Of Contents

Contents

ForecastQueryService¶

Client¶

Client Exceptions¶

Paginators¶

ForecastQueryService ¶

Client ¶

Client Exceptions ¶

Paginators ¶