Describe Snapshots

directoryservice_describe_snapshots

R Documentation

Obtains information about the directory snapshots that belong to this account¶

Description¶

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to describe_snapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Usage¶

directoryservice_describe_snapshots(DirectoryId, SnapshotIds, NextToken,
  Limit)

Arguments¶

DirectoryId: The identifier of the directory for which to retrieve snapshot information.
SnapshotIds: A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
NextToken: The DescribeSnapshotsResult.NextToken value from a previous call to describe_snapshots. Pass null if this is the first call.
Limit: The maximum number of objects to return.

Value¶

A list with the following syntax:

list(
  Snapshots = list(
    list(
      DirectoryId = "string",
      SnapshotId = "string",
      Type = "Auto"|"Manual",
      Name = "string",
      Status = "Creating"|"Completed"|"Failed",
      StartTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_snapshots(
  DirectoryId = "string",
  SnapshotIds = list(
    "string"
  ),
  NextToken = "string",
  Limit = 123
)