untag_user ¶

def untag_user(
    self,
    user_name: "capo_iam.types.existing_user_name_type.existingUserNameType",
    tag_keys: "capo_iam.types.tag_key_list_type.tagKeyListType",
    *,
    config_overrides: Optional[IAMClientConfig] = None,
) -> None:
    """<p>Removes the specified tags from the user. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p>

    Args:
        user_name: <p>The name of the IAM user from which you want to remove tags.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>
        tag_keys: <p>A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.</p>

    Raises:
        capo_iam.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To remove a tag from an IAM user
        The following example shows how to remove tags that are attached to a user named 'anika'.

        >>> client.untag_user(user_name='anika', tag_keys=['Dept'])
    """

    def _handler(
        req: "OperationRequest[capo_iam.types.untag_user_request.UntagUserRequest]",
    ) -> OperationResponse[None]:
        import capo_iam._operations.aws_identity_management_v20100508.untag_user

        output, http_response = (
            capo_iam._operations.aws_identity_management_v20100508.untag_user.untag_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UntagUser")
    )
    input_: capo_iam.types.untag_user_request.UntagUserRequest = {
        "user_name": user_name,
        "tag_keys": tag_keys,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output