List Insights

opensearchservice_list_insights

R Documentation

Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account¶

Description¶

Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account. Returns a paginated list of insights based on the specified entity, filters, time range, and sort order.

Usage¶

opensearchservice_list_insights(Entity, TimeRange, SortOrder,
  MaxResults, NextToken)

Arguments¶

Entity

[required] The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

TimeRange

The time range for filtering insights, specified as epoch millisecond timestamps.

SortOrder

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use NextToken to get the next page of results. Valid values are 1 to 500.

NextToken

If your initial list_insights operation returns a NextToken, include the returned NextToken in subsequent list_insights operations to retrieve the next page of results.

Value¶

A list with the following syntax:

list(
  Insights = list(
    list(
      InsightId = "string",
      DisplayName = "string",
      Type = "EVENT"|"RECOMMENDATION",
      Priority = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW",
      Status = "ACTIVE"|"RESOLVED"|"DISMISSED",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      UpdateTime = as.POSIXct(
        "2015-01-01"
      ),
      IsExperimental = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_insights(
  Entity = list(
    Type = "Account"|"DomainName",
    Value = "string"
  ),
  TimeRange = list(
    From = 123,
    To = 123
  ),
  SortOrder = "ASC"|"DESC",
  MaxResults = 123,
  NextToken = "string"
)