Skip to content

UpdateScraperRequest

Source code in docs_src/capo_amp/types/update_scraper_request.py
class UpdateScraperRequest(TypedDict, closed=True):
    scraper_id: "capo_amp.types.scraper_id.ScraperId"
    """<p>The ID of the scraper to update.</p>"""
    alias: NotRequired["capo_amp.types.scraper_alias.ScraperAlias"]
    """<p>The new alias of the scraper.</p>"""
    scrape_configuration: NotRequired[
        "capo_amp.types.scrape_configuration.ScrapeConfiguration"
    ]
    """<p>Contains the base-64 encoded YAML configuration for the scraper.</p> <note> <p>For more information about configuring a scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html">Using an Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> </note>"""
    destination: NotRequired["capo_amp.types.destination.Destination"]
    """<p>The new destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.</p>"""
    role_configuration: NotRequired[
        "capo_amp.types.role_configuration.RoleConfiguration"
    ]
    """<p>Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.</p>"""
    client_token: NotRequired["capo_amp.types.idempotency_token.IdempotencyToken"]
    """<p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>"""
    exporters: NotRequired["capo_amp.types.exporter_list.ExporterList"]
    """<p>The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the existing exporter configuration remains unchanged.</p>"""

alias instance-attribute

alias: NotRequired[ScraperAlias]

The new alias of the scraper.

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

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

destination instance-attribute

destination: NotRequired[Destination]

The new destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.

exporters instance-attribute

exporters: NotRequired[ExporterList]

The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the existing exporter configuration remains unchanged.

role_configuration instance-attribute

role_configuration: NotRequired[RoleConfiguration]

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

scrape_configuration instance-attribute

scrape_configuration: NotRequired[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.

scraper_id instance-attribute

scraper_id: ScraperId

The ID of the scraper to update.