ForecastQueryService ******************** Client ====== class ForecastQueryService.Client A low-level client representing Amazon Forecast Query Service Provides APIs for creating and managing Amazon Forecast resources. import boto3 client = boto3.client('forecastquery') These are the available methods: * can_paginate * close * get_paginator * get_waiter * query_forecast * query_what_if_forecast ForecastQueryService / Client / get_paginator get_paginator ************* ForecastQueryService.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. ForecastQueryService / Client / can_paginate can_paginate ************ ForecastQueryService.Client.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. ForecastQueryService / Client / query_forecast query_forecast ************** ForecastQueryService.Client.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 The default setting is "["0.1", "0.5", "0.9"]". Use the optional "ForecastTypes" parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of "1" and a maximum of "5." * *(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.ResourceNotFoundExceptio n" * "ForecastQueryService.Client.exceptions.ResourceInUseException" * "ForecastQueryService.Client.exceptions.InvalidInputException" * "ForecastQueryService.Client.exceptions.LimitExceededException" * "ForecastQueryService.Client.exceptions.InvalidNextTokenExceptio n" ForecastQueryService / Client / get_waiter get_waiter ********** ForecastQueryService.Client.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" ForecastQueryService / Client / close close ***** ForecastQueryService.Client.close() Closes underlying endpoint connections. ForecastQueryService / Client / query_what_if_forecast query_what_if_forecast ********************** ForecastQueryService.Client.query_what_if_forecast(**kwargs) Retrieves a what-if forecast. See also: AWS API Documentation **Request Syntax** response = client.query_what_if_forecast( WhatIfForecastArn='string', StartDate='string', EndDate='string', Filters={ 'string': 'string' }, NextToken='string' ) Parameters: * **WhatIfForecastArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the what-if forecast to query. * **StartDate** (*string*) -- The start date for the what-if 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 what-if 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 what-if 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) --* Provides information about a forecast. Returned as part of the QueryForecast response. * **Predictions** *(dict) --* The forecast. The *string* of the string-to-array map is one of the following values: * p10 * p50 * p90 The default setting is "["0.1", "0.5", "0.9"]". Use the optional "ForecastTypes" parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of "1" and a maximum of "5." * *(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.ResourceNotFoundExceptio n" * "ForecastQueryService.Client.exceptions.ResourceInUseException" * "ForecastQueryService.Client.exceptions.InvalidInputException" * "ForecastQueryService.Client.exceptions.LimitExceededException" * "ForecastQueryService.Client.exceptions.InvalidNextTokenExceptio n"