PrometheusService / Client / delete_scraper

delete_scraper

PrometheusService.Client.delete_scraper(**kwargs)

Deletes a scraper.

See also: AWS API Documentation

Request Syntax

response = client.delete_scraper(
    scraperId='string',
    clientToken='string'
)

Parameters:

• scraperId (string) –

  [REQUIRED]

  The ID of the scraper to delete.

• clientToken (string) –

  Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'scraperId': 'string',
    'status': {
        'statusCode': 'CREATING'|'ACTIVE'|'DELETING'|'CREATION_FAILED'|'DELETION_FAILED'
    }
}

Response Structure

• (dict) –

  Represents the output of a DeleteScraper operation.

  • scraperId (string) –

    The ID of the scraper that was deleted.

  • status (dict) –

    The status of the scraper that is being deleted.

    • statusCode (string) –

      Status code of this scraper.

Exceptions

• PrometheusService.Client.exceptions.ThrottlingException

• PrometheusService.Client.exceptions.ConflictException

• PrometheusService.Client.exceptions.ValidationException

• PrometheusService.Client.exceptions.ResourceNotFoundException

• PrometheusService.Client.exceptions.AccessDeniedException

• PrometheusService.Client.exceptions.InternalServerException