ACMPCA / Client / tag_certificate_authority
tag_certificate_authority#
- ACMPCA.Client.tag_certificate_authority(**kwargs)#
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
Note
To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the
CreateCertificateAuthority
action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation.See also: AWS API Documentation
Request Syntax
response = client.tag_certificate_authority( CertificateAuthorityArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
- Parameters:
CertificateAuthorityArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Tags (list) –
[REQUIRED]
List of tags to be associated with the 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) – [REQUIRED]
Key (name) of the tag.
Value (string) –
Value of the tag.
- Returns:
None
Exceptions