Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Describes the available directories that are registered with Amazon WorkSpaces.

This operation returns paginated results.

Creating a Request

data DescribeWorkspaceDirectories

See: newDescribeWorkspaceDirectories smart constructor.

Constructors

DescribeWorkspaceDirectories'

Fields

• directoryIds :: Maybe (NonEmpty Text)

  The identifiers of the directories. If the value is null, all directories are retrieved.

• limit :: Maybe Natural

  The maximum number of directories to return.

• nextToken :: Maybe Text

  If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Instances

ToJSON DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toJSON :: DescribeWorkspaceDirectories -> Value

toEncoding :: DescribeWorkspaceDirectories -> Encoding

toJSONList :: [DescribeWorkspaceDirectories] -> Value

toEncodingList :: [DescribeWorkspaceDirectories] -> Encoding

ToHeaders DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toHeaders :: DescribeWorkspaceDirectories -> [Header]

ToPath DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toPath :: DescribeWorkspaceDirectories -> ByteString

ToQuery DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toQuery :: DescribeWorkspaceDirectories -> QueryString

AWSPager DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

page :: DescribeWorkspaceDirectories -> AWSResponse DescribeWorkspaceDirectories -> Maybe DescribeWorkspaceDirectories

AWSRequest DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type AWSResponse DescribeWorkspaceDirectories

Methods

request :: (Service -> Service) -> DescribeWorkspaceDirectories -> Request DescribeWorkspaceDirectories

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeWorkspaceDirectories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeWorkspaceDirectories)))

Generic DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type Rep DescribeWorkspaceDirectories :: Type -> Type

Methods

from :: DescribeWorkspaceDirectories -> Rep DescribeWorkspaceDirectories x

to :: Rep DescribeWorkspaceDirectories x -> DescribeWorkspaceDirectories

Read DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectories

readList :: ReadS [DescribeWorkspaceDirectories]

readPrec :: ReadPrec DescribeWorkspaceDirectories

readListPrec :: ReadPrec [DescribeWorkspaceDirectories]

Show DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

showsPrec :: Int -> DescribeWorkspaceDirectories -> ShowS

show :: DescribeWorkspaceDirectories -> String

showList :: [DescribeWorkspaceDirectories] -> ShowS

NFData DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

rnf :: DescribeWorkspaceDirectories -> ()

Eq DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

(==) :: DescribeWorkspaceDirectories -> DescribeWorkspaceDirectories -> Bool

(/=) :: DescribeWorkspaceDirectories -> DescribeWorkspaceDirectories -> Bool

Hashable DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

hashWithSalt :: Int -> DescribeWorkspaceDirectories -> Int

hash :: DescribeWorkspaceDirectories -> Int

type AWSResponse DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type AWSResponse DescribeWorkspaceDirectories = DescribeWorkspaceDirectoriesResponse

type Rep DescribeWorkspaceDirectories

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectories = D1 ('MetaData "DescribeWorkspaceDirectories" "Amazonka.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeWorkspaceDirectories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeWorkspaceDirectories :: DescribeWorkspaceDirectories

Create a value of DescribeWorkspaceDirectories with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directoryIds:DescribeWorkspaceDirectories', describeWorkspaceDirectories_directoryIds - The identifiers of the directories. If the value is null, all directories are retrieved.

$sel:limit:DescribeWorkspaceDirectories', describeWorkspaceDirectories_limit - The maximum number of directories to return.

DescribeWorkspaceDirectories, describeWorkspaceDirectories_nextToken - If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Request Lenses

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

The identifiers of the directories. If the value is null, all directories are retrieved.

describeWorkspaceDirectories_limit :: Lens' DescribeWorkspaceDirectories (Maybe Natural)

The maximum number of directories to return.

describeWorkspaceDirectories_nextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Destructuring the Response

data DescribeWorkspaceDirectoriesResponse

See: newDescribeWorkspaceDirectoriesResponse smart constructor.

Constructors

DescribeWorkspaceDirectoriesResponse'

Fields

• directories :: Maybe [WorkspaceDirectory]

  Information about the directories.

• nextToken :: Maybe Text

  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type Rep DescribeWorkspaceDirectoriesResponse :: Type -> Type

Methods

from :: DescribeWorkspaceDirectoriesResponse -> Rep DescribeWorkspaceDirectoriesResponse x

to :: Rep DescribeWorkspaceDirectoriesResponse x -> DescribeWorkspaceDirectoriesResponse

Read DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectoriesResponse

readList :: ReadS [DescribeWorkspaceDirectoriesResponse]

readPrec :: ReadPrec DescribeWorkspaceDirectoriesResponse

readListPrec :: ReadPrec [DescribeWorkspaceDirectoriesResponse]

Show DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

showsPrec :: Int -> DescribeWorkspaceDirectoriesResponse -> ShowS

show :: DescribeWorkspaceDirectoriesResponse -> String

showList :: [DescribeWorkspaceDirectoriesResponse] -> ShowS

NFData DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

rnf :: DescribeWorkspaceDirectoriesResponse -> ()

Eq DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

(==) :: DescribeWorkspaceDirectoriesResponse -> DescribeWorkspaceDirectoriesResponse -> Bool

(/=) :: DescribeWorkspaceDirectoriesResponse -> DescribeWorkspaceDirectoriesResponse -> Bool

type Rep DescribeWorkspaceDirectoriesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectoriesResponse = D1 ('MetaData "DescribeWorkspaceDirectoriesResponse" "Amazonka.WorkSpaces.DescribeWorkspaceDirectories" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeWorkspaceDirectoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkspaceDirectory])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeWorkspaceDirectoriesResponse

Arguments

:: Int

$sel:httpStatus:DescribeWorkspaceDirectoriesResponse'

-> DescribeWorkspaceDirectoriesResponse

Create a value of DescribeWorkspaceDirectoriesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directories:DescribeWorkspaceDirectoriesResponse', describeWorkspaceDirectoriesResponse_directories - Information about the directories.

DescribeWorkspaceDirectories, describeWorkspaceDirectoriesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeWorkspaceDirectoriesResponse', describeWorkspaceDirectoriesResponse_httpStatus - The response's http status code.

Response Lenses

describeWorkspaceDirectoriesResponse_directories :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe [WorkspaceDirectory])

Information about the directories.

describeWorkspaceDirectoriesResponse_nextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeWorkspaceDirectoriesResponse_httpStatus :: Lens' DescribeWorkspaceDirectoriesResponse Int

The response's http status code.