PrometheusService / Client / delete_scraper

delete_scraper#

PrometheusService.Client.delete_scraper(**kwargs)#

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

Request Syntax

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

Parameters:

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

This field is autopopulated if not provided.
scraperId (string) –
[REQUIRED]

The ID of the scraper to delete.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Represents the output of a DeleteScraper operation.
- scraperId (string) –
  
  The ID of the scraper to delete.
- status (dict) –
  
  The current status of the scraper.
  - statusCode (string) –
    
    The current status of the 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