Skip to content

Describe Explainability

forecastservice_describe_explainability R Documentation

Describes an Explainability resource created using the CreateExplainability operation

Description

Describes an Explainability resource created using the create_explainability operation.

Usage

forecastservice_describe_explainability(ExplainabilityArn)

Arguments

ExplainabilityArn

[required] The Amazon Resource Name (ARN) of the Explaianability to describe.

Value

A list with the following syntax:

list(
  ExplainabilityArn = "string",
  ExplainabilityName = "string",
  ResourceArn = "string",
  ExplainabilityConfig = list(
    TimeSeriesGranularity = "ALL"|"SPECIFIC",
    TimePointGranularity = "ALL"|"SPECIFIC"
  ),
  EnableVisualization = TRUE|FALSE,
  DataSource = list(
    S3Config = list(
      Path = "string",
      RoleArn = "string",
      KMSKeyArn = "string"
    )
  ),
  Schema = list(
    Attributes = list(
      list(
        AttributeName = "string",
        AttributeType = "string"|"integer"|"float"|"timestamp"|"geolocation"
      )
    )
  ),
  StartDateTime = "string",
  EndDateTime = "string",
  EstimatedTimeRemainingInMinutes = 123,
  Message = "string",
  Status = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModificationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_explainability(
  ExplainabilityArn = "string"
)