directoryservice_describe_directories: Obtains information about the directories that belong to this...

Description Usage Arguments Details Request syntax

View source: R/directoryservice_operations.R

Description

Obtains information about the directories that belong to this account.

Usage

1
directoryservice_describe_directories(DirectoryIds, NextToken, Limit)

Arguments

DirectoryIds

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.

NextToken

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

Limit

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.

Details

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Request syntax

1
2
3
4
5
6
7
svc$describe_directories(
  DirectoryIds = list(
    "string"
  ),
  NextToken = "string",
  Limit = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.