get_data_catalog `async` ¶

get_data_catalog(
    name: CatalogNameString,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    work_group: Optional[WorkGroupName] = None,
) -> GetDataCatalogOutput

Returns the specified data catalog.

Parameters:

name (CatalogNameString) –

The name of the data catalog to return.
work_group (Optional[WorkGroupName], default: None ) –

The name of the workgroup. Required if making an IAM Identity Center request.

Raises:

InternalServerException –

Indicates a platform issue, which may be due to a transient condition or outage.
InvalidRequestException –

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
UnknownServiceError –

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

Source code in docs_src/capo_athena/_services/async_athena.py

async def get_data_catalog(
    self,
    name: "capo_athena.types.catalog_name_string.CatalogNameString",
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
) -> "capo_athena.types.get_data_catalog_output.GetDataCatalogOutput":
    """<p>Returns the specified data catalog.</p>

    Args:
        name: <p>The name of the data catalog to return.</p>
        work_group: <p>The name of the workgroup. Required if making an IAM Identity Center request.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_athena.types.get_data_catalog_input.GetDataCatalogInput]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.get_data_catalog_output.GetDataCatalogOutput"
    ]:
        import capo_athena._operations.amazon_athena.get_data_catalog

        (
            output,
            http_response,
        ) = await capo_athena._operations.amazon_athena.get_data_catalog.async_get_data_catalog(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDataCatalog")
    )
    input_: capo_athena.types.get_data_catalog_input.GetDataCatalogInput = {
        "name": name
    }
    if work_group is not None:
        input_["work_group"] = work_group

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_data_catalog async ¶

get_data_catalog `async` ¶