ScraperDescription

The ScraperDescription structure contains the full details about one scraper in your account.

arn

The Amazon Resource Name (ARN) of the scraper. For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.

Type: String

Required: Yes

createdAt

The date and time that the scraper was created.

Type: Timestamp

Required: Yes

destination

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

Type: Destination object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

lastModifiedAt

The date and time that the scraper was last modified.

Type: Timestamp

Required: Yes

roleArn

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

For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.

Type: String

Required: Yes

scrapeConfiguration

The configuration in use by the scraper.

Type: ScrapeConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

scraperId

The ID of the scraper. For example, s-example1-1234-abcd-5678-ef9012abcd34.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$

Required: Yes

source

The Amazon EKS cluster from which the scraper collects metrics.

Type: Source object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

status

A structure that contains the current status of the scraper.

Type: ScraperStatus object

Required: Yes

alias

(Optional) A name associated with the scraper.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$

Required: No

statusReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

tags

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

ScraperDescription

Contents

See Also