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

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

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 DescribeDirectoriesRequest data as a hash:

{
  directory_ids: ["DirectoryId"],
  next_token: "NextToken",
  limit: 1,
}

Contains the inputs for the DescribeDirectories operation.

Instance Attribute Summary collapse

Instance Attribute Details

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


988
989
990
991
992
993
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 988

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

#limitInteger

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)


988
989
990
991
992
993
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 988

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

#next_tokenString

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

Returns:

  • (String)


988
989
990
991
992
993
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 988

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