| Copyright | (c) 2013-2021 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 |
Amazonka.CertificateManager.ListCertificates
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' {}
- newListCertificates :: ListCertificates
- listCertificates_certificateStatuses :: Lens' ListCertificates (Maybe [CertificateStatus])
- listCertificates_nextToken :: Lens' ListCertificates (Maybe Text)
- listCertificates_includes :: Lens' ListCertificates (Maybe Filters)
- listCertificates_maxItems :: Lens' ListCertificates (Maybe Natural)
- data ListCertificatesResponse = ListCertificatesResponse' {}
- 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
| |
Instances
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:nextToken: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: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.
Request Lenses
listCertificates_certificateStatuses :: Lens' ListCertificates (Maybe [CertificateStatus]) Source #
Filter the certificate list by status value.
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_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.
Destructuring the Response
data ListCertificatesResponse Source #
See: newListCertificatesResponse smart constructor.
Constructors
| ListCertificatesResponse' | |
Fields
| |
Instances
newListCertificatesResponse Source #
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.
$sel:nextToken: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.