| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Forecast.CreateExplainability
Description
Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)
Creates an Amazon Forecast Explainability.
Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.
To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.
CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.
CreateExplainability with a Predictor ARN
You can only have one Explainability resource per predictor. If you
already enabled ExplainPredictor in CreateAutoPredictor, that
predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName- A unique name for the Explainability.ResourceArn- The Arn of the predictor.TimePointGranularity- Must be set to “ALL”.TimeSeriesGranularity- Must be set to “ALL”.
Do not specify a value for the following parameters:
DataSource- Only valid when TimeSeriesGranularity is “SPECIFIC”.Schema- Only valid when TimeSeriesGranularity is “SPECIFIC”.StartDateTime- Only valid when TimePointGranularity is “SPECIFIC”.EndDateTime- Only valid when TimePointGranularity is “SPECIFIC”.
CreateExplainability with a Forecast ARN
You can specify a maximum of 50 time series and 500 time points.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName- A unique name for the Explainability.ResourceArn- The Arn of the forecast.TimePointGranularity- Either “ALL” or “SPECIFIC”.TimeSeriesGranularity- Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
DataSource- The S3 location of the CSV file specifying your time series.Schema- The Schema defines the attributes and attribute types listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
StartDateTime- The first timestamp in the range of time points.EndDateTime- The last timestamp in the range of time points.
Synopsis
- data CreateExplainability = CreateExplainability' {}
- newCreateExplainability :: Text -> Text -> ExplainabilityConfig -> CreateExplainability
- createExplainability_dataSource :: Lens' CreateExplainability (Maybe DataSource)
- createExplainability_enableVisualization :: Lens' CreateExplainability (Maybe Bool)
- createExplainability_endDateTime :: Lens' CreateExplainability (Maybe Text)
- createExplainability_schema :: Lens' CreateExplainability (Maybe Schema)
- createExplainability_startDateTime :: Lens' CreateExplainability (Maybe Text)
- createExplainability_tags :: Lens' CreateExplainability (Maybe [Tag])
- createExplainability_explainabilityName :: Lens' CreateExplainability Text
- createExplainability_resourceArn :: Lens' CreateExplainability Text
- createExplainability_explainabilityConfig :: Lens' CreateExplainability ExplainabilityConfig
- data CreateExplainabilityResponse = CreateExplainabilityResponse' {}
- newCreateExplainabilityResponse :: Int -> CreateExplainabilityResponse
- createExplainabilityResponse_explainabilityArn :: Lens' CreateExplainabilityResponse (Maybe Text)
- createExplainabilityResponse_httpStatus :: Lens' CreateExplainabilityResponse Int
Creating a Request
data CreateExplainability Source #
See: newCreateExplainability smart constructor.
Constructors
| CreateExplainability' | |
Fields
| |
Instances
newCreateExplainability Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExplainabilityConfig | |
| -> CreateExplainability |
Create a value of CreateExplainability with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainability, createExplainability_dataSource - Undocumented member.
$sel:enableVisualization:CreateExplainability', createExplainability_enableVisualization - Create an Explainability visualization that is viewable within the AWS
console.
$sel:endDateTime:CreateExplainability', createExplainability_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)
CreateExplainability, createExplainability_schema - Undocumented member.
$sel:startDateTime:CreateExplainability', createExplainability_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)
$sel:tags:CreateExplainability', createExplainability_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:orAWS:. Values can have this prefix. If a tag value hasawsas 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 ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
CreateExplainability, createExplainability_explainabilityName - A unique name for the Explainability.
CreateExplainability, createExplainability_resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability.
CreateExplainability, createExplainability_explainabilityConfig - The configuration settings that define the granularity of time series
and time points for the Explainability.
Request Lenses
createExplainability_dataSource :: Lens' CreateExplainability (Maybe DataSource) Source #
Undocumented member.
createExplainability_enableVisualization :: Lens' CreateExplainability (Maybe Bool) Source #
Create an Explainability visualization that is viewable within the AWS console.
createExplainability_endDateTime :: Lens' CreateExplainability (Maybe Text) Source #
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)
createExplainability_schema :: Lens' CreateExplainability (Maybe Schema) Source #
Undocumented member.
createExplainability_startDateTime :: Lens' CreateExplainability (Maybe Text) Source #
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)
createExplainability_tags :: Lens' CreateExplainability (Maybe [Tag]) Source #
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:orAWS:. Values can have this prefix. If a tag value hasawsas 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 ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createExplainability_explainabilityName :: Lens' CreateExplainability Text Source #
A unique name for the Explainability.
createExplainability_resourceArn :: Lens' CreateExplainability Text Source #
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
createExplainability_explainabilityConfig :: Lens' CreateExplainability ExplainabilityConfig Source #
The configuration settings that define the granularity of time series and time points for the Explainability.
Destructuring the Response
data CreateExplainabilityResponse Source #
See: newCreateExplainabilityResponse smart constructor.
Constructors
| CreateExplainabilityResponse' | |
Fields
| |
Instances
newCreateExplainabilityResponse Source #
Create a value of CreateExplainabilityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainabilityResponse, createExplainabilityResponse_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.
$sel:httpStatus:CreateExplainabilityResponse', createExplainabilityResponse_httpStatus - The response's http status code.
Response Lenses
createExplainabilityResponse_explainabilityArn :: Lens' CreateExplainabilityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability.
createExplainabilityResponse_httpStatus :: Lens' CreateExplainabilityResponse Int Source #
The response's http status code.