AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources and sends them to your Amazon Managed Service for Prometheus workspace. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. 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 source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, 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 your source within the VPC for scraping metrics.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

Namespace: Amazon.PrometheusService
Assembly: AWSSDK.PrometheusService.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateScraperResponse> CreateScraperAsync(
         CreateScraperRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.PrometheusService.Model.CreateScraperRequest

Container for the necessary parameters to execute the CreateScraper service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateScraper service method, as returned by PrometheusService.

Exceptions

ExceptionCondition
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException The request would cause an inconsistent state.
InternalServerException An unexpected error occurred during the processing of the request.
ResourceNotFoundException The request references a resources that doesn't exist.
ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
ThrottlingException The request was denied due to request throttling.
ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer

See Also