CloudWatchApplicationSignals / Paginator / ListInstrumentationConfigurations

ListInstrumentationConfigurations

class CloudWatchApplicationSignals.Paginator.ListInstrumentationConfigurations

paginator = client.get_paginator('list_instrumentation_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchApplicationSignals.Client.list_instrumentation_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Service='string',
    Environment='string',
    InstrumentationType='BREAKPOINT'|'PROBE',
    SyncedAt=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Service (string) –

  [REQUIRED]

  The name of the service to retrieve instrumentation configurations for.

• Environment (string) –

  [REQUIRED]

  The environment that the service is running in.

• InstrumentationType (string) –

  [REQUIRED]

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

• SyncedAt (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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

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,

}

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.

        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.

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

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: CodeCapture. 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'}
        

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