| 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.CertificateManagerPCA.ListTags
Description
Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
This operation returns paginated results.
Synopsis
- data ListTags = ListTags' {}
- newListTags :: Text -> ListTags
- listTags_nextToken :: Lens' ListTags (Maybe Text)
- listTags_maxResults :: Lens' ListTags (Maybe Natural)
- listTags_certificateAuthorityArn :: Lens' ListTags Text
- data ListTagsResponse = ListTagsResponse' {}
- newListTagsResponse :: Int -> ListTagsResponse
- listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text)
- listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (NonEmpty Tag))
- listTagsResponse_httpStatus :: Lens' ListTagsResponse Int
Creating a Request
See: newListTags smart constructor.
Constructors
| ListTags' | |
Fields
| |
Instances
Create a value of ListTags 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:nextToken:ListTags', listTags_nextToken - Use this parameter when paginating results 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:maxResults:ListTags', listTags_maxResults - 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.
$sel:certificateAuthorityArn:ListTags', listTags_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called the
CreateCertificateAuthority
action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Request Lenses
listTags_nextToken :: Lens' ListTags (Maybe Text) Source #
Use this parameter when paginating results 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.
listTags_maxResults :: Lens' ListTags (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.
listTags_certificateAuthorityArn :: Lens' ListTags Text Source #
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Destructuring the Response
data ListTagsResponse Source #
See: newListTagsResponse smart constructor.
Constructors
| ListTagsResponse' | |
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse 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:nextToken:ListTags', listTagsResponse_nextToken - When the list is truncated, this value is present and should be used for
the NextToken parameter in a subsequent pagination request.
$sel:tags:ListTagsResponse', listTagsResponse_tags - The tags associated with your private CA.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
Response Lenses
listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #
When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (NonEmpty Tag)) Source #
The tags associated with your private CA.
listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #
The response's http status code.