directoryservice_describe_snapshots: Obtains information about the directory snapshots that belong...

Description Usage Arguments Details Request syntax

View source: R/directoryservice_operations.R

Description

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

Usage

1
2
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 DescribeSnapshots. Pass null if this is the first call.

Limit

The maximum number of objects to return.

Details

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 DescribeSnapshots to retrieve the next set of items.

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

Request syntax

1
2
3
4
5
6
7
8
svc$describe_snapshots(
  DirectoryId = "string",
  SnapshotIds = list(
    "string"
  ),
  NextToken = "string",
  Limit = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.