Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CertificateManager.ListCertificates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

This operation returns paginated results.

Creating a Request

listCertificates :: ListCertificates #

Creates a value of ListCertificates with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcCertificateStatuses - Filter the certificate list by status value.
lcNextToken - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
lcIncludes - Filter the certificate list. For more information, see the Filters structure.
lcMaxItems - Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

data ListCertificates #

See: listCertificates smart constructor.

Instances

Eq ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods (==) :: ListCertificates -> ListCertificates -> Bool # (/=) :: ListCertificates -> ListCertificates -> Bool #
Data ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListCertificates -> c ListCertificates # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListCertificates # toConstr :: ListCertificates -> Constr # dataTypeOf :: ListCertificates -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListCertificates) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListCertificates) # gmapT :: (forall b. Data b => b -> b) -> ListCertificates -> ListCertificates # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListCertificates -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListCertificates -> r # gmapQ :: (forall d. Data d => d -> u) -> ListCertificates -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListCertificates -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListCertificates -> m ListCertificates # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListCertificates -> m ListCertificates # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListCertificates -> m ListCertificates #
Read ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods readsPrec :: Int -> ReadS ListCertificates # readList :: ReadS [ListCertificates] # readPrec :: ReadPrec ListCertificates # readListPrec :: ReadPrec [ListCertificates] #
Show ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods showsPrec :: Int -> ListCertificates -> ShowS # show :: ListCertificates -> String # showList :: [ListCertificates] -> ShowS #
Generic ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Associated Types type Rep ListCertificates :: * -> * # Methods from :: ListCertificates -> Rep ListCertificates x # to :: Rep ListCertificates x -> ListCertificates #
Hashable ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods hashWithSalt :: Int -> ListCertificates -> Int # hash :: ListCertificates -> Int #
ToJSON ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods toJSON :: ListCertificates -> Value # toEncoding :: ListCertificates -> Encoding # toJSONList :: [ListCertificates] -> Value # toEncodingList :: [ListCertificates] -> Encoding #
AWSPager ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods page :: ListCertificates -> Rs ListCertificates -> Maybe ListCertificates #
AWSRequest ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Associated Types type Rs ListCertificates :: * # Methods request :: ListCertificates -> Request ListCertificates # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListCertificates -> ClientResponse -> m (Response ListCertificates) #
ToHeaders ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods toHeaders :: ListCertificates -> [Header] #
ToPath ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods toPath :: ListCertificates -> ByteString #
ToQuery ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods toQuery :: ListCertificates -> QueryString #
NFData ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods rnf :: ListCertificates -> () #
type Rep ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates type Rep ListCertificates = D1 (MetaData "ListCertificates" "Network.AWS.CertificateManager.ListCertificates" "amazonka-certificatemanager-1.6.0-7JB8JsCwrfRJtf8W91f9vY" False) (C1 (MetaCons "ListCertificates'" PrefixI True) ((S1 (MetaSel (Just "_lcCertificateStatuses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CertificateStatus])) :: S1 (MetaSel (Just "_lcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lcIncludes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Filters)) :*: S1 (MetaSel (Just "_lcMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs ListCertificates #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates type Rs ListCertificates = ListCertificatesResponse

Request Lenses

lcCertificateStatuses :: Lens' ListCertificates [CertificateStatus] #

Filter the certificate list by status value.

lcNextToken :: Lens' ListCertificates (Maybe Text) #

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

lcIncludes :: Lens' ListCertificates (Maybe Filters) #

Filter the certificate list. For more information, see the Filters structure.

lcMaxItems :: Lens' ListCertificates (Maybe Natural) #

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Destructuring the Response

listCertificatesResponse #

Arguments

:: Int	`lcrsResponseStatus`
-> ListCertificatesResponse

Creates a value of ListCertificatesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcrsCertificateSummaryList - A list of ACM certificates.
lcrsNextToken - When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
lcrsResponseStatus - -- | The response status code.

data ListCertificatesResponse #

See: listCertificatesResponse smart constructor.

Instances

Eq ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods (==) :: ListCertificatesResponse -> ListCertificatesResponse -> Bool # (/=) :: ListCertificatesResponse -> ListCertificatesResponse -> Bool #
Data ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListCertificatesResponse -> c ListCertificatesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListCertificatesResponse # toConstr :: ListCertificatesResponse -> Constr # dataTypeOf :: ListCertificatesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListCertificatesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListCertificatesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListCertificatesResponse -> ListCertificatesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListCertificatesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListCertificatesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListCertificatesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListCertificatesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListCertificatesResponse -> m ListCertificatesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListCertificatesResponse -> m ListCertificatesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListCertificatesResponse -> m ListCertificatesResponse #
Read ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods readsPrec :: Int -> ReadS ListCertificatesResponse # readList :: ReadS [ListCertificatesResponse] # readPrec :: ReadPrec ListCertificatesResponse # readListPrec :: ReadPrec [ListCertificatesResponse] #
Show ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods showsPrec :: Int -> ListCertificatesResponse -> ShowS # show :: ListCertificatesResponse -> String # showList :: [ListCertificatesResponse] -> ShowS #
Generic ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Associated Types type Rep ListCertificatesResponse :: * -> * # Methods from :: ListCertificatesResponse -> Rep ListCertificatesResponse x # to :: Rep ListCertificatesResponse x -> ListCertificatesResponse #
NFData ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates Methods rnf :: ListCertificatesResponse -> () #
type Rep ListCertificatesResponse #
Instance details Defined in Network.AWS.CertificateManager.ListCertificates type Rep ListCertificatesResponse = D1 (MetaData "ListCertificatesResponse" "Network.AWS.CertificateManager.ListCertificates" "amazonka-certificatemanager-1.6.0-7JB8JsCwrfRJtf8W91f9vY" False) (C1 (MetaCons "ListCertificatesResponse'" PrefixI True) (S1 (MetaSel (Just "_lcrsCertificateSummaryList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CertificateSummary])) :: (S1 (MetaSel (Just "_lcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lcrsCertificateSummaryList :: Lens' ListCertificatesResponse [CertificateSummary] #

A list of ACM certificates.

lcrsNextToken :: Lens' ListCertificatesResponse (Maybe Text) #

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

lcrsResponseStatus :: Lens' ListCertificatesResponse Int #

- | The response status code.