List Rules

recyclebin_list_rules

R Documentation

Lists the Recycle Bin retention rules in the Region¶

Description¶

Lists the Recycle Bin retention rules in the Region.

Usage¶

recyclebin_list_rules(MaxResults, NextToken, ResourceType, ResourceTags,
  LockState)

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 Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.
ResourceTags: 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.

Value¶

A list with the following syntax:

list(
  Rules = list(
    list(
      Identifier = "string",
      Description = "string",
      RetentionPeriod = list(
        RetentionPeriodValue = 123,
        RetentionPeriodUnit = "DAYS"
      ),
      LockState = "locked"|"pending_unlock"|"unlocked",
      RuleArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_rules(
  MaxResults = 123,
  NextToken = "string",
  ResourceType = "EBS_SNAPSHOT"|"EC2_IMAGE",
  ResourceTags = list(
    list(
      ResourceTagKey = "string",
      ResourceTagValue = "string"
    )
  ),
  LockState = "locked"|"pending_unlock"|"unlocked"
)