getInstrumentationConfigurationStatus method
- required String environment,
- required InstrumentationType instrumentationType,
- required LocationIdentifier locationIdentifier,
- required String service,
- required DynamicInstrumentationSignalType signalType,
- DateTime? endTime,
- int? maxResults,
- String? nextToken,
- DateTime? startTime,
- InstrumentationConfigurationStatus? status,
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.
May throw ResourceNotFoundException.
May throw ThrottlingException.
May throw ValidationException.
Parameter environment :
Environment name for the instrumentation configuration.
Parameter instrumentationType :
Type of instrumentation configuration (BREAKPOINT or PROBE). Required to
identify the configuration to retrieve.
Parameter locationIdentifier :
Location identifier - either full code location or a pre-computed hash.
Parameter service :
Service name for the instrumentation configuration.
Parameter signalType :
Signal type for the instrumentation configuration.
Parameter 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.
Parameter maxResults :
The maximum number of status events to return in one call. The default is
60.
Parameter nextToken :
Use the token returned by a previous call to retrieve the next page of
status events.
Parameter 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.
Parameter status :
The single status to query for. If omitted, only ACTIVE
status events are returned.
Implementation
Future<GetInstrumentationConfigurationStatusResponse>
getInstrumentationConfigurationStatus({
required String environment,
required InstrumentationType instrumentationType,
required LocationIdentifier locationIdentifier,
required String service,
required DynamicInstrumentationSignalType signalType,
DateTime? endTime,
int? maxResults,
String? nextToken,
DateTime? startTime,
InstrumentationConfigurationStatus? status,
}) async {
final $payload = <String, dynamic>{
'Environment': environment,
'InstrumentationType': instrumentationType.value,
'LocationIdentifier': locationIdentifier,
'Service': service,
'SignalType': signalType.value,
if (endTime != null) 'EndTime': unixTimestampToJson(endTime),
if (maxResults != null) 'MaxResults': maxResults,
if (nextToken != null) 'NextToken': nextToken,
if (startTime != null) 'StartTime': unixTimestampToJson(startTime),
if (status != null) 'Status': status.value,
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri: '/get-instrumentation-configuration-status',
exceptionFnMap: _exceptionFns,
);
return GetInstrumentationConfigurationStatusResponse.fromJson(response);
}