{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.forecastquery#AmazonForecastRuntime": { "type": "service", "version": "2018-06-26", "operations": [ { "target": "com.amazonaws.forecastquery#QueryForecast" }, { "target": "com.amazonaws.forecastquery#QueryWhatIfForecast" } ], "traits": { "aws.api#service": { "sdkId": "forecastquery", "arnNamespace": "forecast", "cloudFormationName": "Forecastquery", "cloudTrailEventSource": "forecastquery.amazonaws.com", "endpointPrefix": "forecastquery" }, "aws.auth#sigv4": { "name": "forecast" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

Provides APIs for creating and managing Amazon Forecast resources.

", "smithy.api#title": "Amazon Forecast Query Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://forecastquery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://forecastquery-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://forecastquery.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://forecastquery.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://forecastquery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://forecastquery-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://forecastquery.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://forecastquery.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://forecastquery.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://forecastquery.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.forecastquery#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^arn:([a-z\\d-]+):forecast:.*:.*:.+$" } }, "com.amazonaws.forecastquery#AttributeName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-]+$" } }, "com.amazonaws.forecastquery#AttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.forecastquery#DataPoint": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.forecastquery#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp of the specific forecast.

" } }, "Value": { "target": "com.amazonaws.forecastquery#Double", "traits": { "smithy.api#documentation": "

The forecast value.

" } } }, "traits": { "smithy.api#documentation": "

The forecast value for a specific date. Part of the Forecast\n object.

" } }, "com.amazonaws.forecastquery#DateTime": { "type": "string" }, "com.amazonaws.forecastquery#Double": { "type": "double" }, "com.amazonaws.forecastquery#ErrorMessage": { "type": "string" }, "com.amazonaws.forecastquery#Filters": { "type": "map", "key": { "target": "com.amazonaws.forecastquery#AttributeName" }, "value": { "target": "com.amazonaws.forecastquery#AttributeValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.forecastquery#Forecast": { "type": "structure", "members": { "Predictions": { "target": "com.amazonaws.forecastquery#Predictions", "traits": { "smithy.api#documentation": "

The forecast.

\n

The string of the string-to-array map is one of the following\n values:

\n \n

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.\n

" } } }, "traits": { "smithy.api#documentation": "

Provides information about a forecast. Returned as part of the QueryForecast response.

" } }, "com.amazonaws.forecastquery#InvalidInputException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.forecastquery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The value is invalid or is too long.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.forecastquery#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.forecastquery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.forecastquery#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.forecastquery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.forecastquery#LongArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 300 }, "smithy.api#pattern": "^arn:([a-z\\d-]+):forecast:.*:.*:.+$" } }, "com.amazonaws.forecastquery#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 3000 } } }, "com.amazonaws.forecastquery#Predictions": { "type": "map", "key": { "target": "com.amazonaws.forecastquery#Statistic" }, "value": { "target": "com.amazonaws.forecastquery#TimeSeries" } }, "com.amazonaws.forecastquery#QueryForecast": { "type": "operation", "input": { "target": "com.amazonaws.forecastquery#QueryForecastRequest" }, "output": { "target": "com.amazonaws.forecastquery#QueryForecastResponse" }, "errors": [ { "target": "com.amazonaws.forecastquery#InvalidInputException" }, { "target": "com.amazonaws.forecastquery#InvalidNextTokenException" }, { "target": "com.amazonaws.forecastquery#LimitExceededException" }, { "target": "com.amazonaws.forecastquery#ResourceInUseException" }, { "target": "com.amazonaws.forecastquery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

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

\n

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

\n

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

\n

To get the full forecast, use the CreateForecastExportJob operation.

\n \n

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

\n
" } }, "com.amazonaws.forecastquery#QueryForecastRequest": { "type": "structure", "members": { "ForecastArn": { "target": "com.amazonaws.forecastquery#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast to query.

", "smithy.api#required": {} } }, "StartDate": { "target": "com.amazonaws.forecastquery#DateTime", "traits": { "smithy.api#documentation": "

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T08:00:00.

" } }, "EndDate": { "target": "com.amazonaws.forecastquery#DateTime", "traits": { "smithy.api#documentation": "

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T20:00:00.

" } }, "Filters": { "target": "com.amazonaws.forecastquery#Filters", "traits": { "smithy.api#documentation": "

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

\n

\n {\"item_id\" : \"client_21\"}\n

\n \n \n

To get the full forecast, use the CreateForecastExportJob operation.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.forecastquery#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.forecastquery#QueryForecastResponse": { "type": "structure", "members": { "Forecast": { "target": "com.amazonaws.forecastquery#Forecast", "traits": { "smithy.api#documentation": "

The forecast.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.forecastquery#QueryWhatIfForecast": { "type": "operation", "input": { "target": "com.amazonaws.forecastquery#QueryWhatIfForecastRequest" }, "output": { "target": "com.amazonaws.forecastquery#QueryWhatIfForecastResponse" }, "errors": [ { "target": "com.amazonaws.forecastquery#InvalidInputException" }, { "target": "com.amazonaws.forecastquery#InvalidNextTokenException" }, { "target": "com.amazonaws.forecastquery#LimitExceededException" }, { "target": "com.amazonaws.forecastquery#ResourceInUseException" }, { "target": "com.amazonaws.forecastquery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves a what-if forecast.

" } }, "com.amazonaws.forecastquery#QueryWhatIfForecastRequest": { "type": "structure", "members": { "WhatIfForecastArn": { "target": "com.amazonaws.forecastquery#LongArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the what-if forecast to query.

", "smithy.api#required": {} } }, "StartDate": { "target": "com.amazonaws.forecastquery#DateTime", "traits": { "smithy.api#documentation": "

The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T08:00:00.

" } }, "EndDate": { "target": "com.amazonaws.forecastquery#DateTime", "traits": { "smithy.api#documentation": "

The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T20:00:00.

" } }, "Filters": { "target": "com.amazonaws.forecastquery#Filters", "traits": { "smithy.api#documentation": "

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

\n

\n {\"item_id\" : \"client_21\"}\n

\n

To get the full what-if forecast, use the CreateForecastExportJob operation.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.forecastquery#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.forecastquery#QueryWhatIfForecastResponse": { "type": "structure", "members": { "Forecast": { "target": "com.amazonaws.forecastquery#Forecast" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.forecastquery#ResourceInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.forecastquery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The specified resource is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.forecastquery#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.forecastquery#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.forecastquery#Statistic": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4 } } }, "com.amazonaws.forecastquery#TimeSeries": { "type": "list", "member": { "target": "com.amazonaws.forecastquery#DataPoint" } }, "com.amazonaws.forecastquery#Timestamp": { "type": "string" } } }