Skip to content

list_instrumentation_configurations

list_instrumentation_configurations(
    service: str,
    environment: str,
    instrumentation_type: InstrumentationType,
    *,
    config_overrides: Optional[ApplicationSignalsClientConfig] = None,
    synced_at: Optional[datetime] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
) -> InstrumentationConfigurationsPage

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.

Parameters:

  • service (str) –

    The name of the service to retrieve instrumentation configurations for.

  • environment (str) –

    The environment that the service is running in.

  • instrumentation_type (InstrumentationType) –

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

  • synced_at (Optional[datetime], default: None ) –

    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.

  • max_results (Optional[int], default: None ) –

    The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.

  • next_token (Optional[NextToken], default: None ) –

    Use the token returned by a previous call to retrieve the next page of configurations.

Raises:

Source code in docs_src/capo_application_signals/_services/application_signals.py
def list_instrumentation_configurations(
    self,
    service: str,
    environment: str,
    instrumentation_type: "capo_application_signals.types.instrumentation_type.InstrumentationType",
    *,
    config_overrides: Optional[ApplicationSignalsClientConfig] = None,
    synced_at: Optional[datetime.datetime] = None,
    max_results: Optional[int] = None,
    next_token: Optional[
        "capo_application_signals.types.next_token.NextToken"
    ] = None,
) -> "capo_application_signals.types.instrumentation_configurations_page.InstrumentationConfigurationsPage":
    """<p>Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally.</p> <p>Include the previous <code>SyncedAt</code> value to perform incremental syncs. When no changes are detected, the response sets <code>Changed</code> to <code>false</code> and omits configuration details.</p>

    Args:
        service: <p>The name of the service to retrieve instrumentation configurations for.</p>
        environment: <p>The environment that the service is running in.</p>
        instrumentation_type: Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.
        synced_at: <p>The timestamp from the last successful sync. When provided, the response returns <code>Changed</code> as <code>false</code> if nothing is new since this time, or returns the latest configurations when changes exist.</p>
        max_results: <p>The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.</p>
        next_token: <p>Use the token returned by a previous call to retrieve the next page of configurations.</p>

    Raises:
        capo_application_signals.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_application_signals.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
        capo_application_signals.errors.validation_exception.ValidationException: <p>The resource is not valid.</p>
        capo_application_signals.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_application_signals.types.list_instrumentation_configurations_request.ListInstrumentationConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_application_signals.types.instrumentation_configurations_page.InstrumentationConfigurationsPage"
    ]:
        import capo_application_signals._operations.application_signals.list_instrumentation_configurations

        output, http_response = (
            capo_application_signals._operations.application_signals.list_instrumentation_configurations.list_instrumentation_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListInstrumentationConfigurations")
    )
    input_: capo_application_signals.types.list_instrumentation_configurations_request.ListInstrumentationConfigurationsRequest = {
        "service": service,
        "environment": environment,
        "instrumentation_type": instrumentation_type,
    }
    if synced_at is not None:
        input_["synced_at"] = synced_at
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output