list_notebook_metadata ¶

def list_notebook_metadata(
    self,
    work_group: "capo_athena.types.work_group_name.WorkGroupName",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    filters: Optional[
        "capo_athena.types.filter_definition.FilterDefinition"
    ] = None,
    next_token: Optional["capo_athena.types.token.Token"] = None,
    max_results: Optional[
        "capo_athena.types.max_notebooks_count.MaxNotebooksCount"
    ] = None,
) -> "capo_athena.types.list_notebook_metadata_output.ListNotebookMetadataOutput":
    """<p>Displays the notebook files for the specified workgroup in paginated format.</p>

    Args:
        filters: <p>Search filter string.</p>
        next_token: <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.</p>
        max_results: <p>Specifies the maximum number of results to return.</p>
        work_group: <p>The name of the Spark enabled workgroup to retrieve notebook metadata for.</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.too_many_requests_exception.TooManyRequestsException: <p>Indicates that the request was throttled.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.list_notebook_metadata_input.ListNotebookMetadataInput]",
    ) -> OperationResponse[
        "capo_athena.types.list_notebook_metadata_output.ListNotebookMetadataOutput"
    ]:
        import capo_athena._operations.amazon_athena.list_notebook_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNotebookMetadata")
    )
    input_: capo_athena.types.list_notebook_metadata_input.ListNotebookMetadataInput = {
        "work_group": work_group
    }
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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