interface ForecastComputationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.ForecastComputationProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.ForecastComputationProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.ForecastComputationProperty
TypeScript	@aws-cdk/aws-quicksight » CfnDashboard » ForecastComputationProperty

The forecast computation configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const forecastComputationProperty: quicksight.CfnDashboard.ForecastComputationProperty = {
  computationId: 'computationId',
  time: {
    categoricalDimensionField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      formatConfiguration: {
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numericFormatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
    dateDimensionField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      dateGranularity: 'dateGranularity',
      formatConfiguration: {
        dateTimeFormat: 'dateTimeFormat',
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numericFormatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
    numericalDimensionField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      formatConfiguration: {
        formatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
      hierarchyId: 'hierarchyId',
    },
  },

  // the properties below are optional
  customSeasonalityValue: 123,
  lowerBoundary: 123,
  name: 'name',
  periodsBackward: 123,
  periodsForward: 123,
  predictionInterval: 123,
  seasonality: 'seasonality',
  upperBoundary: 123,
  value: {
    calculatedMeasureField: {
      expression: 'expression',
      fieldId: 'fieldId',
    },
    categoricalMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      aggregationFunction: 'aggregationFunction',
      formatConfiguration: {
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numericFormatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
    },
    dateMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      aggregationFunction: 'aggregationFunction',
      formatConfiguration: {
        dateTimeFormat: 'dateTimeFormat',
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numericFormatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
    },
    numericalMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      fieldId: 'fieldId',

      // the properties below are optional
      aggregationFunction: {
        percentileAggregation: {
          percentileValue: 123,
        },
        simpleNumericalAggregation: 'simpleNumericalAggregation',
      },
      formatConfiguration: {
        formatConfiguration: {
          currencyDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
            symbol: 'symbol',
          },
          numberDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            numberScale: 'numberScale',
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
          percentageDisplayFormatConfiguration: {
            decimalPlacesConfiguration: {
              decimalPlaces: 123,
            },
            negativeValueConfiguration: {
              displayMode: 'displayMode',
            },
            nullValueFormatConfiguration: {
              nullString: 'nullString',
            },
            prefix: 'prefix',
            separatorConfiguration: {
              decimalSeparator: 'decimalSeparator',
              thousandsSeparator: {
                symbol: 'symbol',
                visibility: 'visibility',
              },
            },
            suffix: 'suffix',
          },
        },
      },
    },
  },
};

Properties

Name	Type	Description
computationId	string	The ID for a computation.
time	IResolvable | DimensionFieldProperty	The time field that is used in a computation.
customSeasonalityValue?	number	The custom seasonality value setup of a forecast computation.
lowerBoundary?	number	The lower boundary setup of a forecast computation.
name?	string	The name of a computation.
periodsBackward?	number	The periods backward setup of a forecast computation.
periodsForward?	number	The periods forward setup of a forecast computation.
predictionInterval?	number	The prediction interval setup of a forecast computation.
seasonality?	string	The seasonality setup of a forecast computation. Choose one of the following options:.
upperBoundary?	number	The upper boundary setup of a forecast computation.
value?	IResolvable | MeasureFieldProperty	The value field that is used in a computation.

---

computationId

Type: string

The ID for a computation.

---

time

Type: IResolvable | DimensionFieldProperty

The time field that is used in a computation.

---

customSeasonalityValue?

Type: number (optional)

The custom seasonality value setup of a forecast computation.

---

lowerBoundary?

Type: number (optional)

The lower boundary setup of a forecast computation.

---

name?

Type: string (optional)

The name of a computation.

---

periodsBackward?

Type: number (optional)

The periods backward setup of a forecast computation.

---

periodsForward?

Type: number (optional)

The periods forward setup of a forecast computation.

---

predictionInterval?

Type: number (optional)

The prediction interval setup of a forecast computation.

---

seasonality?

Type: string (optional)

The seasonality setup of a forecast computation. Choose one of the following options:.

• AUTOMATIC
• CUSTOM : Checks the custom seasonality value.

---

upperBoundary?

Type: number (optional)

The upper boundary setup of a forecast computation.

---

value?

Type: IResolvable | MeasureFieldProperty (optional)

The value field that is used in a computation.