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

GetInstrumentationConfiguration

Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.

Request Syntax


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

{
   "Environment": "string",
   "InstrumentationType": "string",
   "LocationIdentifier": { ... },
   "Service": "string",
   "SignalType": "string"
}

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

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Configuration": { 
      "ARN": "string",
      "AttributeFilters": [ 
         { 
            "string" : "string" 
         }
      ],
      "CaptureConfiguration": { ... },
      "CreatedAt": number,
      "Description": "string",
      "Environment": "string",
      "ExpiresAt": number,
      "InstrumentationType": "string",
      "Location": { ... },
      "LocationHash": "string",
      "Service": "string",
      "SignalType": "string"
   }
}

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.

Configuration

The complete instrumentation configuration, including its location hash, capture settings, filters, expiration, and creation time.

Type: InstrumentationConfiguration object

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFoundException

Resource not found.

ResourceId: Can't find the resource id.
ResourceType: The resource type is not valid.

HTTP Status Code: 404

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400