AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginTagCertificateAuthority and EndTagCertificateAuthority.

Namespace: Amazon.ACMPCA
Assembly: AWSSDK.ACMPCA.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<TagCertificateAuthorityResponse> TagCertificateAuthorityAsync(
         TagCertificateAuthorityRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ACMPCA.Model.TagCertificateAuthorityRequest

Container for the necessary parameters to execute the TagCertificateAuthority service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the TagCertificateAuthority service method, as returned by ACMPCA.

Exceptions

ExceptionCondition
InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidStateException The state of the private CA does not allow this action to occur.
InvalidTagException The tag associated with the CA is not valid. The invalid argument is contained in the message field.
ResourceNotFoundException A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.
TooManyTagsException You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also