Skip to content

Delete Group

synthetics_delete_group R Documentation

Deletes a group

Description

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.

Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.

Usage

synthetics_delete_group(GroupIdentifier)

Arguments

GroupIdentifier

[required] Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Value

An empty list.

Request syntax

svc$delete_group(
  GroupIdentifier = "string"
)