Skip to content

Get Ops Summary

ssm_get_ops_summary R Documentation

View a summary of operations metadata (OpsData) based on specified filters and aggregators

Description

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

Usage

ssm_get_ops_summary(SyncName, Filters, Aggregators, ResultAttributes,
  NextToken, MaxResults)

Arguments

SyncName

Specify the name of a resource data sync to get.

Filters

Optional filters used to scope down the returned OpsData.

Aggregators

Optional aggregators that return counts of OpsData based on one or more expressions.

ResultAttributes

The OpsData data type to return.

NextToken

A token to start the list. Use this token to get the next set of results.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Value

A list with the following syntax:

list(
  Entities = list(
    list(
      Id = "string",
      Data = list(
        list(
          CaptureTime = "string",
          Content = list(
            list(
              "string"
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_ops_summary(
  SyncName = "string",
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      ),
      Type = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
    )
  ),
  Aggregators = list(
    list(
      AggregatorType = "string",
      TypeName = "string",
      AttributeName = "string",
      Values = list(
        "string"
      ),
      Filters = list(
        list(
          Key = "string",
          Values = list(
            "string"
          ),
          Type = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
        )
      ),
      Aggregators = list()
    )
  ),
  ResultAttributes = list(
    list(
      TypeName = "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)