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

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

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

Overview

Note:

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

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

Contains the inputs for the DescribeDirectories operation.

See Also:

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

    A list of identifiers of the directories for which to obtain the information.

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

    The maximum number of items to return.

#next_token ⇒ String

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

Returns:

  • (String) —

    The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.