Get Insight Summaries

xray_get_insight_summaries

R Documentation

Retrieves the summaries of all insights in the specified group matching the provided filter values

Description

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Usage

xray_get_insight_summaries(States, GroupARN, GroupName, StartTime,
  EndTime, MaxResults, NextToken)

Arguments

States

The list of insight states.

GroupARN

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

GroupName

The name of the group. Required if the GroupARN isn't provided.

StartTime

[required] The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

EndTime

[required] The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

MaxResults

The maximum number of results to display.

NextToken

Pagination token.

Value

A list with the following syntax:

list(
  InsightSummaries = list(
    list(
      InsightId = "string",
      GroupARN = "string",
      GroupName = "string",
      RootCauseServiceId = list(
        Name = "string",
        Names = list(
          "string"
        ),
        AccountId = "string",
        Type = "string"
      ),
      Categories = list(
        "FAULT"
      ),
      State = "ACTIVE"|"CLOSED",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Summary = "string",
      ClientRequestImpactStatistics = list(
        FaultCount = 123,
        OkCount = 123,
        TotalCount = 123
      ),
      RootCauseServiceRequestImpactStatistics = list(
        FaultCount = 123,
        OkCount = 123,
        TotalCount = 123
      ),
      TopAnomalousServices = list(
        list(
          ServiceId = list(
            Name = "string",
            Names = list(
              "string"
            ),
            AccountId = "string",
            Type = "string"
          )
        )
      ),
      LastUpdateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_insight_summaries(
  States = list(
    "ACTIVE"|"CLOSED"
  ),
  GroupARN = "string",
  GroupName = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NextToken = "string"
)