| 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.IAM.ListSigningCertificates
Description
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.
Although each user is limited to a small number of signing certificates,
you can still paginate the results using the MaxItems and Marker
parameters.
If the UserName field is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this
operation to manage Amazon Web Services account root user credentials
even if the Amazon Web Services account has no associated users.
This operation returns paginated results.
Synopsis
- data ListSigningCertificates = ListSigningCertificates' {}
- newListSigningCertificates :: ListSigningCertificates
- listSigningCertificates_marker :: Lens' ListSigningCertificates (Maybe Text)
- listSigningCertificates_maxItems :: Lens' ListSigningCertificates (Maybe Natural)
- listSigningCertificates_userName :: Lens' ListSigningCertificates (Maybe Text)
- data ListSigningCertificatesResponse = ListSigningCertificatesResponse' {
- isTruncated :: Maybe Bool
- marker :: Maybe Text
- httpStatus :: Int
- certificates :: [SigningCertificate]
- newListSigningCertificatesResponse :: Int -> ListSigningCertificatesResponse
- listSigningCertificatesResponse_isTruncated :: Lens' ListSigningCertificatesResponse (Maybe Bool)
- listSigningCertificatesResponse_marker :: Lens' ListSigningCertificatesResponse (Maybe Text)
- listSigningCertificatesResponse_httpStatus :: Lens' ListSigningCertificatesResponse Int
- listSigningCertificatesResponse_certificates :: Lens' ListSigningCertificatesResponse [SigningCertificate]
Creating a Request
data ListSigningCertificates Source #
See: newListSigningCertificates smart constructor.
Constructors
| ListSigningCertificates' | |
Fields
| |
Instances
newListSigningCertificates :: ListSigningCertificates Source #
Create a value of ListSigningCertificates 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:
ListSigningCertificates, listSigningCertificates_marker - 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.
$sel:maxItems:ListSigningCertificates', listSigningCertificates_maxItems - 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, the number of items 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.
ListSigningCertificates, listSigningCertificates_userName - The name of the IAM user whose signing certificates you want to examine.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Request Lenses
listSigningCertificates_marker :: Lens' ListSigningCertificates (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.
listSigningCertificates_maxItems :: Lens' ListSigningCertificates (Maybe Natural) Source #
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, the number of items 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.
listSigningCertificates_userName :: Lens' ListSigningCertificates (Maybe Text) Source #
The name of the IAM user whose signing certificates you want to examine.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Destructuring the Response
data ListSigningCertificatesResponse Source #
Contains the response to a successful ListSigningCertificates request.
See: newListSigningCertificatesResponse smart constructor.
Constructors
| ListSigningCertificatesResponse' | |
Fields
| |
Instances
newListSigningCertificatesResponse Source #
Create a value of ListSigningCertificatesResponse 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:
ListSigningCertificatesResponse, listSigningCertificatesResponse_isTruncated - 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 your
results.
ListSigningCertificates, listSigningCertificatesResponse_marker - When IsTruncated is true, this element is present and contains the
value to use for the Marker parameter in a subsequent pagination
request.
$sel:httpStatus:ListSigningCertificatesResponse', listSigningCertificatesResponse_httpStatus - The response's http status code.
$sel:certificates:ListSigningCertificatesResponse', listSigningCertificatesResponse_certificates - A list of the user's signing certificate information.
Response Lenses
listSigningCertificatesResponse_isTruncated :: Lens' ListSigningCertificatesResponse (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 your
results.
listSigningCertificatesResponse_marker :: Lens' ListSigningCertificatesResponse (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.
listSigningCertificatesResponse_httpStatus :: Lens' ListSigningCertificatesResponse Int Source #
The response's http status code.
listSigningCertificatesResponse_certificates :: Lens' ListSigningCertificatesResponse [SigningCertificate] Source #
A list of the user's signing certificate information.