Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amp ]

describe-scraper

Description

The DescribeScraper operation displays information about an existing scraper.

See also: AWS API Documentation

Synopsis

  describe-scraper
--scraper-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--scraper-id (string)

The ID of the scraper to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

scraper -> (structure)

Contains details about the scraper.

alias -> (string)

(Optional) A name associated with the scraper.

arn -> (string)

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

createdAt -> (timestamp)

The date and time that the scraper was created.

destination -> (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ampConfiguration.

ampConfiguration -> (structure)

The Amazon Managed Service for Prometheus workspace to send metrics to.

workspaceArn -> (string)

ARN of the Amazon Managed Service for Prometheus workspace.

lastModifiedAt -> (timestamp)

The date and time that the scraper was last modified.

roleArn -> (string)

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 .

scrapeConfiguration -> (tagged union structure)

The configuration in use by the scraper.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: configurationBlob.

configurationBlob -> (blob)

The base 64 encoded scrape configuration file.

scraperId -> (string)

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

source -> (tagged union structure)

The Amazon EKS cluster from which the scraper collects metrics.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: eksConfiguration.

eksConfiguration -> (structure)

The Amazon EKS cluster from which a scraper collects metrics.

clusterArn -> (string)

ARN of the Amazon EKS cluster.

securityGroupIds -> (list)

A list of the security group IDs for the Amazon EKS cluster VPC configuration.

(string)

ID of a VPC security group.

subnetIds -> (list)

A list of subnet IDs for the Amazon EKS cluster VPC configuration.

(string)

ID of a VPC subnet.

status -> (structure)

A structure that contains the current status of the scraper.

statusCode -> (string)

The current status of the scraper.

statusReason -> (string)

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

tags -> (map)

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

key -> (string)

The key of the tag. Must not begin with aws: .

value -> (string)

The value of the tag.