Skip to content

List Associated Groups

synthetics_list_associated_groups R Documentation

Returns a list of the groups that the specified canary is associated with

Description

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

Usage

synthetics_list_associated_groups(NextToken, MaxResults, ResourceArn)

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_associated_groups operation. If you omit this parameter, the default of 20 is used.

ResourceArn

[required] The ARN of the canary that you want to view groups for.

Value

A list with the following syntax: 

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

Request syntax

svc$list_associated_groups(
  NextToken = "string",
  MaxResults = 123,
  ResourceArn = "string"
)