untag_resource¶
Operation¶
untag_resource
¶
untag_resource(request: UntagResourceInput | UntagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UntagResourceInputDict]) -> UntagResourceOutput
Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.
Note
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
-
CreateKey
-
ListResourceTags
-
ReplicateKey
-
TagResource
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UntagResourceInput | UntagResourceInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UntagResourceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UntagResourceOutput
|
An instance of |
untag_resource
async
¶
untag_resource(request: UntagResourceInput | UntagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UntagResourceInputDict]) -> UntagResourceOutput
Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.
Note
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
-
CreateKey
-
ListResourceTags
-
ReplicateKey
-
TagResource
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UntagResourceInput | UntagResourceInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UntagResourceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UntagResourceOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UntagResourceInputDict
¶
Bases: TypedDict
Dictionary form of UntagResourceInput.
Attributes¶
key_id
instance-attribute
¶
Identifies the KMS key from which you are removing tags.
Specify the key ID or key ARN of the KMS key.
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 KMS key, use ListKeys or DescribeKey.
UntagResourceInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UntagResourceInput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Identifies the KMS key from which you are removing tags.
Specify the key ID or key ARN of the KMS key.
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 KMS key, use ListKeys or DescribeKey.
Output¶
UntagResourceOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UntagResourceOutput structure.