AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . application-signals ]

report-instrumentation-configuration-status

Description

Reports the status of one or more instrumentation configurations from SDK instances. Use this to record when configurations become ready, hit errors, become active, or are disabled by limits.

Report READY , ERROR , and DISABLED when the status changes. Report ACTIVE periodically (for example, every minute) while instrumentation is running.

See also: AWS API Documentation

Synopsis

  report-instrumentation-configuration-status
--service <value>
--environment <value>
--configurations <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>]
[--v2-debug]

Options

--service (string)

The service that the reported configurations belong to.

--environment (string)

The environment that the service is running in.

--configurations (list)

An array of configuration status reports (up to 100) that include the instrumentation type, signal type, location hash, status, timestamp, and optional error cause.

(structure)

The status of a single instrumentation configuration reported by an SDK instance.

InstrumentationType -> (string)

The type of instrumentation configuration being reported.

SignalType -> (string)

The telemetry signal type for this instrumentation configuration.

LocationHash -> (string)

The stable hash of the instrumentation location that identifies the configuration being reported.

Status -> (string)

The status of the instrumentation configuration: READY , ERROR , ACTIVE , or DISABLED .

Time -> (timestamp)

The timestamp when the status event occurred.

ErrorCause -> (string)

The error cause when the status is ERROR , such as the file or method not being found.

Shorthand Syntax:

InstrumentationType=string,SignalType=string,LocationHash=string,Status=string,Time=timestamp,ErrorCause=string ...

JSON Syntax:

[
  {
    "InstrumentationType": "BREAKPOINT"|"PROBE",
    "SignalType": "SNAPSHOT",
    "LocationHash": "string",
    "Status": "READY"|"ERROR"|"ACTIVE"|"DISABLED",
    "Time": timestamp,
    "ErrorCause": "FILE_NOT_FOUND"|"METHOD_NOT_FOUND"|"LINE_NOT_EXECUTABLE"|"OVERLOADED_METHODS"|"LANGUAGE_MISMATCH"|"RUNTIME_ERROR"
  }
  ...
]

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Service -> (string)

The service name echoed from the request.

Environment -> (string)

The environment echoed from the request.

UnprocessedStatusEvents -> (list)

Status events that failed to be processed. Each entry includes the configuration identifiers, status, timestamp, and a reason for the failure.

(structure)

A status event that could not be processed by the service.

InstrumentationType -> (string)

The type of instrumentation configuration for the unprocessed status event.

SignalType -> (string)

The telemetry signal type for the unprocessed status event.

LocationHash -> (string)

The stable hash of the instrumentation location for the unprocessed event.

Status -> (string)

The status that failed to be processed.

Time -> (timestamp)

The timestamp of the status event that failed to be processed.

FailedReason -> (string)

The reason why this status event could not be processed, such as throttling or validation errors.