Synthetics / Client / delete_group

delete_group#

Synthetics.Client.delete_group(**kwargs)#

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.

Request Syntax

response = client.delete_group(
    GroupIdentifier='string'
)

Parameters:

GroupIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Synthetics.Client.exceptions.InternalServerException
Synthetics.Client.exceptions.ValidationException
Synthetics.Client.exceptions.ResourceNotFoundException
Synthetics.Client.exceptions.ConflictException