2026/06/22 - Amazon CloudWatch Application Signals - 7 new api methods
Changes Application Signals now supports dynamic instrumentation and Service Events telemetry. Add instrumentation at runtime without restarts, and use fine-grained profiling data to quickly pinpoint latency and error root causes.
Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after creation.
For BREAKPOINT type configurations, they expire after 24 hours unless a shorter expiration is provided. For PROBE type configurations, they persist until explicitly deleted; an expiration cannot be set for PROBE configurations.
If a configuration already exists for the same service, environment, signal type, and location, this operation returns a conflict instead of overwriting it. Use attribute filters and capture settings to control where the instrumentation runs and which data is collected.
See also: AWS API Documentation
Request Syntax
client.create_instrumentation_configuration(
InstrumentationType='BREAKPOINT'|'PROBE',
Service='string',
Environment='string',
SignalType='SNAPSHOT',
Location={
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
}
},
Description='string',
ExpiresAt=datetime(2015, 1, 1),
AttributeFilters=[
{
'string': 'string'
},
],
CaptureConfiguration={
'CodeCapture': {
'CaptureArguments': [
'string',
],
'CaptureReturn': True|False,
'CaptureStackTrace': True|False,
'CaptureLocals': [
'string',
],
'CaptureLimits': {
'MaxHits': 123,
'MaxStringLength': 123,
'MaxCollectionWidth': 123,
'MaxCollectionDepth': 123,
'MaxStackFrames': 123,
'MaxStackTraceSize': 123,
'MaxObjectDepth': 123,
'MaxFieldsPerObject': 123
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)
string
[REQUIRED]
The name of the service to instrument. This should match the service.name resource attribute reported by the application.
string
[REQUIRED]
The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.
string
[REQUIRED]
The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
dict
[REQUIRED]
The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.
CodeLocation (dict) --
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.
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) -- [REQUIRED]
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.
string
An optional short description (up to 50 characters) that explains the purpose of this instrumentation.
datetime
For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.
list
Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.
(dict) --
A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance.
(string) --
(string) --
dict
[REQUIRED]
Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.
CodeCapture (dict) --
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 (dict) -- [REQUIRED]
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.
list
An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.
(dict) --
A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
Key (string) -- [REQUIRED]
A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
Value (string) -- [REQUIRED]
The value for the specified tag key.
dict
Response Syntax
{
'InstrumentationType': 'BREAKPOINT'|'PROBE',
'Service': 'string',
'Environment': 'string',
'SignalType': 'SNAPSHOT',
'Location': {
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
}
},
'LocationHash': 'string',
'Description': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'AttributeFilters': [
{
'string': 'string'
},
],
'CaptureConfiguration': {
'CodeCapture': {
'CaptureArguments': [
'string',
],
'CaptureReturn': True|False,
'CaptureStackTrace': True|False,
'CaptureLocals': [
'string',
],
'CaptureLimits': {
'MaxHits': 123,
'MaxStringLength': 123,
'MaxCollectionWidth': 123,
'MaxCollectionDepth': 123,
'MaxStackFrames': 123,
'MaxStackTraceSize': 123,
'MaxObjectDepth': 123,
'MaxFieldsPerObject': 123
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ARN': 'string'
}
Response Structure
(dict) --
InstrumentationType (string) --
The type of instrumentation that was created, echoed from the request.
Service (string) --
The service name for the instrumentation configuration, echoed from the request.
Environment (string) --
The environment for the instrumentation configuration, echoed from the request.
SignalType (string) --
The telemetry signal type for the instrumentation configuration, echoed from the request.
Location (dict) --
The location where instrumentation is applied, echoed from the request.
CodeLocation (dict) --
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) --
A stable hash computed from the location that uniquely identifies this instrumentation point within the service, environment, and signal type.
Description (string) --
The optional description that was stored with the instrumentation configuration.
ExpiresAt (datetime) --
The timestamp after which this configuration is no longer served to clients. Present only for BREAKPOINT configurations; PROBE configurations do not expire.
AttributeFilters (list) --
The attribute filters returned with the configuration so SDKs can perform client-side targeting.
(dict) --
A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance.
(string) --
(string) --
CaptureConfiguration (dict) --
The capture settings that were stored for this instrumentation configuration.
CodeCapture (dict) --
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 (dict) --
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 (datetime) --
The server-generated creation timestamp for this instrumentation configuration.
ARN (string) --
ARN for the created instrumentation configuration
Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.
See also: AWS API Documentation
Request Syntax
client.get_instrumentation_configuration(
InstrumentationType='BREAKPOINT'|'PROBE',
Service='string',
Environment='string',
SignalType='SNAPSHOT',
LocationIdentifier={
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
},
'LocationHash': 'string'
}
)
string
[REQUIRED]
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
string
[REQUIRED]
Service name for the instrumentation configuration.
string
[REQUIRED]
Environment name for the instrumentation configuration.
string
[REQUIRED]
Signal type for the instrumentation configuration.
dict
[REQUIRED]
Location identifier - either full code location or a pre-computed hash.
CodeLocation (dict) --
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.
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) -- [REQUIRED]
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 pre-computed location hash (16-character hex string)
dict
Response Syntax
{
'Configuration': {
'InstrumentationType': 'BREAKPOINT'|'PROBE',
'Service': 'string',
'Environment': 'string',
'SignalType': 'SNAPSHOT',
'Location': {
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
}
},
'LocationHash': 'string',
'Description': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'AttributeFilters': [
{
'string': 'string'
},
],
'CaptureConfiguration': {
'CodeCapture': {
'CaptureArguments': [
'string',
],
'CaptureReturn': True|False,
'CaptureStackTrace': True|False,
'CaptureLocals': [
'string',
],
'CaptureLimits': {
'MaxHits': 123,
'MaxStringLength': 123,
'MaxCollectionWidth': 123,
'MaxCollectionDepth': 123,
'MaxStackFrames': 123,
'MaxStackTraceSize': 123,
'MaxObjectDepth': 123,
'MaxFieldsPerObject': 123
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ARN': 'string'
}
}
Response Structure
(dict) --
Configuration (dict) --
The complete instrumentation configuration, including its location hash, capture settings, filters, expiration, and creation time.
InstrumentationType (string) --
The type of instrumentation for this configuration.
Service (string) --
The service that this instrumentation configuration targets.
Environment (string) --
The environment where the service is running.
SignalType (string) --
The telemetry signal type for this instrumentation configuration.
Location (dict) --
The location where this instrumentation is applied.
CodeLocation (dict) --
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 uniquely identifies this instrumentation point within the service and environment.
Description (string) --
An optional short description of the instrumentation configuration.
ExpiresAt (datetime) --
The timestamp when this configuration expires.
AttributeFilters (list) --
Client-side filters that determine which instances apply this instrumentation.
(dict) --
A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance.
(string) --
(string) --
CaptureConfiguration (dict) --
The capture settings for this instrumentation configuration.
CodeCapture (dict) --
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 (dict) --
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 (datetime) --
The timestamp when this instrumentation configuration was created.
ARN (string) --
ARN for the instrumentation configuration
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
Request Syntax
client.report_instrumentation_configuration_status(
Service='string',
Environment='string',
Configurations=[
{
'InstrumentationType': 'BREAKPOINT'|'PROBE',
'SignalType': 'SNAPSHOT',
'LocationHash': 'string',
'Status': 'READY'|'ERROR'|'ACTIVE'|'DISABLED',
'Time': datetime(2015, 1, 1),
'ErrorCause': 'FILE_NOT_FOUND'|'METHOD_NOT_FOUND'|'LINE_NOT_EXECUTABLE'|'OVERLOADED_METHODS'|'LANGUAGE_MISMATCH'|'RUNTIME_ERROR'
},
]
)
string
[REQUIRED]
The service that the reported configurations belong to.
string
[REQUIRED]
The environment that the service is running in.
list
[REQUIRED]
An array of configuration status reports (up to 100) that include the instrumentation type, signal type, location hash, status, timestamp, and optional error cause.
(dict) --
The status of a single instrumentation configuration reported by an SDK instance.
InstrumentationType (string) -- [REQUIRED]
The type of instrumentation configuration being reported.
SignalType (string) -- [REQUIRED]
The telemetry signal type for this instrumentation configuration.
LocationHash (string) -- [REQUIRED]
The stable hash of the instrumentation location that identifies the configuration being reported.
Status (string) -- [REQUIRED]
The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.
Time (datetime) -- [REQUIRED]
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.
dict
Response Syntax
{
'Service': 'string',
'Environment': 'string',
'UnprocessedStatusEvents': [
{
'InstrumentationType': 'BREAKPOINT'|'PROBE',
'SignalType': 'SNAPSHOT',
'LocationHash': 'string',
'Status': 'READY'|'ERROR'|'ACTIVE'|'DISABLED',
'Time': datetime(2015, 1, 1),
'FailedReason': 'THROTTLED'|'INTERNAL_ERROR'|'VALIDATION_ERROR'
},
]
}
Response Structure
(dict) --
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.
(dict) --
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 (datetime) --
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.
Deletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods:
By scope: Delete all configurations matching a Service + Environment + InstrumentationType
By ARN list: Delete specific configurations by providing a list of resource ARNs
See also: AWS API Documentation
Request Syntax
client.batch_delete_instrumentation_configurations(
DeletionTarget={
'Scope': {
'Service': 'string',
'Environment': 'string',
'InstrumentationType': 'BREAKPOINT'|'PROBE'
},
'ResourceArns': {
'ResourceArns': [
'string',
],
'InstrumentationType': 'BREAKPOINT'|'PROBE'
}
}
)
dict
[REQUIRED]
The deletion target - either bulk by scope or targeted by ARN list.
Scope (dict) --
Delete all configurations matching the specified scope.
Service (string) -- [REQUIRED]
Service name for the instrumentation configurations.
Environment (string) -- [REQUIRED]
Environment identifier for the instrumentation configurations.
InstrumentationType (string) -- [REQUIRED]
Instrumentation type: BREAKPOINT or PROBE.
ResourceArns (dict) --
Delete specific configurations by ARN list.
ResourceArns (list) -- [REQUIRED]
List of resource ARNs to delete.
(string) --
InstrumentationType (string) -- [REQUIRED]
Instrumentation type: BREAKPOINT or PROBE.
dict
Response Syntax
{
'DeletedCount': 123,
'SuccessfulDeletions': [
{
'ResourceArn': 'string',
'SignalType': 'string',
'LocationHash': 'string'
},
],
'Errors': [
{
'ResourceArn': 'string',
'Code': 'ResourceNotFoundException'|'AccessDeniedException'|'InternalServiceException',
'Message': 'string'
},
]
}
Response Structure
(dict) --
DeletedCount (integer) --
Number of configurations successfully deleted. When deleting by scope, this is the total count of deleted items. When deleting by ARN list, this equals the length of SuccessfulDeletions.
SuccessfulDeletions (list) --
List of successfully deleted configurations. Deleting by scope populates SignalType and LocationHash per item. Deleting by ARN list populates ResourceArn per item.
(dict) --
Represents a successfully deleted instrumentation configuration.
ResourceArn (string) --
ARN of the deleted configuration (populated only when deleting by ARN list).
SignalType (string) --
Signal type of the deleted configuration (populated only when deleting by scope).
LocationHash (string) --
Location hash of the deleted configuration (populated only when deleting by scope).
Errors (list) --
List of configurations that failed to delete.
(dict) --
Represents an error that occurred when attempting to delete a configuration.
ResourceArn (string) --
ARN of the configuration that failed to delete.
Code (string) --
Error code indicating the type of failure.
Message (string) --
Descriptive error message.
Deletes the specified instrumentation configuration. SDKs remove the instrumentation during their next sync after the configuration is deleted or expires.
See also: AWS API Documentation
Request Syntax
client.delete_instrumentation_configuration(
InstrumentationType='BREAKPOINT'|'PROBE',
Service='string',
Environment='string',
SignalType='SNAPSHOT',
LocationIdentifier={
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
},
'LocationHash': 'string'
}
)
string
[REQUIRED]
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to delete.
string
[REQUIRED]
Service name for the instrumentation configuration.
string
[REQUIRED]
Environment name for the instrumentation configuration.
string
[REQUIRED]
Signal type for the instrumentation configuration.
dict
[REQUIRED]
Location identifier - either full code location or a pre-computed hash.
CodeLocation (dict) --
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.
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) -- [REQUIRED]
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 pre-computed location hash (16-character hex string)
dict
Response Syntax
{
'DeletionStatus': 'DELETED'
}
Response Structure
(dict) --
DeletionStatus (string) --
The result of the delete request. The value is DELETED when the configuration has been removed.
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.
See also: AWS API Documentation
Request Syntax
client.get_instrumentation_configuration_status(
InstrumentationType='BREAKPOINT'|'PROBE',
Service='string',
Environment='string',
SignalType='SNAPSHOT',
LocationIdentifier={
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
},
'LocationHash': 'string'
},
Status='READY'|'ERROR'|'ACTIVE'|'DISABLED',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
string
[REQUIRED]
Service name for the instrumentation configuration.
string
[REQUIRED]
Environment name for the instrumentation configuration.
string
[REQUIRED]
Signal type for the instrumentation configuration.
dict
[REQUIRED]
Location identifier - either full code location or a pre-computed hash.
CodeLocation (dict) --
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.
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) -- [REQUIRED]
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 pre-computed location hash (16-character hex string)
string
The single status to query for. If omitted, only ACTIVE status events are returned.
datetime
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.
datetime
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.
integer
The maximum number of status events to return in one call. The default is 60.
string
Use the token returned by a previous call to retrieve the next page of status events.
dict
Response Syntax
{
'Service': 'string',
'Environment': 'string',
'SignalType': 'SNAPSHOT',
'Location': {
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
}
},
'Status': 'READY'|'ERROR'|'ACTIVE'|'DISABLED',
'Events': [
{
'Time': datetime(2015, 1, 1),
'ErrorCause': 'FILE_NOT_FOUND'|'METHOD_NOT_FOUND'|'LINE_NOT_EXECUTABLE'|'OVERLOADED_METHODS'|'LANGUAGE_MISMATCH'|'RUNTIME_ERROR'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Service (string) --
The service name echoed from the request.
Environment (string) --
The environment echoed from the request.
SignalType (string) --
The telemetry signal type echoed from the request.
Location (dict) --
The code location echoed from the request.
CodeLocation (dict) --
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.
Status (string) --
The status that was queried. If not specified in the request, this is ACTIVE.
Events (list) --
The list of status events within the requested time window, sorted with the most recent first. Error events include an error cause.
(dict) --
A status event for an instrumentation configuration returned by GetInstrumentationConfigurationStatus. Events include the timestamp and, for errors, an error cause.
Time (datetime) --
The time when the status was reported, rounded to the nearest minute.
ErrorCause (string) --
The error cause when the status is ERROR.
NextToken (string) --
Pagination token to continue retrieving status events.
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
Request Syntax
client.list_instrumentation_configurations(
Service='string',
Environment='string',
InstrumentationType='BREAKPOINT'|'PROBE',
SyncedAt=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name of the service to retrieve instrumentation configurations for.
string
[REQUIRED]
The environment that the service is running in.
string
[REQUIRED]
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.
datetime
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.
integer
The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.
string
Use the token returned by a previous call to retrieve the next page of configurations.
dict
Response Syntax
{
'Service': 'string',
'Environment': 'string',
'Changed': True|False,
'LatestConfigurations': [
{
'InstrumentationType': 'BREAKPOINT'|'PROBE',
'SignalType': 'SNAPSHOT',
'Location': {
'CodeLocation': {
'Language': 'Java'|'Python'|'Javascript',
'CodeUnit': 'string',
'ClassName': 'string',
'MethodName': 'string',
'FilePath': 'string',
'LineNumber': 123
}
},
'LocationHash': 'string',
'Description': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'AttributeFilters': [
{
'string': 'string'
},
],
'CaptureConfiguration': {
'CodeCapture': {
'CaptureArguments': [
'string',
],
'CaptureReturn': True|False,
'CaptureStackTrace': True|False,
'CaptureLocals': [
'string',
],
'CaptureLimits': {
'MaxHits': 123,
'MaxStringLength': 123,
'MaxCollectionWidth': 123,
'MaxCollectionDepth': 123,
'MaxStackFrames': 123,
'MaxStackTraceSize': 123,
'MaxObjectDepth': 123,
'MaxFieldsPerObject': 123
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ARN': 'string'
},
],
'SyncedAt': datetime(2015, 1, 1),
'SyncInterval': 123,
'NextToken': 'string'
}
Response Structure
(dict) --
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.
(dict) --
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 (dict) --
The location where this instrumentation is applied.
CodeLocation (dict) --
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 (datetime) --
The timestamp when this configuration expires.
AttributeFilters (list) --
Client-side filters that determine which instances apply this instrumentation.
(dict) --
A string-to-string map of OpenTelemetry resource attributes and values that must all match for the instrumentation to run on an instance.
(string) --
(string) --
CaptureConfiguration (dict) --
The capture settings for this instrumentation configuration.
CodeCapture (dict) --
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 (dict) --
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 (datetime) --
The timestamp when this instrumentation configuration was created.
ARN (string) --
ARN for the instrumentation configuration
SyncedAt (datetime) --
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.