Amazonka.SecretsManager.TagResource

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.

The following restrictions apply to tags:

• Maximum number of tags per secret: 50
• Maximum key length: 127 Unicode characters in UTF-8
• Maximum value length: 255 Unicode characters in UTF-8
• Tag keys and values are case sensitive.
• Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
• If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

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.

Creating a Request

data TagResource

See: newTagResource smart constructor.

Constructors

TagResource'

Fields

• secretId :: Text

  The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly 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.

• tags :: [Tag]

  The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

  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.

Instances

ToJSON TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

toJSON :: TagResource -> Value

toEncoding :: TagResource -> Encoding

toJSONList :: [TagResource] -> Value

toEncodingList :: [TagResource] -> Encoding

ToHeaders TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

toHeaders :: TagResource -> [Header]

ToPath TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

toPath :: TagResource -> ByteString

ToQuery TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

toQuery :: TagResource -> QueryString

AWSRequest TagResource

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type AWSResponse TagResource

Methods

request :: (Service -> Service) -> TagResource -> Request TagResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource)))

Generic TagResource

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResource :: Type -> Type

Methods

from :: TagResource -> Rep TagResource x

to :: Rep TagResource x -> TagResource

Read TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

readsPrec :: Int -> ReadS TagResource

readList :: ReadS [TagResource]

readPrec :: ReadPrec TagResource

readListPrec :: ReadPrec [TagResource]

Show TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

showsPrec :: Int -> TagResource -> ShowS

show :: TagResource -> String

showList :: [TagResource] -> ShowS

NFData TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResource -> ()

Eq TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

(==) :: TagResource -> TagResource -> Bool

(/=) :: TagResource -> TagResource -> Bool

Hashable TagResource

Defined in Amazonka.SecretsManager.TagResource

Methods

hashWithSalt :: Int -> TagResource -> Int

hash :: TagResource -> Int

type AWSResponse TagResource

Defined in Amazonka.SecretsManager.TagResource

type AWSResponse TagResource = TagResourceResponse

type Rep TagResource

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.SecretsManager.TagResource" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newTagResource

Arguments

:: Text

$sel:secretId:TagResource'

-> TagResource

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:TagResource', tagResource_secretId - The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly 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.

TagResource, tagResource_tags - The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

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.

Request Lenses

tagResource_secretId :: Lens' TagResource Text

The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly 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.

tagResource_tags :: Lens' TagResource [Tag]

The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

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.

Destructuring the Response

data TagResourceResponse

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Generic TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type

Methods

from :: TagResourceResponse -> Rep TagResourceResponse x

to :: Rep TagResourceResponse x -> TagResourceResponse

Read TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

Methods

readsPrec :: Int -> ReadS TagResourceResponse

readList :: ReadS [TagResourceResponse]

readPrec :: ReadPrec TagResourceResponse

readListPrec :: ReadPrec [TagResourceResponse]

Show TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

Methods

showsPrec :: Int -> TagResourceResponse -> ShowS

show :: TagResourceResponse -> String

showList :: [TagResourceResponse] -> ShowS

NFData TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

Methods

rnf :: TagResourceResponse -> ()

Eq TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

Methods

(==) :: TagResourceResponse -> TagResourceResponse -> Bool

(/=) :: TagResourceResponse -> TagResourceResponse -> Bool

type Rep TagResourceResponse

Defined in Amazonka.SecretsManager.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.SecretsManager.TagResource" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.