CreateScraper
The CreateScraper operation creates a scraper to collect metrics. A
scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are
flexible, and can be configured to control what metrics are collected, the
frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML
configuration for the scraper.
When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS
cluster within the VPC for scraping metrics.
Note
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an AWS managed collector in the Amazon Managed Service for Prometheus User Guide.
Request Syntax
POST /scrapers HTTP/1.1
Content-type: application/json
{
"alias": "string",
"clientToken": "string",
"destination": { ... },
"roleConfiguration": {
"sourceRoleArn": "string",
"targetRoleArn": "string"
},
"scrapeConfiguration": { ... },
"source": { ... },
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- alias
-
(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.
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
-
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[!-~]+$Required: No
- destination
-
The 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: Yes
- roleConfiguration
-
The scraper role configuration for the workspace.
Type: RoleConfiguration object
Required: No
- scrapeConfiguration
-
The configuration file to use in the new scraper. For more information, see Scraper configuration 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: Yes
- source
-
The Amazon EKS cluster from which the scraper will collect metrics.
Type: Source object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
-
(Optional) The list of tag keys and values to associate 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}_.:/=+\-@]*)$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 new scraper.
Type: String
- scraperId
-
The ID of the new 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
-
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
