Skip to content
AWS for Query.Farm

aws.amp.list_scrapers

Example SQL Queries

SELECT * FROM
aws.amp.list_scrapers;

Description

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

Table Definition

Column NameColumn Data Type
filters Input Column

(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

If this is included, it filters the results to only the scrapers that match the filter.

MAP(VARCHAR, VARCHAR[])
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

alias

(Optional) A name associated with the scraper.

VARCHAR
arn

The Amazon Resource Name (ARN) of the scraper.

VARCHAR
created_at

The date and time that the scraper was created.

TIMESTAMP_S
destination

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

STRUCT(
    "amp_configuration" STRUCT(
        "workspace_arn" VARCHAR
    )
)
Show child fields
destination.amp_configuration

The Amazon Managed Service for Prometheusworkspace to send metrics to.

Show child fields
destination.amp_configuration.workspace_arn

ARN of the Amazon Managed Service for Prometheus workspace.

last_modified_at

The date and time that the scraper was last modified.

TIMESTAMP_S
role_arn

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

VARCHAR
scraper_id

The ID of the scraper.

VARCHAR
source

The Amazon EKS cluster from which the scraper collects metrics.

STRUCT(
    "eks_configuration" STRUCT(
        "cluster_arn" VARCHAR,
        "security_group_ids" VARCHAR[],
        "subnet_ids" VARCHAR[]
    )
)
Show child fields
source.eks_configuration

The Amazon EKS cluster from which a scraper collects metrics.

Show child fields
source.eks_configuration.cluster_arn

ARN of the Amazon EKS cluster.

source.eks_configuration.security_group_ids[]
source.eks_configuration.subnet_ids[]
status

A structure that contains the current status of the scraper.

STRUCT(
    "status_code" VARCHAR
)
Show child fields
status.status_code

The current status of the scraper.

status_reason

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

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)