Container for the parameters to the UntagResource operation. Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource. For more information,
see
IAM policy actions for Secrets Manager and Authentication
and access control in Secrets Manager.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.UntagResourceRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class UntagResourceRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The UntagResourceRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UntagResourceRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
SecretId | System.String |
Gets and sets the property SecretId. The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN. |
|
|
TagKeys | System.Collections.Generic.List<System.String> |
Gets and sets the property TagKeys. A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. |
Examples
The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.
To remove tags from a secret
var client = new AmazonSecretsManagerClient();
var response = client.UntagResource(new UntagResourceRequest
{
SecretId = "MyTestDatabaseSecret",
TagKeys = new List<string> {
"FirstTag",
"SecondTag"
}
});
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5