Container for the parameters to the UntagResource operation.
Deletes tags from a customer
managed key. To delete a tag, specify the tag key and the KMS key.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details,
see ABAC
for KMS in the Key Management Service Developer Guide.
When it succeeds, the UntagResource operation doesn't return any output. Also,
if the specified tag key isn't found on the KMS key, it doesn't throw an exception
or return a response. To confirm that the operation worked, use the ListResourceTags
operation.
For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:UntagResource (key policy)
Related operations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.UntagResourceRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class UntagResourceRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The UntagResourceRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UntagResourceRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Identifies the KMS key from which you are removing tags. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
TagKeys | System.Collections.Generic.List<System.String> |
Gets and sets the property TagKeys. One or more tag keys. Specify only the tag keys, not the tag values. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
Examples
The following example removes tags from a KMS key.
To remove tags from a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.UntagResource(new UntagResourceRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key whose tags you are removing.
TagKeys = new List<string> {
"Purpose",
"CostCenter"
} // A list of tag keys. Provide only the tag keys, not the tag values.
});
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer