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.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. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

This operation returns paginated results.

Synopsis

data ListCertificates = ListCertificates' {
- certificateStatuses :: Maybe [CertificateStatus]
- includes :: Maybe Filters
- maxItems :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortBy
- sortOrder :: Maybe SortOrder
}
newListCertificates :: ListCertificates
listCertificates_certificateStatuses :: Lens' ListCertificates (Maybe [CertificateStatus])
listCertificates_includes :: Lens' ListCertificates (Maybe Filters)
listCertificates_maxItems :: Lens' ListCertificates (Maybe Natural)
listCertificates_nextToken :: Lens' ListCertificates (Maybe Text)
listCertificates_sortBy :: Lens' ListCertificates (Maybe SortBy)
listCertificates_sortOrder :: Lens' ListCertificates (Maybe SortOrder)
data ListCertificatesResponse = ListCertificatesResponse' {
- certificateSummaryList :: Maybe [CertificateSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListCertificatesResponse :: Int -> ListCertificatesResponse
listCertificatesResponse_certificateSummaryList :: Lens' ListCertificatesResponse (Maybe [CertificateSummary])
listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text)
listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int

Creating a Request

data ListCertificates Source #

See: newListCertificates smart constructor.

Constructors

ListCertificates'

Fields

certificateStatuses :: Maybe [CertificateStatus]
Filter the certificate list by status value.
includes :: Maybe Filters
Filter the certificate list. For more information, see the Filters structure.
maxItems :: 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.
nextToken :: 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.
sortBy :: Maybe SortBy
Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
sortOrder :: Maybe SortOrder
Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Instances

Instances details

ToJSON ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods toJSON :: ListCertificates -> Value # toEncoding :: ListCertificates -> Encoding # toJSONList :: [ListCertificates] -> Value # toEncodingList :: [ListCertificates] -> Encoding #
ToHeaders ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods toHeaders :: ListCertificates -> [Header] #
ToPath ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods toPath :: ListCertificates -> ByteString #
ToQuery ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods toQuery :: ListCertificates -> QueryString #
AWSPager ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods page :: ListCertificates -> AWSResponse ListCertificates -> Maybe ListCertificates #
AWSRequest ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.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.CertificateManager.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.CertificateManager.ListCertificates Methods readsPrec :: Int -> ReadS ListCertificates # readList :: ReadS [ListCertificates] # readPrec :: ReadPrec ListCertificates # readListPrec :: ReadPrec [ListCertificates] #
Show ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods showsPrec :: Int -> ListCertificates -> ShowS # show :: ListCertificates -> String # showList :: [ListCertificates] -> ShowS #
NFData ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods rnf :: ListCertificates -> () #
Eq ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods (==) :: ListCertificates -> ListCertificates -> Bool # (/=) :: ListCertificates -> ListCertificates -> Bool #
Hashable ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods hashWithSalt :: Int -> ListCertificates -> Int # hash :: ListCertificates -> Int #
type AWSResponse ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates type AWSResponse ListCertificates = ListCertificatesResponse
type Rep ListCertificates Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates type Rep ListCertificates = D1 ('MetaData "ListCertificates" "Amazonka.CertificateManager.ListCertificates" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" 'False) (C1 ('MetaCons "ListCertificates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CertificateStatus])) :: (S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Filters)) :: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newListCertificates :: ListCertificates Source #

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:certificateStatuses:ListCertificates', listCertificates_certificateStatuses - Filter the certificate list by status value.

$sel:includes:ListCertificates', listCertificates_includes - Filter the certificate list. For more information, see the Filters structure.

$sel:maxItems:ListCertificates', listCertificates_maxItems - 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.

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

$sel:sortBy:ListCertificates', listCertificates_sortBy - Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

$sel:sortOrder:ListCertificates', listCertificates_sortOrder - Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Request Lenses

listCertificates_certificateStatuses :: Lens' ListCertificates (Maybe [CertificateStatus]) Source #

Filter the certificate list by status value.

listCertificates_includes :: Lens' ListCertificates (Maybe Filters) Source #

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

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

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.

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

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.

listCertificates_sortBy :: Lens' ListCertificates (Maybe SortBy) Source #

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

listCertificates_sortOrder :: Lens' ListCertificates (Maybe SortOrder) Source #

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Destructuring the Response

data ListCertificatesResponse Source #

See: newListCertificatesResponse smart constructor.

Constructors

ListCertificatesResponse'
Fields certificateSummaryList :: Maybe [CertificateSummary] A list of ACM certificates. nextToken :: 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListCertificatesResponse Source #
Instance details Defined in Amazonka.CertificateManager.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.CertificateManager.ListCertificates Methods readsPrec :: Int -> ReadS ListCertificatesResponse # readList :: ReadS [ListCertificatesResponse] # readPrec :: ReadPrec ListCertificatesResponse # readListPrec :: ReadPrec [ListCertificatesResponse] #
Show ListCertificatesResponse Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods showsPrec :: Int -> ListCertificatesResponse -> ShowS # show :: ListCertificatesResponse -> String # showList :: [ListCertificatesResponse] -> ShowS #
NFData ListCertificatesResponse Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods rnf :: ListCertificatesResponse -> () #
Eq ListCertificatesResponse Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates Methods (==) :: ListCertificatesResponse -> ListCertificatesResponse -> Bool # (/=) :: ListCertificatesResponse -> ListCertificatesResponse -> Bool #
type Rep ListCertificatesResponse Source #
Instance details Defined in Amazonka.CertificateManager.ListCertificates type Rep ListCertificatesResponse = D1 ('MetaData "ListCertificatesResponse" "Amazonka.CertificateManager.ListCertificates" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" 'False) (C1 ('MetaCons "ListCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CertificateSummary])) :: (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:certificateSummaryList:ListCertificatesResponse', listCertificatesResponse_certificateSummaryList - A list of ACM certificates.

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

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

Response Lenses

listCertificatesResponse_certificateSummaryList :: Lens' ListCertificatesResponse (Maybe [CertificateSummary]) Source #

A list of ACM certificates.

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

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

listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int Source #

The response's http status code.