get_lf_tag ¶

get_lf_tag(
    tag_key: LFTagKey,
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
) -> GetLFTagResponse

Returns an LF-tag definition.

Parameters:

catalog_id (Optional[CatalogIdString], default: None ) –

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.
tag_key (LFTagKey) –

The key-name for the LF-tag.

Raises:

AccessDeniedException –

Access to a resource was denied.
EntityNotFoundException –

A specified entity does not exist.
InternalServiceException –

An internal service error occurred.
InvalidInputException –

The input provided was not valid.
OperationTimeoutException –

The operation timed out.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lakeformation/_services/lake_formation.py

def get_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,
) -> "capo_lakeformation.types.get_lf_tag_response.GetLFTagResponse":
    """<p>Returns an LF-tag definition.</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.</p>

    Raises:
        capo_lakeformation.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</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.get_lf_tag_request.GetLFTagRequest]",
    ) -> OperationResponse[
        "capo_lakeformation.types.get_lf_tag_response.GetLFTagResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.get_lf_tag

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLFTag")
    )
    input_: capo_lakeformation.types.get_lf_tag_request.GetLFTagRequest = {
        "tag_key": tag_key
    }
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id

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