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 |
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide . This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.
This operation returns paginated results.
Synopsis
- listServerCertificates :: ListServerCertificates
- data ListServerCertificates
- lscPathPrefix :: Lens' ListServerCertificates (Maybe Text)
- lscMarker :: Lens' ListServerCertificates (Maybe Text)
- lscMaxItems :: Lens' ListServerCertificates (Maybe Natural)
- listServerCertificatesResponse :: Int -> ListServerCertificatesResponse
- data ListServerCertificatesResponse
- lscrsMarker :: Lens' ListServerCertificatesResponse (Maybe Text)
- lscrsIsTruncated :: Lens' ListServerCertificatesResponse (Maybe Bool)
- lscrsResponseStatus :: Lens' ListServerCertificatesResponse Int
- lscrsServerCertificateMetadataList :: Lens' ListServerCertificatesResponse [ServerCertificateMetadata]
Creating a Request
listServerCertificates :: ListServerCertificates Source #
Creates a value of ListServerCertificates
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lscPathPrefix
- The path prefix for filtering the results. For example:companyservercerts
would get all server certificates for which the path starts withcompanyservercerts
. This parameter is optional. If it is not included, it defaults to a slash (), listing all server certificates. This parameter allows (per its <http:wikipedia.orgwikiregex regex pattern> ) a string of characters consisting of either a forward slash () by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.lscMarker
- Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker
element in the response that you received to indicate where the next call should start.lscMaxItems
- (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, theIsTruncated
response element istrue
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
data ListServerCertificates Source #
See: listServerCertificates
smart constructor.
Instances
Request Lenses
lscPathPrefix :: Lens' ListServerCertificates (Maybe Text) Source #
The path prefix for filtering the results. For example: companyservercerts
would get all server certificates for which the path starts with companyservercerts
. This parameter is optional. If it is not included, it defaults to a slash (), listing all server certificates. This parameter allows (per its <http:wikipedia.orgwikiregex regex pattern> ) a string of characters consisting of either a forward slash () by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.
lscMarker :: Lens' ListServerCertificates (Maybe Text) Source #
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
lscMaxItems :: Lens' ListServerCertificates (Maybe Natural) Source #
(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated
response element is true
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated
response element returns true
and Marker
contains a value to include in the subsequent call that tells the service where to continue from.
Destructuring the Response
listServerCertificatesResponse Source #
Creates a value of ListServerCertificatesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lscrsMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.lscrsIsTruncated
- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
after every call to ensure that you receive all of your results.lscrsResponseStatus
- -- | The response status code.lscrsServerCertificateMetadataList
- A list of server certificates.
data ListServerCertificatesResponse Source #
Contains the response to a successful ListServerCertificates
request.
See: listServerCertificatesResponse
smart constructor.
Instances
Response Lenses
lscrsMarker :: Lens' ListServerCertificatesResponse (Maybe Text) Source #
When IsTruncated
is true
, this element is present and contains the value to use for the Marker
parameter in a subsequent pagination request.
lscrsIsTruncated :: Lens' ListServerCertificatesResponse (Maybe Bool) Source #
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker
request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We recommend that you check IsTruncated
after every call to ensure that you receive all of your results.
lscrsResponseStatus :: Lens' ListServerCertificatesResponse Int Source #
- - | The response status code.
lscrsServerCertificateMetadataList :: Lens' ListServerCertificatesResponse [ServerCertificateMetadata] Source #
A list of server certificates.