Skip to content

Update Scraper

prometheusservice_update_scraper R Documentation

Updates an existing scraper

Description

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.

Usage

prometheusservice_update_scraper(alias, clientToken, destination,
  scrapeConfiguration, scraperId)

Arguments

alias

The new alias of the scraper.

clientToken

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

destination

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

scrapeConfiguration

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

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

scraperId

[required] The ID of the scraper to update.

Value

A list with the following syntax: 

list(
  arn = "string",
  scraperId = "string",
  status = list(
    statusCode = "CREATING"|"UPDATING"|"ACTIVE"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|"DELETION_FAILED"
  ),
  tags = list(
    "string"
  )
)

Request syntax

svc$update_scraper(
  alias = "string",
  clientToken = "string",
  destination = list(
    ampConfiguration = list(
      workspaceArn = "string"
    )
  ),
  scrapeConfiguration = list(
    configurationBlob = raw
  ),
  scraperId = "string"
)