Skip to contents

Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)

Source: R/forecastservice_operations.R
forecastservice_create_explainability.Rd

Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (create_auto_predictor)

See https://www.paws-r-sdk.com/docs/forecastservice_create_explainability/ for full documentation.

Usage

forecastservice_create_explainability(
  ExplainabilityName,
  ResourceArn,
  ExplainabilityConfig,
  DataSource = NULL,
  Schema = NULL,
  EnableVisualization = NULL,
  StartDateTime = NULL,
  EndDateTime = NULL,
  Tags = NULL
)

Arguments

ExplainabilityName

[required] A unique name for the Explainability.

ResourceArn

[required] The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

ExplainabilityConfig

[required] The configuration settings that define the granularity of time series and time points for the Explainability.

DataSource

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.

Schema

Defines the fields of a dataset.

EnableVisualization

Create an Explainability visualization that is viewable within the Amazon Web Services console.

StartDateTime

If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

EndDateTime

If TimePointGranularity is set to SPECIFIC, define the last time point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

Tags

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

  • For each resource, each tag key must be unique and each tag key must have one value.

  • Maximum number of tags per resource: 50.

  • Maximum key length: 128 Unicode characters in UTF-8.

  • Maximum value length: 256 Unicode characters in UTF-8.

  • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

  • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, 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. You cannot edit or delete tag keys with this prefix.