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 ]

list-instrumentation-configurations

Description

Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally.

Include the previous SyncedAt value to perform incremental syncs. When no changes are detected, the response sets Changed to false and omits configuration details.

See also: AWS API Documentation

list-instrumentation-configurations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: LatestConfigurations

Synopsis

  list-instrumentation-configurations
--service <value>
--environment <value>
--instrumentation-type <value>
[--synced-at <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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 name of the service to retrieve instrumentation configurations for.

--environment (string)

The environment that the service is running in.

--instrumentation-type (string)

Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.

Possible values:

  • BREAKPOINT
  • PROBE

--synced-at (timestamp)

The timestamp from the last successful sync. When provided, the response returns Changed as false if nothing is new since this time, or returns the latest configurations when changes exist.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 associated with the returned configurations.

Environment -> (string)

The environment associated with the returned configurations.

Changed -> (boolean)

Indicates whether there are configuration changes since the provided SyncedAt timestamp.

LatestConfigurations -> (list)

The current set of active instrumentation configurations for the service and environment. Items omit service and environment because they are provided in the request.

(structure)

An instrumentation configuration that omits service and environment because they are provided at a higher level, such as in a list response.

InstrumentationType -> (string)

The type of instrumentation for this configuration.

SignalType -> (string)

The telemetry signal type for this instrumentation configuration.

Location -> (tagged union structure)

The location where this instrumentation is applied.

Note

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

CodeLocation -> (structure)

A code location for code-level instrumentation, including language, code unit, class, method, file path, and optional line number.

Language -> (string)

The programming language for this instrumentation point, such as Java, Python, or JavaScript.

CodeUnit -> (string)

The package, module, or namespace that contains the target code, for example com.amazon.payment or payment_service .

ClassName -> (string)

The class or type name that contains the method. This is required for Java and optional for Python module-level functions.

MethodName -> (string)

The method or function name to instrument, such as validateCreditCard or __init__ .

FilePath -> (string)

The source file path relative to the project or source root, such as src/payment/PaymentProcessor.java or src/payment/PaymentProcessor.py .

LineNumber -> (integer)

The line number to instrument. Provide this to disambiguate overloaded methods and to target a specific line when needed.

LocationHash -> (string)

The stable hash derived from the location that identifies this instrumentation point.

Description -> (string)

An optional short description of the instrumentation configuration.

ExpiresAt -> (timestamp)

The timestamp when this configuration expires.

AttributeFilters -> (list)

Client-side filters that determine which instances apply this instrumentation.

(map)

A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance.

key -> (string)

value -> (string)

CaptureConfiguration -> (tagged union structure)

The capture settings for this instrumentation configuration.

Note

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

CodeCapture -> (structure)

Capture settings for code-level instrumentation, including arguments, return values, stack traces, local variables, and safety limits.

CaptureArguments -> (list)

The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use ["*"] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).

(string)

CaptureReturn -> (boolean)

Whether to capture the return value. Defaults to false.

CaptureStackTrace -> (boolean)

Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.

CaptureLocals -> (list)

The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.

(string)

CaptureLimits -> (structure)

Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.

MaxHits -> (integer)

The maximum number of times the instrumentation point can be hit before it is automatically disabled. Defaults to 100.

MaxStringLength -> (integer)

The maximum length of captured string values in characters. Strings longer than this are truncated. Defaults to 128.

MaxCollectionWidth -> (integer)

The maximum number of items to capture from any collection to prevent large payloads. Defaults to 10.

MaxCollectionDepth -> (integer)

The maximum nesting depth to traverse inside collections. Defaults to 3.

MaxStackFrames -> (integer)

The maximum number of stack frames to capture in stack traces. Defaults to 2.

MaxStackTraceSize -> (integer)

The maximum total size, in bytes, of a captured stack trace. Defaults to 1000.

MaxObjectDepth -> (integer)

The maximum depth for nested object traversal when capturing structured data. Defaults to 3.

MaxFieldsPerObject -> (integer)

The maximum number of fields to capture for any object. Defaults to 10.

CreatedAt -> (timestamp)

The timestamp when this instrumentation configuration was created.

ARN -> (string)

ARN for the instrumentation configuration

SyncedAt -> (timestamp)

The server timestamp to supply on the next sync call.

SyncInterval -> (integer)

The suggested number of seconds to wait before the next sync request. This is at least 60 seconds to prevent excessive polling.

NextToken -> (string)

Pagination token to continue listing configurations when more results are available.