amazonka-secretsmanager-2.0: Amazon Secrets Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SecretsManager.UntagResource

Description

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.

Synopsis

Creating a Request

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource' 

Fields

  • secretId :: Text

    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 :: [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 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
ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type AWSResponse UntagResource #

Generic UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

Read UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

NFData UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Methods

rnf :: UntagResource -> () #

Eq UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

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

newUntagResource Source #

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 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.

$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 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 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.

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 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.

Instances

Instances details
Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.SecretsManager.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.SecretsManager.UntagResource" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" '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.