get-instrumentation-configuration-status¶

Description¶

Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED.

If no status or time window is provided, the operation defaults to ACTIVE events from the last hour.

Synopsis¶

  get-instrumentation-configuration-status
--instrumentation-type <value>
--service <value>
--environment <value>
--signal-type <value>
--location-identifier <value>
[--status <value>]
[--start-time <value>]
[--end-time <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--instrumentation-type (string) [required]

Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

Possible values:

BREAKPOINT

PROBE

--service (string) [required]

Service name for the instrumentation configuration.

Constraints:

min: 1

max: 255

--environment (string) [required]

Environment name for the instrumentation configuration.

Constraints:

min: 1

max: 255

--signal-type (string) [required]

Signal type for the instrumentation configuration.

Possible values:

SNAPSHOT

--location-identifier (tagged union structure) [required]

Location identifier - either full code location or a pre-computed hash.

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

CodeLocation -> (structure)

The full code location specification (will be hashed internally)

Language -> (string) [required]

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

Possible values:

Java

Python

Javascript

CodeUnit -> (string)

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

Constraints:

min: 1

max: 128

ClassName -> (string)

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

Constraints:

min: 1

max: 128

MethodName -> (string)

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

Constraints:

min: 1

max: 80

FilePath -> (string) [required]

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

Constraints:

min: 1

max: 1024

LineNumber -> (integer)

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

Constraints:

min: 1

LocationHash -> (string)

The pre-computed location hash (16-character hex string)

Constraints:

min: 16

max: 16

Shorthand Syntax:

CodeLocation={Language=string,CodeUnit=string,ClassName=string,MethodName=string,FilePath=string,LineNumber=integer},LocationHash=string

JSON Syntax:

{
  "CodeLocation": {
    "Language": "Java"|"Python"|"Javascript",
    "CodeUnit": "string",
    "ClassName": "string",
    "MethodName": "string",
    "FilePath": "string",
    "LineNumber": integer
  },
  "LocationHash": "string"
}

--status (string)

The single status to query for. If omitted, only ACTIVE status events are returned.

Possible values:

READY

ERROR

ACTIVE

DISABLED

--start-time (timestamp)

The start of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

--end-time (timestamp)

The end of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

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

Constraints:

min: 1

max: 100

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

Service -> (string)

The service name echoed from the request.

Constraints:

min: 1

max: 255

Environment -> (string)

The environment echoed from the request.

Constraints:

min: 1

max: 255

SignalType -> (string)

The telemetry signal type echoed from the request.

Possible values:

SNAPSHOT

Location -> (tagged union structure)

The code location echoed from the request.

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) [required]

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

Possible values:

Java

Python

Javascript

CodeUnit -> (string)

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

Constraints:

min: 1

max: 128

ClassName -> (string)

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

Constraints:

min: 1

max: 128

MethodName -> (string)

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

Constraints:

min: 1

max: 80

FilePath -> (string) [required]

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

Constraints:

min: 1

max: 1024

LineNumber -> (integer)

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

Constraints:

min: 1

Status -> (string)

The status that was queried. If not specified in the request, this is ACTIVE .

Possible values:

READY

ERROR

ACTIVE

DISABLED

Events -> (list)

The list of status events within the requested time window, sorted with the most recent first. Error events include an error cause.

(structure)

A status event for an instrumentation configuration returned by GetInstrumentationConfigurationStatus . Events include the timestamp and, for errors, an error cause.

Time -> (timestamp) [required]

The time when the status was reported, rounded to the nearest minute.

ErrorCause -> (string)

The error cause when the status is ERROR .

Possible values:

FILE_NOT_FOUND

METHOD_NOT_FOUND

LINE_NOT_EXECUTABLE

OVERLOADED_METHODS

LANGUAGE_MISMATCH

RUNTIME_ERROR

NextToken -> (string)

Pagination token to continue retrieving status events.

Table of Contents

Feedback

User Guide