You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectoryService::Types::DescribeSnapshotsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeSnapshotsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  directory_id: "DirectoryId",
  snapshot_ids: ["SnapshotId"],
  next_token: "NextToken",
  limit: 1,
}

Contains the inputs for the DescribeSnapshots operation.

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

The identifier of the directory for which to retrieve snapshot information.

Returns:

  • (String)

    The identifier of the directory for which to retrieve snapshot information.

#limitInteger

The maximum number of objects to return.

Returns:

  • (Integer)

    The maximum number of objects to return.

#next_tokenString

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Returns:

  • (String)

    The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.

#snapshot_idsArray<String>

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.

Returns:

  • (Array<String>)

    A list of identifiers of the snapshots to obtain the information for.