Returns all active instrumentation configurations for a service and environment¶

Description¶

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.

Usage¶

cloudwatchapplicationsignals_list_instrumentation_configurations(
  Service, Environment, InstrumentationType, SyncedAt, MaxResults,
  NextToken)

Arguments¶

Service

[required] The name of the service to retrieve instrumentation configurations for.
Environment

[required] The environment that the service is running in.
InstrumentationType

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

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

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

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

Value¶

A list with the following syntax:

list(
  Service = "string",
  Environment = "string",
  Changed = TRUE|FALSE,
  LatestConfigurations = list(
    list(
      InstrumentationType = "BREAKPOINT"|"PROBE",
      SignalType = "SNAPSHOT",
      Location = list(
        CodeLocation = list(
          Language = "Java"|"Python"|"Javascript",
          CodeUnit = "string",
          ClassName = "string",
          MethodName = "string",
          FilePath = "string",
          LineNumber = 123
        )
      ),
      LocationHash = "string",
      Description = "string",
      ExpiresAt = as.POSIXct(
        "2015-01-01"
      ),
      AttributeFilters = list(
        list(
          "string"
        )
      ),
      CaptureConfiguration = list(
        CodeCapture = list(
          CaptureArguments = list(
            "string"
          ),
          CaptureReturn = TRUE|FALSE,
          CaptureStackTrace = TRUE|FALSE,
          CaptureLocals = list(
            "string"
          ),
          CaptureLimits = list(
            MaxHits = 123,
            MaxStringLength = 123,
            MaxCollectionWidth = 123,
            MaxCollectionDepth = 123,
            MaxStackFrames = 123,
            MaxStackTraceSize = 123,
            MaxObjectDepth = 123,
            MaxFieldsPerObject = 123
          )
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ARN = "string"
    )
  ),
  SyncedAt = as.POSIXct(
    "2015-01-01"
  ),
  SyncInterval = 123,
  NextToken = "string"
)

Request syntax¶

svc$list_instrumentation_configurations(
  Service = "string",
  Environment = "string",
  InstrumentationType = "BREAKPOINT"|"PROBE",
  SyncedAt = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NextToken = "string"
)