Skip to content

Describe Locked Snapshots

ec2_describe_locked_snapshots R Documentation

Describes the lock status for a snapshot

Description

Describes the lock status for a snapshot.

Usage

ec2_describe_locked_snapshots(Filters, MaxResults, NextToken,
  SnapshotIds, DryRun)

Arguments

Filters

The filters.

  • lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

SnapshotIds

The IDs of the snapshots for which to view the lock status.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  Snapshots = list(
    list(
      OwnerId = "string",
      SnapshotId = "string",
      LockState = "compliance"|"governance"|"compliance-cooloff"|"expired",
      LockDuration = 123,
      CoolOffPeriod = 123,
      CoolOffPeriodExpiresOn = as.POSIXct(
        "2015-01-01"
      ),
      LockCreatedOn = as.POSIXct(
        "2015-01-01"
      ),
      LockDurationStartTime = as.POSIXct(
        "2015-01-01"
      ),
      LockExpiresOn = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_locked_snapshots(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  SnapshotIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)