Skip to content
AWS for Query.Farm

aws.amp.describe_scraper

Example SQL Queries

SELECT * FROM
aws.amp.describe_scraper
WHERE
"scraper_id" = 'VALUE';

Description

The DescribeScraper operation displays information about an existing scraper.

Table Definition

Column NameColumn Data Type
scraper_id Required Input Column

The ID of the scraper to describe.

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.

scraper

Contains details about the scraper.

STRUCT(
    "alias" VARCHAR,
    "arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "destination" STRUCT(
        "amp_configuration" STRUCT(
            "workspace_arn" VARCHAR
        )
    ),
    "last_modified_at" TIMESTAMP_S,
    "role_arn" VARCHAR,
    "scrape_configuration" STRUCT(
        "configuration_blob" BLOB
    ),
    "scraper_id" VARCHAR,
    "source" STRUCT(
        "eks_configuration" STRUCT(
            "cluster_arn" VARCHAR,
            "security_group_ids" VARCHAR[],
            "subnet_ids" VARCHAR[]
        )
    ),
    "status" STRUCT(
        "status_code" VARCHAR
    ),
    "status_reason" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
scraper.alias

(Optional) A name associated with the scraper.

scraper.arn

The Amazon Resource Name (ARN) of the scraper.

scraper.created_at

The date and time that the scraper was created.

scraper.destination

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

Show child fields
scraper.destination.amp_configuration

The Amazon Managed Service for Prometheusworkspace to send metrics to.

Show child fields
scraper.destination.amp_configuration.workspace_arn

ARN of the Amazon Managed Service for Prometheus workspace.

scraper.last_modified_at

The date and time that the scraper was last modified.

scraper.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.

scraper.scrape_configuration

The configuration file in use by the scraper.

Show child fields
scraper.scrape_configuration.configuration_blob

The base 64 encoded scrape configuration file.

scraper.scraper_id

The ID of the scraper.

scraper.source

The Amazon EKS cluster from which the scraper collects metrics.

Show child fields
scraper.source.eks_configuration

The Amazon EKS cluster from which a scraper collects metrics.

Show child fields
scraper.source.eks_configuration.cluster_arn

ARN of the Amazon EKS cluster.

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

A structure that contains the current status of the scraper.

Show child fields
scraper.status.status_code

The current status of the scraper.

scraper.status_reason

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

scraper.tags

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