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.DirectoryService.DescribeDomainControllers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about any domain controllers in your directory.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDomainControllers Source #

See: newDescribeDomainControllers smart constructor.

Constructors

DescribeDomainControllers'

Fields

domainControllerIds :: Maybe [Text]
A list of identifiers for the domain controllers whose information will be provided.
limit :: Maybe Natural
The maximum number of items to return.
nextToken :: Maybe Text
The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
directoryId :: Text
Identifier of the directory for which to retrieve the domain controller information.

Instances

Instances details

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

newDescribeDomainControllers Source #

Arguments

:: Text	`DescribeDomainControllers`
-> DescribeDomainControllers

Create a value of DescribeDomainControllers 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:domainControllerIds:DescribeDomainControllers', describeDomainControllers_domainControllerIds - A list of identifiers for the domain controllers whose information will be provided.

$sel:limit:DescribeDomainControllers', describeDomainControllers_limit - The maximum number of items to return.

DescribeDomainControllers, describeDomainControllers_nextToken - The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

DescribeDomainControllers, describeDomainControllers_directoryId - Identifier of the directory for which to retrieve the domain controller information.

Request Lenses

describeDomainControllers_domainControllerIds :: Lens' DescribeDomainControllers (Maybe [Text]) Source #

A list of identifiers for the domain controllers whose information will be provided.

describeDomainControllers_limit :: Lens' DescribeDomainControllers (Maybe Natural) Source #

The maximum number of items to return.

describeDomainControllers_nextToken :: Lens' DescribeDomainControllers (Maybe Text) Source #

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

describeDomainControllers_directoryId :: Lens' DescribeDomainControllers Text Source #

Identifier of the directory for which to retrieve the domain controller information.

Destructuring the Response

data DescribeDomainControllersResponse Source #

See: newDescribeDomainControllersResponse smart constructor.

Constructors

DescribeDomainControllersResponse'
Fields domainControllers :: Maybe [DomainController] List of the DomainController objects that were retrieved. nextToken :: Maybe Text If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDomainControllersResponse Source #

Arguments

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

Create a value of DescribeDomainControllersResponse 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:domainControllers:DescribeDomainControllersResponse', describeDomainControllersResponse_domainControllers - List of the DomainController objects that were retrieved.

DescribeDomainControllers, describeDomainControllersResponse_nextToken - If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

$sel:httpStatus:DescribeDomainControllersResponse', describeDomainControllersResponse_httpStatus - The response's http status code.

Response Lenses

describeDomainControllersResponse_domainControllers :: Lens' DescribeDomainControllersResponse (Maybe [DomainController]) Source #

List of the DomainController objects that were retrieved.

describeDomainControllersResponse_nextToken :: Lens' DescribeDomainControllersResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

describeDomainControllersResponse_httpStatus :: Lens' DescribeDomainControllersResponse Int Source #

The response's http status code.