Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetInstrumentationConfigurationStatus

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.

Request Syntax


POST /get-instrumentation-configuration-status HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "Environment": "string",
   "InstrumentationType": "string",
   "LocationIdentifier": { ... },
   "MaxResults": number,
   "NextToken": "string",
   "Service": "string",
   "SignalType": "string",
   "StartTime": number,
   "Status": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Type: Timestamp

Required: No

Environment

The environment name for the instrumentation configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

InstrumentationType

The type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

Type: String

Valid Values: BREAKPOINT | PROBE

Required: Yes

LocationIdentifier

The location identifier - either the full code location or a pre-computed location hash.

Type: LocationIdentifier object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

Service

The service name for the instrumentation configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

SignalType

The telemetry signal type for instrumentation.

SNAPSHOT - Captures a snapshot of the instrumentation point.

Type: String

Valid Values: SNAPSHOT

Required: Yes

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.

Type: Timestamp

Required: No

Status

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

Type: String

Valid Values: READY | ERROR | ACTIVE | DISABLED

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Environment": "string",
   "Events": [ 
      { 
         "ErrorCause": "string",
         "Time": number
      }
   ],
   "Location": { ... },
   "NextToken": "string",
   "Service": "string",
   "SignalType": "string",
   "Status": "string"
}