CloudWatchApplicationSignals / Client / get_instrumentation_configuration_status

get_instrumentation_configuration_status¶

CloudWatchApplicationSignals.Client.get_instrumentation_configuration_status(**kwargs)¶

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.

Request Syntax

response = 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'
)

Parameters:

InstrumentationType (string) –
[REQUIRED]

Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
Service (string) –
[REQUIRED]

Service name for the instrumentation configuration.
Environment (string) –
[REQUIRED]

Environment name for the instrumentation configuration.
SignalType (string) –
[REQUIRED]

Signal type for the instrumentation configuration.
LocationIdentifier (dict) –
[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 (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)
Status (string) – The single status to query for. If omitted, only ACTIVE status events are returned.
StartTime (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.
EndTime (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.
MaxResults (integer) – The maximum number of status events to return in one call. The default is 60.
NextToken (string) – Use the token returned by a previous call to retrieve the next page of status events.

Return type:

dict

Returns:

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.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: CodeLocation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - 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.

Exceptions

CloudWatchApplicationSignals.Client.exceptions.ValidationException
CloudWatchApplicationSignals.Client.exceptions.ThrottlingException
CloudWatchApplicationSignals.Client.exceptions.ResourceNotFoundException