Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateScraper

Updates an existing scraper.

You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.

Request Syntax


PUT /scrapers/scraperId HTTP/1.1
Content-type: application/json

{
   "alias": "string",
   "clientToken": "string",
   "destination": { ... },
   "scrapeConfiguration": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

scraperId

The ID of the scraper to update.

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 accepts the following data in JSON format.

alias

The new alias of the scraper.

Type: String

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

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

Required: No

clientToken

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

Type: String

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

Pattern: ^[!-~]+$

Required: No

destination

The new Amazon Managed Service for Prometheus workspace to send metrics to.

Type: Destination object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

scrapeConfiguration

Contains the base-64 encoded YAML configuration for the scraper.

Note

For more information about configuring a scraper, see Using an AWS managed collector in the Amazon Managed Service for Prometheus User Guide.

Type: ScrapeConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "arn": "string",
   "scraperId": "string",
   "status": { 
      "statusCode": "string"
   },
   "tags": { 
      "string" : "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.

arn

The Amazon Resource Name (ARN) of the updated scraper.

Type: String

scraperId

The ID of the updated scraper.

Type: String

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

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

status

A structure that displays the current status of the scraper.

Type: ScraperStatus object

tags

The list of tag keys and values that are associated with the scraper.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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

ServiceQuotaExceededException

Completing the request would cause a service quota to be exceeded.

HTTP Status Code: 402

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