AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Forecast Service CreateExplainability API operation.

Syntax

New-FRCExplainability
-ExplainabilityName <String>
-Schema_Attribute <SchemaAttribute[]>
-EnableVisualization <Boolean>
-EndDateTime <String>
-S3Config_KMSKeyArn <String>
-S3Config_Path <String>
-ResourceArn <String>
-S3Config_RoleArn <String>
-StartDateTime <String>
-Tag <Tag[]>
-ExplainabilityConfig_TimePointGranularity <TimePointGranularity>
-ExplainabilityConfig_TimeSeriesGranularity <TimeSeriesGranularity>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

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.

Parameters

-EnableVisualization <Boolean>
Create an Explainability visualization that is viewable within the AWS console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndDateTime <String>
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)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExplainabilityConfig_TimePointGranularity <TimePointGranularity>
To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExplainabilityConfig_TimeSeriesGranularity <TimeSeriesGranularity>
To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExplainabilityName <String>
A unique name for the Explainability.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ExplainabilityName parameter. The -PassThru parameter is deprecated, use -Select '^ExplainabilityName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceArn <String>
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Config_KMSKeyArn <String>
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSource_S3Config_KMSKeyArn
-S3Config_Path <String>
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSource_S3Config_Path
-S3Config_RoleArn <String>
The ARN of the AWS 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 AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSource_S3Config_RoleArn
-Schema_Attribute <SchemaAttribute[]>
An array of attributes specifying the name and type of each field in a dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchema_Attributes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ExplainabilityArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateExplainabilityResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateExplainabilityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartDateTime <String>
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)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.ForecastService.Model.CreateExplainabilityResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z