List Groups

synthetics_list_groups

R Documentation

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs

Description

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

Usage

synthetics_list_groups(NextToken, MaxResults)

Arguments

NextToken

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

MaxResults

Specify this parameter to limit how many groups are returned each time you use the list_groups operation. If you omit this parameter, the default of 20 is used.

Value

A list with the following syntax:

list(
  Groups = list(
    list(
      Id = "string",
      Name = "string",
      Arn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_groups(
  NextToken = "string",
  MaxResults = 123
)