CloudWatchApplicationSignals / Client / delete_instrumentation_configuration

delete_instrumentation_configuration

CloudWatchApplicationSignals.Client.delete_instrumentation_configuration(**kwargs)

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

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

  • InstrumentationType (string) –

    [REQUIRED]

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

  • 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)

Return type:

dict

Returns:

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.

Exceptions