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.

Removes the specified tag or tags from the specified customer master key (CMK).

To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.

Note:

For PCL this operation is only available in asynchronous form. Please refer to UntagResourceAsync.

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

Syntax

C#
public abstract UntagResourceResponse UntagResource(
         UntagResourceRequest request
)
Parameters
request
Type: Amazon.KeyManagementService.Model.UntagResourceRequest

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

Return Value
The response from the UntagResource service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
InvalidArnException The request was rejected because a specified ARN was not valid.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
NotFoundException The request was rejected because the specified entity or resource could not be found.
TagException The request was rejected because one or more tags are not valid.

Examples

The following example removes tags from a CMK.

To remove tags from a customer master key (CMK)


var response = client.UntagResource(new UntagResourceRequest 
{
    KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK whose tags you are removing.
    TagKeys = new List {
        "Purpose",
        "CostCenter"
    } // A list of tag keys. Provide only the tag keys, not the tag values.
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also