Skip to content

ScraperSummary

Source code in docs_src/capo_amp/types/scraper_summary.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class ScraperSummary(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.</p>"""
    arn: "capo_amp.types.scraper_arn.ScraperArn"
    """<p>The Amazon Resource Name (ARN) of the scraper.</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>"""
    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>"""
    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>"""

alias instance-attribute 

alias: NotRequired[ScraperAlias]

(Optional) A name associated with the scraper.

arn instance-attribute 

arn: ScraperArn

The Amazon Resource Name (ARN) of the scraper.

created_at instance-attribute 

created_at: datetime

The date and time that the scraper was created.

destination instance-attribute 

destination: Destination

The 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, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain.

last_modified_at instance-attribute 

last_modified_at: datetime

The date and time that the scraper was last modified.

role_arn instance-attribute 

role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

role_configuration instance-attribute 

role_configuration: NotRequired[RoleConfiguration]

This structure displays information about the IAM roles used for cross-account scraping configuration.

scraper_id instance-attribute 

scraper_id: ScraperId

The ID of the scraper.

source instance-attribute 

source: Source

The Amazon EKS cluster from which the scraper collects metrics.

status instance-attribute 

status: ScraperStatus

A structure that contains the current status of the scraper.

status_reason instance-attribute 

status_reason: NotRequired[StatusReason]

If there is a failure, the reason for the failure.

tags instance-attribute 

tags: NotRequired[TagMap]

(Optional) The list of tag keys and values associated with the scraper.