Skip to content

Get Group

synthetics_get_group R Documentation

Returns information about one group

Description

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

Usage

synthetics_get_group(GroupIdentifier)

Arguments

GroupIdentifier

[required] Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Value

A list with the following syntax:

list(
  Group = list(
    Id = "string",
    Name = "string",
    Arn = "string",
    Tags = list(
      "string"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_group(
  GroupIdentifier = "string"
)