ACMPCA / Client / list_tags

list_tags#

ACMPCA.Client.list_tags(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    CertificateAuthorityArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • CertificateAuthorityArn (string) –

    [REQUIRED]

    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

  • NextToken (string) – 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.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Tags (list) –

      The tags associated with your private CA.

      • (dict) –

        Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.

        • Key (string) –

          Key (name) of the tag.

        • Value (string) –

          Value of the tag.

    • NextToken (string) –

      When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Exceptions

  • ACMPCA.Client.exceptions.ResourceNotFoundException

  • ACMPCA.Client.exceptions.InvalidArnException

  • ACMPCA.Client.exceptions.InvalidStateException