ScraperDescription ¶

class ScraperDescription(TypedDict, closed=True):
    alias: NotRequired["capo_amp.types.scraper_alias.ScraperAlias"]
    """<p>(Optional) A name associated with the scraper.</p>"""
    scraper_id: "capo_amp.types.scraper_id.ScraperId"
    """<p>The ID of the scraper. For example, <code>s-example1-1234-abcd-5678-ef9012abcd34</code>.</p>"""
    arn: "capo_amp.types.scraper_arn.ScraperArn"
    """<p>The Amazon Resource Name (ARN) of the scraper. For example, <code>arn:aws:aps:&lt;region&gt;:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34</code>.</p>"""
    role_arn: "capo_amp.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.</p> <p>For example, <code>arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example</code>.</p>"""
    status: "capo_amp.types.scraper_status.ScraperStatus"
    """<p>A structure that contains the current status of the scraper.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time that the scraper was created.</p>"""
    last_modified_at: "datetime.datetime"
    """<p>The date and time that the scraper was last modified.</p>"""
    tags: NotRequired["capo_amp.types.tag_map.TagMap"]
    """<p>(Optional) The list of tag keys and values associated with the scraper.</p>"""
    status_reason: NotRequired["capo_amp.types.status_reason.StatusReason"]
    """<p>If there is a failure, the reason for the failure.</p>"""
    scrape_configuration: "capo_amp.types.scrape_configuration.ScrapeConfiguration"
    """<p>The configuration in use by the scraper.</p>"""
    source: "capo_amp.types.source.Source"
    """<p>The Amazon EKS cluster from which the scraper collects metrics.</p>"""
    destination: "capo_amp.types.destination.Destination"
    """<p>The 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>This structure displays information about the IAM roles used for cross-account scraping configuration.</p>"""
    exporters: NotRequired["capo_amp.types.exporter_list.ExporterList"]
    """<p>The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain.</p>"""