Skip to content

delete_scraper async 

delete_scraper(
    scraper_id: ScraperId,
    *,
    config_overrides: Optional[AsyncampClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
) -> DeleteScraperResponse

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Parameters:

  • scraper_id (ScraperId) –

    The ID of the scraper to delete.

  • client_token (Optional[IdempotencyToken], default: None ) –

    (Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

Raises:

Examples:

DeleteScraper with optional clientToken input

>>> await client.delete_scraper(scraper_id='scraper-123', client_token='token')
Source code in docs_src/capo_amp/_services/async_amp.py 
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
async def delete_scraper(
    self,
    scraper_id: "capo_amp.types.scraper_id.ScraperId",
    *,
    config_overrides: Optional[AsyncampClientConfig] = None,
    client_token: Optional[
        "capo_amp.types.idempotency_token.IdempotencyToken"
    ] = None,
) -> "capo_amp.types.delete_scraper_response.DeleteScraperResponse":
    """<p>The <code>DeleteScraper</code> operation deletes one scraper, and stops any metrics collection that the scraper performs.</p>

    Args:
        scraper_id: <p>The ID of the scraper to delete.</p>
        client_token: <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>

    Raises:
        capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_amp.errors.conflict_exception.ConflictException: <p>The request would cause an inconsistent state.</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:
        DeleteScraper with optional clientToken input

        >>> await client.delete_scraper(scraper_id='scraper-123', client_token='token')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amp.types.delete_scraper_request.DeleteScraperRequest]",
    ) -> AsyncOperationResponse[
        "capo_amp.types.delete_scraper_response.DeleteScraperResponse"
    ]:
        import capo_amp._operations.amazon_prometheus_service.delete_scraper

        (
            output,
            http_response,
        ) = await capo_amp._operations.amazon_prometheus_service.delete_scraper.async_delete_scraper(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteScraper")
    )
    input_: capo_amp.types.delete_scraper_request.DeleteScraperRequest = {
        "scraper_id": scraper_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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