ForecastService / Client / create_what_if_analysis

create_what_if_analysis#

ForecastService.Client.create_what_if_analysis(**kwargs)#

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.

You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

Request Syntax

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

Parameters:

WhatIfAnalysisName (string) –
[REQUIRED]

The name of the what-if analysis. Each name must be unique.
ForecastArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the baseline forecast.
TimeSeriesSelector (dict) –
Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this 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.
Tags (list) –
A list of tags to apply to the what if forecast.
- (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).

Return type:

dict

Returns:

Response Syntax

{
    'WhatIfAnalysisArn': 'string'
}

Response Structure

(dict) –
- WhatIfAnalysisArn (string) –
  
  The Amazon Resource Name (ARN) of the what-if analysis.

Exceptions

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