com.amazonaws.services.kms.model

Class UntagResourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.UntagResourceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UntagResourceRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Deletes tags from a customer managed CMK. To delete a tag, specify the tag key and the CMK.

When it succeeds, the UntagResource operation doesn't return any output. Also, if the specified tag key isn't found on the CMK, it doesn't throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.

For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:UntagResource (key policy)

Related operations

• TagResource

• ListResourceTags

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UntagResourceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getKeyId() Identifies the CMK from which you are removing tags.
java.util.List<java.lang.String>	getTagKeys() One or more tag keys.
int	hashCode()
void	setKeyId(java.lang.String keyId) Identifies the CMK from which you are removing tags.
void	setTagKeys(java.util.Collection<java.lang.String> tagKeys) One or more tag keys.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UntagResourceRequest	withKeyId(java.lang.String keyId) Identifies the CMK from which you are removing tags.
UntagResourceRequest	withTagKeys(java.util.Collection<java.lang.String> tagKeys) One or more tag keys.
UntagResourceRequest	withTagKeys(java.lang.String... tagKeys) One or more tag keys.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UntagResourceRequest

public UntagResourceRequest()

Method Detail

getKeyId

public java.lang.String getKeyId()

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Returns:

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

setKeyId

public void setKeyId(java.lang.String keyId)

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Parameters:

keyId -

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

withKeyId

public UntagResourceRequest withKeyId(java.lang.String keyId)

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2048

Parameters:

keyId -

Identifies the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

A reference to this updated object so that method calls can be chained together.

getTagKeys

public java.util.List<java.lang.String> getTagKeys()

One or more tag keys. Specify only the tag keys, not the tag values.

Returns:

One or more tag keys. Specify only the tag keys, not the tag values.

setTagKeys

public void setTagKeys(java.util.Collection<java.lang.String> tagKeys)

One or more tag keys. Specify only the tag keys, not the tag values.

Parameters:

tagKeys -

One or more tag keys. Specify only the tag keys, not the tag values.

withTagKeys

public UntagResourceRequest withTagKeys(java.lang.String... tagKeys)

One or more tag keys. Specify only the tag keys, not the tag values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tagKeys -

One or more tag keys. Specify only the tag keys, not the tag values.

Returns:

A reference to this updated object so that method calls can be chained together.

withTagKeys

public UntagResourceRequest withTagKeys(java.util.Collection<java.lang.String> tagKeys)

One or more tag keys. Specify only the tag keys, not the tag values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tagKeys -

One or more tag keys. Specify only the tag keys, not the tag values.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object