Skip to content

get_crawler_metrics

get_crawler_metrics(
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    crawler_name_list: Optional[CrawlerNameList] = None,
    max_results: Optional[PageSize] = None,
    next_token: Optional[Token] = None,
) -> GetCrawlerMetricsResponse

Retrieves metrics about specified crawlers.

Parameters:

  • crawler_name_list (Optional[CrawlerNameList], default: None ) –

    A list of the names of crawlers about which to retrieve metrics.

  • max_results (Optional[PageSize], default: None ) –

    The maximum size of a list to return.

  • next_token (Optional[Token], default: None ) –

    A continuation token, if this is a continuation call.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def get_crawler_metrics(
    self,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    crawler_name_list: Optional[
        "capo_glue.types.crawler_name_list.CrawlerNameList"
    ] = None,
    max_results: Optional["capo_glue.types.page_size.PageSize"] = None,
    next_token: Optional["capo_glue.types.token.Token"] = None,
) -> "capo_glue.types.get_crawler_metrics_response.GetCrawlerMetricsResponse":
    """<p>Retrieves metrics about specified crawlers.</p>

    Args:
        crawler_name_list: <p>A list of the names of crawlers about which to retrieve metrics.</p>
        max_results: <p>The maximum size of a list to return.</p>
        next_token: <p>A continuation token, if this is a continuation call.</p>

    Raises:
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.get_crawler_metrics_request.GetCrawlerMetricsRequest]",
    ) -> OperationResponse[
        "capo_glue.types.get_crawler_metrics_response.GetCrawlerMetricsResponse"
    ]:
        import capo_glue._operations.aws_glue.get_crawler_metrics

        output, http_response = (
            capo_glue._operations.aws_glue.get_crawler_metrics.get_crawler_metrics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCrawlerMetrics")
    )
    input_: capo_glue.types.get_crawler_metrics_request.GetCrawlerMetricsRequest = {}
    if crawler_name_list is not None:
        input_["crawler_name_list"] = crawler_name_list
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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