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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

This operation returns paginated results.

Creating a Request

data ListCertificates Source #

See: newListCertificates smart constructor.

Constructors

ListCertificates'

Fields

limit :: Maybe Natural
The number of items that should show up on one page
nextToken :: Maybe Text
A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.
directoryId :: Text
The identifier of the directory.

Instances

Instances details

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

newListCertificates Source #

Arguments

:: Text	`ListCertificates`
-> ListCertificates

Create a value of ListCertificates 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:limit:ListCertificates', listCertificates_limit - The number of items that should show up on one page

ListCertificates, listCertificates_nextToken - A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

ListCertificates, listCertificates_directoryId - The identifier of the directory.

Request Lenses

listCertificates_limit :: Lens' ListCertificates (Maybe Natural) Source #

The number of items that should show up on one page

listCertificates_nextToken :: Lens' ListCertificates (Maybe Text) Source #

A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

listCertificates_directoryId :: Lens' ListCertificates Text Source #

The identifier of the directory.

Destructuring the Response

data ListCertificatesResponse Source #

See: newListCertificatesResponse smart constructor.

Constructors

ListCertificatesResponse'
Fields certificatesInfo :: Maybe [CertificateInfo] A list of certificates with basic details including certificate ID, certificate common name, certificate state. nextToken :: Maybe Text Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListCertificatesResponse Source #

Arguments

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

Create a value of ListCertificatesResponse 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:certificatesInfo:ListCertificatesResponse', listCertificatesResponse_certificatesInfo - A list of certificates with basic details including certificate ID, certificate common name, certificate state.

ListCertificates, listCertificatesResponse_nextToken - Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

$sel:httpStatus:ListCertificatesResponse', listCertificatesResponse_httpStatus - The response's http status code.

Response Lenses

listCertificatesResponse_certificatesInfo :: Lens' ListCertificatesResponse (Maybe [CertificateInfo]) Source #

A list of certificates with basic details including certificate ID, certificate common name, certificate state.

listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text) Source #

Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int Source #

The response's http status code.