List Explainabilities

forecastservice_list_explainabilities

R Documentation

Returns a list of Explainability resources created using the CreateExplainability operation

Description

Returns a list of Explainability resources created using the create_explainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the describe_explainability operation.

Usage

forecastservice_list_explainabilities(NextToken, MaxResults, Filters)

Arguments

NextToken

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

MaxResults

The number of items returned in the response.

Filters

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

• Condition - The condition to apply. Valid values are IS and IS_NOT.

• Key - The name of the parameter to filter on. Valid values are ResourceArn and Status.

• Value - The value to match.

Value

A list with the following syntax:

list(
  Explainabilities = list(
    list(
      ExplainabilityArn = "string",
      ExplainabilityName = "string",
      ResourceArn = "string",
      ExplainabilityConfig = list(
        TimeSeriesGranularity = "ALL"|"SPECIFIC",
        TimePointGranularity = "ALL"|"SPECIFIC"
      ),
      Status = "string",
      Message = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_explainabilities(
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Key = "string",
      Value = "string",
      Condition = "IS"|"IS_NOT"
    )
  )
)