DeleteScraper - Amazon Managed Service for Prometheus

DeleteScraper

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

Request Syntax

DELETE /scrapers/scraperId?clientToken=clientToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

clientToken

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[!-~]+$

scraperId

The ID of the scraper to delete.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202 Content-type: application/json { "scraperId": "string", "status": { "statusCode": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

scraperId

The ID of the scraper to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$

status

The current status of the scraper.

Type: ScraperStatus object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request would cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: