AmazonSecretsManagerClient.TagResource Method (TagResourceRequest)

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.

If you use tags as part of your security strategy, then adding or 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:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to TagResourceAsync.

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

Syntax

public virtual TagResourceResponse TagResource(
         TagResourceRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.TagResourceRequest

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

Return Value

Type: TagResourceResponse

The response from the TagResource service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.

To add tags to a secret


var client = new AmazonSecretsManagerClient();
var response = client.TagResource(new TagResourceRequest 
{
    SecretId = "MyExampleSecret",
    Tags = new List<Tag> {
        new Tag {
            Key = "FirstTag",
            Value = "SomeValue"
        },
        new Tag {
            Key = "SecondTag",
            Value = "AnotherValue"
        }
    }
});

Version Information

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

AmazonSecretsManagerClient.TagResource (TagResourceRequest)

Method