AWS Certificate Manager

Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM Certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Request Syntax

client.add_tags_to_certificate(
    CertificateArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

type Tags:

list

param Tags:

[REQUIRED]

The key-value pair that defines the tag. The tag value is optional.

• (dict) --

  A key-value pair that identifies or specifies metadata about an ACM resource.

  • Key (string) -- [REQUIRED]

    The key of the tag.

  • Value (string) --

    The value of the tag.

returns:

None

Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.

To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM Certificate, use the ListTagsForCertificate action.

Request Syntax

client.remove_tags_from_certificate(
    CertificateArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

type Tags:

list

param Tags:

[REQUIRED]

The key-value pair that defines the tag to remove.

• (dict) --

  A key-value pair that identifies or specifies metadata about an ACM resource.

  • Key (string) -- [REQUIRED]

    The key of the tag.

  • Value (string) --

    The value of the tag.

returns:

None

Lists the tags that have been applied to the ACM Certificate. Use the certificate ARN to specify the certificate. To add a tag to an ACM Certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

Request Syntax

client.list_tags_for_certificate(
    CertificateArn='string'
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

String that contains the ARN of the ACM Certificate for which you want to list the tags. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • Tags (list) --

    The key-value pairs that define the applied tags.

    • (dict) --

      A key-value pair that identifies or specifies metadata about an ACM resource.

      • Key (string) --

        The key of the tag.

      • Value (string) --

        The value of the tag.