Skip to content

describe_scraper

describe_scraper(
    scraper_id: ScraperId, *, config_overrides: Optional[ampClientConfig] = None
) -> DescribeScraperResponse

The DescribeScraper operation displays information about an existing scraper.

Parameters:

  • scraper_id (ScraperId) –

    The ID of the scraper to describe.

Raises:

Examples:

DescribeScraper, with no statusReason to report

>>> client.describe_scraper(scraper_id='scraper-123')
Source code in docs_src/capo_amp/_services/amp.py
def describe_scraper(
    self,
    scraper_id: "capo_amp.types.scraper_id.ScraperId",
    *,
    config_overrides: Optional[ampClientConfig] = None,
) -> "capo_amp.types.describe_scraper_response.DescribeScraperResponse":
    """<p>The <code>DescribeScraper</code> operation displays information about an existing scraper.</p>

    Args:
        scraper_id: <p>The ID of the scraper to describe.</p>

    Raises:
        capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_amp.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_amp.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resources that doesn't exist.</p>
        capo_amp.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_amp.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_amp.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DescribeScraper, with no statusReason to report

        >>> client.describe_scraper(scraper_id='scraper-123')
    """

    def _handler(
        req: "OperationRequest[capo_amp.types.describe_scraper_request.DescribeScraperRequest]",
    ) -> OperationResponse[
        "capo_amp.types.describe_scraper_response.DescribeScraperResponse"
    ]:
        import capo_amp._operations.amazon_prometheus_service.describe_scraper

        output, http_response = (
            capo_amp._operations.amazon_prometheus_service.describe_scraper.describe_scraper(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeScraper")
    )
    input_: capo_amp.types.describe_scraper_request.DescribeScraperRequest = {
        "scraper_id": scraper_id
    }

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