Class: Aws::DirectoryService::Types::DescribeDirectoriesRequest

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

Overview

Contains the inputs for the DescribeDirectories operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directory_ids ⇒ Array<String>

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Returns:

  • (Array<String>) 


1360
1361
1362
1363
1364
1365
1366
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1360

class DescribeDirectoriesRequest < Struct.new(
  :directory_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Returns:

  • (Integer) 


1360
1361
1362
1363
1364
1365
1366
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1360

class DescribeDirectoriesRequest < Struct.new(
  :directory_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1360

class DescribeDirectoriesRequest < Struct.new(
  :directory_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end