Skip to content

get_data_lake_settings

get_data_lake_settings(
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
) -> GetDataLakeSettingsResponse

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

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.

Raises:

Source code in docs_src/capo_lakeformation/_services/lake_formation.py
def get_data_lake_settings(
    self,
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ] = None,
) -> "capo_lakeformation.types.get_data_lake_settings_response.GetDataLakeSettingsResponse":
    """<p>Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. </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>

    Raises:
        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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lakeformation.types.get_data_lake_settings_request.GetDataLakeSettingsRequest]",
    ) -> OperationResponse[
        "capo_lakeformation.types.get_data_lake_settings_response.GetDataLakeSettingsResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.get_data_lake_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDataLakeSettings")
    )
    input_: capo_lakeformation.types.get_data_lake_settings_request.GetDataLakeSettingsRequest = {}
    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