Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecretsManager.UntagResource

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Removes one or more tags from the specified 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.

Minimum permissions

To run this command, you must have the following permissions:

secretsmanager:UntagResource

Related operations

To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.

Synopsis

data UntagResource = UntagResource' {
- secretId :: Text
- tagKeys :: [Text]
}
newUntagResource :: Text -> UntagResource
untagResource_secretId :: Lens' UntagResource Text
untagResource_tagKeys :: Lens' UntagResource [Text]
data UntagResourceResponse = UntagResourceResponse' {
}
newUntagResourceResponse :: UntagResourceResponse

Creating a Request

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource'

Fields

secretId :: Text
The identifier for the secret that you want to remove tags from. 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.
tagKeys :: [Text]
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 to the API 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.

Instances

Instances details

Eq UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods (==) :: UntagResource -> UntagResource -> Bool # (/=) :: UntagResource -> UntagResource -> Bool #
Read UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods readsPrec :: Int -> ReadS UntagResource # readList :: ReadS [UntagResource] # readPrec :: ReadPrec UntagResource # readListPrec :: ReadPrec [UntagResource] #
Show UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods showsPrec :: Int -> UntagResource -> ShowS # show :: UntagResource -> String # showList :: [UntagResource] -> ShowS #
Generic UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Associated Types type Rep UntagResource :: Type -> Type # Methods from :: UntagResource -> Rep UntagResource x # to :: Rep UntagResource x -> UntagResource #
NFData UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods rnf :: UntagResource -> () #
Hashable UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods hashWithSalt :: Int -> UntagResource -> Int # hash :: UntagResource -> Int #
ToJSON UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods toJSON :: UntagResource -> Value # toEncoding :: UntagResource -> Encoding # toJSONList :: [UntagResource] -> Value # toEncodingList :: [UntagResource] -> Encoding #
AWSRequest UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Associated Types type AWSResponse UntagResource # Methods request :: UntagResource -> Request UntagResource # response :: MonadResource m => Logger -> Service -> Proxy UntagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UntagResource))) #
ToHeaders UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods toHeaders :: UntagResource -> [Header] #
ToPath UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods toPath :: UntagResource -> ByteString #
ToQuery UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods toQuery :: UntagResource -> QueryString #
type Rep UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.SecretsManager.UntagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse UntagResource Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource type AWSResponse UntagResource = UntagResourceResponse

newUntagResource Source #

Arguments

:: Text	`$sel:secretId:UntagResource'`
-> UntagResource

Create a value of UntagResource 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:UntagResource', untagResource_secretId - The identifier for the secret that you want to remove tags from. 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.

$sel:tagKeys:UntagResource', untagResource_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 to the API 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.

Request Lenses

untagResource_secretId :: Lens' UntagResource Text Source #

The identifier for the secret that you want to remove tags from. 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.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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 to the API 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.

Destructuring the Response

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Constructors

UntagResourceResponse'

Instances

Instances details

Eq UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool #
Read UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods readsPrec :: Int -> ReadS UntagResourceResponse # readList :: ReadS [UntagResourceResponse] # readPrec :: ReadPrec UntagResourceResponse # readListPrec :: ReadPrec [UntagResourceResponse] #
Show UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS #
Generic UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Associated Types type Rep UntagResourceResponse :: Type -> Type # Methods from :: UntagResourceResponse -> Rep UntagResourceResponse x # to :: Rep UntagResourceResponse x -> UntagResourceResponse #
NFData UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource Methods rnf :: UntagResourceResponse -> () #
type Rep UntagResourceResponse Source #
Instance details Defined in Amazonka.SecretsManager.UntagResource type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.SecretsManager.UntagResource" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

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