AWS CLI Command Reference

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 ]

create-scraper

Description

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide .

The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.

Note

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide .

See also: AWS API Documentation

Synopsis

  create-scraper
[--alias <value>]
[--client-token <value>]
--destination <value>
--scrape-configuration <value>
--source <value>
[--tags <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

--alias (string)

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

--client-token (string)

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

--destination (tagged union structure)

The Amazon Managed Service for Prometheus workspace to send 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.

Shorthand Syntax:

ampConfiguration={workspaceArn=string}

JSON Syntax:

{
  "ampConfiguration": {
    "workspaceArn": "string"
  }
}

--scrape-configuration (tagged union structure)

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide .

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.

Shorthand Syntax:

configurationBlob=blob

JSON Syntax:

{
  "configurationBlob": blob
}

--source (tagged union structure)

The Amazon EKS cluster from which the scraper will collect 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.

Shorthand Syntax:

eksConfiguration={clusterArn=string,securityGroupIds=[string,string],subnetIds=[string,string]}

JSON Syntax:

{
  "eksConfiguration": {
    "clusterArn": "string",
    "securityGroupIds": ["string", ...],
    "subnetIds": ["string", ...]
  }
}

--tags (map)

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

key -> (string)

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

value -> (string)

The value of the tag.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

arn -> (string)

The Amazon Resource Name (ARN) of the new scraper.

scraperId -> (string)

The ID of the new scraper.

status -> (structure)

A structure that displays the current status of the scraper.

statusCode -> (string)

The current status of the scraper.

tags -> (map)

The list of tag keys and values that are associated with the scraper.

key -> (string)

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

value -> (string)

The value of the tag.