update_lf_tag ¶

def update_lf_tag(
    self,
    tag_key: "capo_lakeformation.types.lf_tag_key.LFTagKey",
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ] = None,
    tag_values_to_delete: Optional[
        "capo_lakeformation.types.tag_value_list.TagValueList"
    ] = None,
    tag_values_to_add: Optional[
        "capo_lakeformation.types.tag_value_list.TagValueList"
    ] = None,
) -> "capo_lakeformation.types.update_lf_tag_response.UpdateLFTagResponse":
    """<p>Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value. </p>

    Args:
        catalog_id: <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
        tag_key: <p>The key-name for the LF-tag for which to add or delete values.</p>
        tag_values_to_delete: <p>A list of LF-tag values to delete from the LF-tag.</p>
        tag_values_to_add: <p>A list of LF-tag values to add from the LF-tag.</p>

    Raises:
        capo_lakeformation.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_lakeformation.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Two processes are trying to modify a resource simultaneously.</p>
        capo_lakeformation.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist.</p>
        capo_lakeformation.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_lakeformation.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_lakeformation.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_lakeformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lakeformation.types.update_lf_tag_request.UpdateLFTagRequest]",
    ) -> OperationResponse[
        "capo_lakeformation.types.update_lf_tag_response.UpdateLFTagResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.update_lf_tag

        output, http_response = (
            capo_lakeformation._operations.aws_lake_formation.update_lf_tag.update_lf_tag(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateLFTag")
    )
    input_: capo_lakeformation.types.update_lf_tag_request.UpdateLFTagRequest = {
        "tag_key": tag_key
    }
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id
    if tag_values_to_delete is not None:
        input_["tag_values_to_delete"] = tag_values_to_delete
    if tag_values_to_add is not None:
        input_["tag_values_to_add"] = tag_values_to_add

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