Skip to contents

Lists the Recycle Bin retention rules in the Region

Source: R/recyclebin_operations.R
recyclebin_list_rules.Rd

Lists the Recycle Bin retention rules in the Region.

See https://www.paws-r-sdk.com/docs/recyclebin_list_rules/ for full documentation.

Usage

recyclebin_list_rules(
  MaxResults = NULL,
  NextToken = NULL,
  ResourceType,
  ResourceTags = NULL,
  LockState = NULL,
  ExcludeResourceTags = NULL
)

Arguments

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

NextToken

The token for the next page of results.

ResourceType

[required] The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

  • To list retention rules that retain EBS volumes, specify EBS_VOLUME.

  • To list retention rules that retain EBS snapshots, specify EBS_SNAPSHOT.

  • To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

ResourceTags

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

LockState

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

ExcludeResourceTags

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.