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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

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

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2051

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

#limitInteger

The maximum number of objects to return.

Returns:

  • (Integer)


2051
2052
2053
2054
2055
2056
2057
2058
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2051

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  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)


2051
2052
2053
2054
2055
2056
2057
2058
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2051

class DescribeSnapshotsRequest < Struct.new(
  :directory_id,
  :snapshot_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  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>)


2051
2052
2053
2054
2055
2056
2057
2058
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2051

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