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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Note:

When making an API call, you may pass DescribeSnapshotsRequest data as a 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)


1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1158

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of objects to return.

Returns:

  • (Integer)


1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1158

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1158

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  include Aws::Structure
end

#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>)


1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1158

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  include Aws::Structure
end