list_table_metadata ¶

def list_table_metadata(
    self,
    catalog_name: "capo_athena.types.catalog_name_string.CatalogNameString",
    database_name: "capo_athena.types.name_string.NameString",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    expression: Optional[
        "capo_athena.types.expression_string.ExpressionString"
    ] = None,
    next_token: Optional["capo_athena.types.token.Token"] = None,
    max_results: Optional[
        "capo_athena.types.max_table_metadata_count.MaxTableMetadataCount"
    ] = None,
    work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
) -> "capo_athena.types.list_table_metadata_output.ListTableMetadataOutput":
    """<p>Lists the metadata for the tables in the specified data catalog database.</p>

    Args:
        catalog_name: <p>The name of the data catalog for which table metadata should be returned.</p>
        database_name: <p>The name of the database for which table metadata should be returned.</p>
        expression: <p>A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.</p>
        next_token: <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.</p>
        max_results: <p>Specifies the maximum number of results to return.</p>
        work_group: <p>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</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.metadata_exception.MetadataException: <p>An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (<code>InvalidRequestException</code>) or from the Athena platform (<code>InternalServerException</code>). For example, if a user-created Lambda function is missing permissions, the Lambda <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.list_table_metadata_input.ListTableMetadataInput]",
    ) -> OperationResponse[
        "capo_athena.types.list_table_metadata_output.ListTableMetadataOutput"
    ]:
        import capo_athena._operations.amazon_athena.list_table_metadata

        output, http_response = (
            capo_athena._operations.amazon_athena.list_table_metadata.list_table_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTableMetadata")
    )
    input_: capo_athena.types.list_table_metadata_input.ListTableMetadataInput = {
        "catalog_name": catalog_name,
        "database_name": database_name,
    }
    if expression is not None:
        input_["expression"] = expression
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if work_group is not None:
        input_["work_group"] = work_group

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