Retrieves the status history for a single instrumentation configuration during a specified time range¶

Description¶

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.

Usage¶

cloudwatchapplicationsignals_get_instrumentation_configuration_status(
  InstrumentationType, Service, Environment, SignalType,
  LocationIdentifier, Status, StartTime, EndTime, MaxResults, NextToken)

Arguments¶

• InstrumentationType

  [required] Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

• Service

  [required] Service name for the instrumentation configuration.

• Environment

  [required] Environment name for the instrumentation configuration.

• SignalType

  [required] Signal type for the instrumentation configuration.

• LocationIdentifier

  [required] Location identifier - either full code location or a pre-computed hash.

• Status

  The single status to query for. If omitted, only ACTIVE status events are returned.

• StartTime

  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

  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

  The maximum number of status events to return in one call. The default is 60.

• NextToken

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

Value¶

A list with the following syntax:

list(
  Service = "string",
  Environment = "string",
  SignalType = "SNAPSHOT",
  Location = list(
    CodeLocation = list(
      Language = "Java"|"Python"|"Javascript",
      CodeUnit = "string",
      ClassName = "string",
      MethodName = "string",
      FilePath = "string",
      LineNumber = 123
    )
  ),
  Status = "READY"|"ERROR"|"ACTIVE"|"DISABLED",
  Events = list(
    list(
      Time = as.POSIXct(
        "2015-01-01"
      ),
      ErrorCause = "FILE_NOT_FOUND"|"METHOD_NOT_FOUND"|"LINE_NOT_EXECUTABLE"|"OVERLOADED_METHODS"|"LANGUAGE_MISMATCH"|"RUNTIME_ERROR"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_instrumentation_configuration_status(
  InstrumentationType = "BREAKPOINT"|"PROBE",
  Service = "string",
  Environment = "string",
  SignalType = "SNAPSHOT",
  LocationIdentifier = list(
    CodeLocation = list(
      Language = "Java"|"Python"|"Javascript",
      CodeUnit = "string",
      ClassName = "string",
      MethodName = "string",
      FilePath = "string",
      LineNumber = 123
    ),
    LocationHash = "string"
  ),
  Status = "READY"|"ERROR"|"ACTIVE"|"DISABLED",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NextToken = "string"
)