Network.AWS.WorkSpaces.DescribeWorkspaceDirectories

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

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

See: AWS API Reference for DescribeWorkspaceDirectories.

Creating a Request

describeWorkspaceDirectories :: DescribeWorkspaceDirectories

Creates a value of DescribeWorkspaceDirectories with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dwdNextToken
• dwdDirectoryIds

data DescribeWorkspaceDirectories

Contains the inputs for the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectories smart constructor.

Instances

Eq DescribeWorkspaceDirectories

Data DescribeWorkspaceDirectories

Read DescribeWorkspaceDirectories

Show DescribeWorkspaceDirectories

Generic DescribeWorkspaceDirectories

ToJSON DescribeWorkspaceDirectories

AWSRequest DescribeWorkspaceDirectories

ToPath DescribeWorkspaceDirectories

ToHeaders DescribeWorkspaceDirectories

ToQuery DescribeWorkspaceDirectories

Typeable * DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectories

type Rs DescribeWorkspaceDirectories = DescribeWorkspaceDirectoriesResponse

Request Lenses

dwdNextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text)

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

dwdDirectoryIds :: Lens' DescribeWorkspaceDirectories (Maybe (NonEmpty Text))

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Destructuring the Response

describeWorkspaceDirectoriesResponse

Arguments

:: Int

dwdrsResponseStatus

-> DescribeWorkspaceDirectoriesResponse

Creates a value of DescribeWorkspaceDirectoriesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dwdrsDirectories
• dwdrsNextToken
• dwdrsResponseStatus

data DescribeWorkspaceDirectoriesResponse

Contains the results of the DescribeWorkspaceDirectories operation.

See: describeWorkspaceDirectoriesResponse smart constructor.

Instances

Eq DescribeWorkspaceDirectoriesResponse

Data DescribeWorkspaceDirectoriesResponse

Read DescribeWorkspaceDirectoriesResponse

Show DescribeWorkspaceDirectoriesResponse

Generic DescribeWorkspaceDirectoriesResponse

Typeable * DescribeWorkspaceDirectoriesResponse

type Rep DescribeWorkspaceDirectoriesResponse

Response Lenses

dwdrsDirectories :: Lens' DescribeWorkspaceDirectoriesResponse [WorkspaceDirectory]

An array of structures that contain information about the directories.

dwdrsNextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text)

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that timeframe.

dwdrsResponseStatus :: Lens' DescribeWorkspaceDirectoriesResponse Int

The response status code.