ForecastService / Client / create_forecast

create_forecast#

ForecastService.Client.create_forecast(**kwargs)#

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

Note

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

For more information, see howitworks-forecast.

Note

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

By default, a forecast includes predictions for every item ( item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

Request Syntax

response = client.create_forecast(
    ForecastName='string',
    PredictorArn='string',
    ForecastTypes=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TimeSeriesSelector={
        'TimeSeriesIdentifiers': {
            'DataSource': {
                'S3Config': {
                    'Path': 'string',
                    'RoleArn': 'string',
                    'KMSKeyArn': 'string'
                }
            },
            'Schema': {
                'Attributes': [
                    {
                        'AttributeName': 'string',
                        'AttributeType': 'string'|'integer'|'float'|'timestamp'|'geolocation'
                    },
                ]
            },
            'Format': 'string'
        }
    }
)

Parameters:

ForecastName (string) –
[REQUIRED]

A name for the forecast.
PredictorArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
ForecastTypes (list) –
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).

The default quantiles are the quantiles you specified during predictor creation. If you didn’t specify quantiles, the default values are ["0.1", "0.5", "0.9"].
- (string) –
Tags (list) –
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
- (dict) –
  
  The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
  
  The following basic restrictions apply to tags:
  - Maximum number of tags per resource - 50.
  - For each resource, each tag key must be unique, and each tag key can have only one value.
  - Maximum key length - 128 Unicode characters in UTF-8.
  - Maximum value length - 256 Unicode characters in UTF-8.
  - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  - Tag keys and values are case sensitive.
  - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
  - Key (string) – [REQUIRED]
    
    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
  - Value (string) – [REQUIRED]
    
    The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
TimeSeriesSelector (dict) –
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:
- DataSource
- Format
- Schema
- TimeSeriesIdentifiers (dict) –
  
  Details about the import file that contains the time series for which you want to create forecasts.
  - DataSource (dict) –
    
    The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.
    - S3Config (dict) – [REQUIRED]
      
      The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
      - Path (string) – [REQUIRED]
        
        The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
      - RoleArn (string) – [REQUIRED]
        
        The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.
        
        Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn’t in your account, you get an InvalidInputException error.
      - KMSKeyArn (string) –
        
        The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
  - Schema (dict) –
    
    Defines the fields of a dataset.
    - Attributes (list) –
      
      An array of attributes specifying the name and type of each field in a dataset.
      - (dict) –
        
        An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The Schema object contains an array of SchemaAttribute objects.
        
        AttributeName (string) –
        
        The name of the dataset field.
        
        AttributeType (string) –
        
        The data type of the field.
        
        For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
  - Format (string) –
    
    The format of the data, either CSV or PARQUET.

Return type:

dict

Returns:

Response Syntax

{
    'ForecastArn': 'string'
}

Response Structure

(dict) –
- ForecastArn (string) –
  
  The Amazon Resource Name (ARN) of the forecast.

Exceptions

ForecastService.Client.exceptions.InvalidInputException
ForecastService.Client.exceptions.ResourceAlreadyExistsException
ForecastService.Client.exceptions.ResourceNotFoundException
ForecastService.Client.exceptions.ResourceInUseException
ForecastService.Client.exceptions.LimitExceededException