View a markdown version of this page

BatchDeleteInstrumentationConfigurations - Application Signals

BatchDeleteInstrumentationConfigurations

Deletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods:

  • By scope: delete all configurations matching a service, environment, and instrumentation type.

  • By ARN list: delete specific configurations by providing a list of resource ARNs.

Request Syntax

POST /batch-delete-instrumentation-configurations HTTP/1.1 Content-type: application/json { "DeletionTarget": { ... } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DeletionTarget

The deletion target - either bulk by scope or targeted by ARN list.

Type: BatchDeleteDeletionTarget object

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DeletedCount": number, "Errors": [ { "Code": "string", "Message": "string", "ResourceArn": "string" } ], "SuccessfulDeletions": [ { "LocationHash": "string", "ResourceArn": "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.

DeletedCount

The number of configurations successfully deleted. When deleting by scope, this is the total count of deleted items. When deleting by ARN list, this equals the length of SuccessfulDeletions.

Type: Integer

Errors

The list of configurations that failed to delete.

Type: Array of BatchDeleteError objects

SuccessfulDeletions

The list of successfully deleted configurations. Deleting by scope populates SignalType and LocationHash per item; deleting by ARN list populates ResourceArn per item.

Type: Array of BatchDeleteSuccessfulDeletion objects

Errors

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

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: