Skip to content

untag_resource

Operation

untag_resource

untag_resource(request: UntagResourceInput | UntagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UntagResourceInputDict]) -> UntagResourceOutput

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.

Warning

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.

Parameters:

Name Type Description Default
request UntagResourceInput | UntagResourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UntagResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UntagResourceOutput

An instance of UntagResourceOutput.

untag_resource async

untag_resource(request: UntagResourceInput | UntagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UntagResourceInputDict]) -> UntagResourceOutput

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.

Warning

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.

Parameters:

Name Type Description Default
request UntagResourceInput | UntagResourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UntagResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UntagResourceOutput

An instance of UntagResourceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UntagResourceInputDict

Bases: TypedDict

Dictionary form of UntagResourceInput.

Attributes

secret_id instance-attribute
secret_id: Required[str]

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.

tag_keys instance-attribute
tag_keys: Required[Sequence[str]]

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.

UntagResourceInput dataclass

Bases: _SerdeShape

Dataclass for UntagResourceInput structure.

Attributes

secret_id class-attribute instance-attribute
secret_id: str | None = ...

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.

tag_keys class-attribute instance-attribute
tag_keys: list[str] | None = ...

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.

Output

UntagResourceOutput dataclass

Bases: _SerdeShape

Dataclass for UntagResourceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.