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

ListInstrumentationConfigurations

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.

Request Syntax


POST /list-instrumentation-configurations HTTP/1.1
Content-type: application/json

{
   "Environment": "string",
   "InstrumentationType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Service": "string",
   "SyncedAt": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Environment

The environment that the service is running in.

Type: String

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

Pattern: [A-Za-z0-9:/+=,.@_-]+

Required: Yes

InstrumentationType

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

Type: String

Valid Values: BREAKPOINT | PROBE

Required: Yes

MaxResults

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

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

Type: String

Required: No

Service

The name of the service to retrieve instrumentation configurations for.

Type: String

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

Pattern: [A-Za-z0-9:/+=,.@_-]+

Required: Yes

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.

Type: Timestamp

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Changed": boolean,
   "Environment": "string",
   "LatestConfigurations": [ 
      { 
         "ARN": "string",
         "AttributeFilters": [ 
            { 
               "string" : "string" 
            }
         ],
         "CaptureConfiguration": { ... },
         "CreatedAt": number,
         "Description": "string",
         "ExpiresAt": number,
         "InstrumentationType": "string",
         "Location": { ... },
         "LocationHash": "string",
         "SignalType": "string"
      }
   ],
   "NextToken": "string",
   "Service": "string",
   "SyncedAt": number,
   "SyncInterval": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Changed

Indicates whether there are configuration changes since the provided SyncedAt timestamp.

Type: Boolean

Environment

The environment associated with the returned configurations.

Type: String

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

LatestConfigurations

The current set of active instrumentation configurations for the service and environment. Items omit service and environment because they are provided in the request.

Type: Array of InstrumentationConfigurationWithoutServiceEnv objects

NextToken