libZSservicesZSamazonka-workspacesZSamazonka-workspaces
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Description

Describes the available directories that are registered with Amazon WorkSpaces.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeWorkspaceDirectories Source #

See: newDescribeWorkspaceDirectories smart constructor.

Constructors

DescribeWorkspaceDirectories' 

Fields

  • 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.

  • 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.

Instances

Instances details
Eq DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

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

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

Read DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectories #

readList :: ReadS [DescribeWorkspaceDirectories] #

readPrec :: ReadPrec DescribeWorkspaceDirectories #

readListPrec :: ReadPrec [DescribeWorkspaceDirectories] #

Show DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

showsPrec :: Int -> DescribeWorkspaceDirectories -> ShowS #

show :: DescribeWorkspaceDirectories -> String #

showList :: [DescribeWorkspaceDirectories] -> ShowS #

Generic DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type Rep DescribeWorkspaceDirectories :: Type -> Type #

Methods

from :: DescribeWorkspaceDirectories -> Rep DescribeWorkspaceDirectories x #

to :: Rep DescribeWorkspaceDirectories x -> DescribeWorkspaceDirectories #

NFData DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

rnf :: DescribeWorkspaceDirectories -> () #

Hashable DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

hashWithSalt :: Int -> DescribeWorkspaceDirectories -> Int #

hash :: DescribeWorkspaceDirectories -> Int #

ToJSON DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toJSON :: DescribeWorkspaceDirectories -> Value #

toEncoding :: DescribeWorkspaceDirectories -> Encoding #

toJSONList :: [DescribeWorkspaceDirectories] -> Value #

toEncodingList :: [DescribeWorkspaceDirectories] -> Encoding #

AWSPager DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

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

AWSRequest DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type AWSResponse DescribeWorkspaceDirectories #

Methods

request :: DescribeWorkspaceDirectories -> Request DescribeWorkspaceDirectories #

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

ToHeaders DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toHeaders :: DescribeWorkspaceDirectories -> [Header] #

ToPath DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toPath :: DescribeWorkspaceDirectories -> ByteString #

ToQuery DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

toQuery :: DescribeWorkspaceDirectories -> QueryString #

type Rep DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectories = D1 ('MetaData "DescribeWorkspaceDirectories" "Amazonka.WorkSpaces.DescribeWorkspaceDirectories" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "DescribeWorkspaceDirectories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "directoryIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeWorkspaceDirectories Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type AWSResponse DescribeWorkspaceDirectories = DescribeWorkspaceDirectoriesResponse

newDescribeWorkspaceDirectories :: DescribeWorkspaceDirectories Source #

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:nextToken: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.

$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.

Request Lenses

describeWorkspaceDirectories_nextToken :: Lens' DescribeWorkspaceDirectories (Maybe Text) Source #

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

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

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

describeWorkspaceDirectories_limit :: Lens' DescribeWorkspaceDirectories (Maybe Natural) Source #

The maximum number of directories to return.

Destructuring the Response

data DescribeWorkspaceDirectoriesResponse Source #

See: newDescribeWorkspaceDirectoriesResponse smart constructor.

Constructors

DescribeWorkspaceDirectoriesResponse' 

Fields

Instances

Instances details
Eq DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

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

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

Read DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceDirectoriesResponse #

readList :: ReadS [DescribeWorkspaceDirectoriesResponse] #

readPrec :: ReadPrec DescribeWorkspaceDirectoriesResponse #

readListPrec :: ReadPrec [DescribeWorkspaceDirectoriesResponse] #

Show DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

showsPrec :: Int -> DescribeWorkspaceDirectoriesResponse -> ShowS #

show :: DescribeWorkspaceDirectoriesResponse -> String #

showList :: [DescribeWorkspaceDirectoriesResponse] -> ShowS #

Generic DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Associated Types

type Rep DescribeWorkspaceDirectoriesResponse :: Type -> Type #

Methods

from :: DescribeWorkspaceDirectoriesResponse -> Rep DescribeWorkspaceDirectoriesResponse x #

to :: Rep DescribeWorkspaceDirectoriesResponse x -> DescribeWorkspaceDirectoriesResponse #

NFData DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

Methods

rnf :: DescribeWorkspaceDirectoriesResponse -> () #

type Rep DescribeWorkspaceDirectoriesResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.DescribeWorkspaceDirectories

type Rep DescribeWorkspaceDirectoriesResponse = D1 ('MetaData "DescribeWorkspaceDirectoriesResponse" "Amazonka.WorkSpaces.DescribeWorkspaceDirectories" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" '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 Source #

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.

$sel:nextToken: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]) Source #

Information about the directories.

describeWorkspaceDirectoriesResponse_nextToken :: Lens' DescribeWorkspaceDirectoriesResponse (Maybe Text) Source #

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 Source #

The response's http status code.