Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudDirectory.ListDirectories

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists directories created within an account.

This operation returns paginated results.

Creating a Request

data ListDirectories Source #

See: newListDirectories smart constructor.

Constructors

ListDirectories'
Fields maxResults :: Maybe Natural The maximum number of results to retrieve. nextToken :: Maybe Text The pagination token. state :: Maybe DirectoryState The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Instances

Instances details

ToJSON ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods toJSON :: ListDirectories -> Value # toEncoding :: ListDirectories -> Encoding # toJSONList :: [ListDirectories] -> Value # toEncodingList :: [ListDirectories] -> Encoding #
ToHeaders ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods toHeaders :: ListDirectories -> [Header] #
ToPath ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods toPath :: ListDirectories -> ByteString #
ToQuery ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods toQuery :: ListDirectories -> QueryString #
AWSPager ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods page :: ListDirectories -> AWSResponse ListDirectories -> Maybe ListDirectories #
AWSRequest ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Associated Types type AWSResponse ListDirectories # Methods request :: (Service -> Service) -> ListDirectories -> Request ListDirectories # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDirectories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDirectories))) #
Generic ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Associated Types type Rep ListDirectories :: Type -> Type # Methods from :: ListDirectories -> Rep ListDirectories x # to :: Rep ListDirectories x -> ListDirectories #
Read ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods readsPrec :: Int -> ReadS ListDirectories # readList :: ReadS [ListDirectories] # readPrec :: ReadPrec ListDirectories # readListPrec :: ReadPrec [ListDirectories] #
Show ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods showsPrec :: Int -> ListDirectories -> ShowS # show :: ListDirectories -> String # showList :: [ListDirectories] -> ShowS #
NFData ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods rnf :: ListDirectories -> () #
Eq ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods (==) :: ListDirectories -> ListDirectories -> Bool # (/=) :: ListDirectories -> ListDirectories -> Bool #
Hashable ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods hashWithSalt :: Int -> ListDirectories -> Int # hash :: ListDirectories -> Int #
type AWSResponse ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories type AWSResponse ListDirectories = ListDirectoriesResponse
type Rep ListDirectories Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories type Rep ListDirectories = D1 ('MetaData "ListDirectories" "Amazonka.CloudDirectory.ListDirectories" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListDirectories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryState)))))

newListDirectories :: ListDirectories Source #

Create a value of ListDirectories 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:

ListDirectories, listDirectories_maxResults - The maximum number of results to retrieve.

ListDirectories, listDirectories_nextToken - The pagination token.

ListDirectories, listDirectories_state - The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Request Lenses

listDirectories_maxResults :: Lens' ListDirectories (Maybe Natural) Source #

The maximum number of results to retrieve.

listDirectories_nextToken :: Lens' ListDirectories (Maybe Text) Source #

The pagination token.

listDirectories_state :: Lens' ListDirectories (Maybe DirectoryState) Source #

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Destructuring the Response

data ListDirectoriesResponse Source #

See: newListDirectoriesResponse smart constructor.

Constructors

ListDirectoriesResponse'
Fields nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code. directories :: [Directory] Lists all directories that are associated with your account in pagination fashion.

Instances

Instances details

Generic ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Associated Types type Rep ListDirectoriesResponse :: Type -> Type # Methods from :: ListDirectoriesResponse -> Rep ListDirectoriesResponse x # to :: Rep ListDirectoriesResponse x -> ListDirectoriesResponse #
Read ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods readsPrec :: Int -> ReadS ListDirectoriesResponse # readList :: ReadS [ListDirectoriesResponse] # readPrec :: ReadPrec ListDirectoriesResponse # readListPrec :: ReadPrec [ListDirectoriesResponse] #
Show ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods showsPrec :: Int -> ListDirectoriesResponse -> ShowS # show :: ListDirectoriesResponse -> String # showList :: [ListDirectoriesResponse] -> ShowS #
NFData ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods rnf :: ListDirectoriesResponse -> () #
Eq ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories Methods (==) :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool # (/=) :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool #
type Rep ListDirectoriesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListDirectories type Rep ListDirectoriesResponse = D1 ('MetaData "ListDirectoriesResponse" "Amazonka.CloudDirectory.ListDirectories" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListDirectoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "directories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Directory]))))

newListDirectoriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDirectoriesResponse'`
-> ListDirectoriesResponse

Create a value of ListDirectoriesResponse 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:

ListDirectories, listDirectoriesResponse_nextToken - The pagination token.

$sel:httpStatus:ListDirectoriesResponse', listDirectoriesResponse_httpStatus - The response's http status code.

$sel:directories:ListDirectoriesResponse', listDirectoriesResponse_directories - Lists all directories that are associated with your account in pagination fashion.

Response Lenses

listDirectoriesResponse_nextToken :: Lens' ListDirectoriesResponse (Maybe Text) Source #

The pagination token.

listDirectoriesResponse_httpStatus :: Lens' ListDirectoriesResponse Int Source #

The response's http status code.

listDirectoriesResponse_directories :: Lens' ListDirectoriesResponse [Directory] Source #

Lists all directories that are associated with your account in pagination fashion.