Describes an Explainability resource created using the CreateExplainability operation.
See also: AWS API Documentation
describe-explainability --explainability-arn <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The Amazon Resource Name (ARN) of the Explaianability to describe.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
ExplainabilityArn -> (string)
The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityName -> (string)
The name of the Explainability.
ResourceArn -> (string)
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
ExplainabilityConfig -> (structure)
The configuration settings that define the granularity of time series and time points for the Explainability.
TimeSeriesGranularity -> (string)
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
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
TimePointGranularity -> (string)
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
Specify time points with the
EndDateTimeparameters within the CreateExplainability operation.
EnableVisualization -> (boolean)
Whether the visualization was enabled for the Explainability resource.
DataSource -> (structure)
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 -> (structure)
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)The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
RoleArn -> (string)
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
KMSKeyArnkey, 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
KMSKeyArn -> (string)The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
Schema -> (structure)
Defines the fields of a dataset.
Attributes -> (list)
An array of attributes specifying the name and type of each field in a dataset.
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
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).
StartDateTime -> (string)
TimePointGranularityis set to
SPECIFIC, the first time point in the Explainability.
EndDateTime -> (string)
TimePointGranularityis set to
SPECIFIC, the last time point in the Explainability.
EstimatedTimeRemainingInMinutes -> (long)
The estimated time remaining in minutes for the CreateExplainability job to complete.
Message -> (string)
If an error occurred, a message about the error.
Status -> (string)
The status of the Explainability resource. States include:
CreationTime -> (timestamp)
When the Explainability resource was created.
LastModificationTime -> (timestamp)
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_IN_PROGRESS- The current timestamp.
CREATE_STOPPING- The current timestamp.
CREATE_STOPPED- When the job stopped.
CREATE_FAILED- When the job finished or failed.