CloudWatchApplicationSignals / Client / batch_delete_instrumentation_configurations

batch_delete_instrumentation_configurations¶

CloudWatchApplicationSignals.Client.batch_delete_instrumentation_configurations(**kwargs)¶

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

By scope: Delete all configurations matching a Service + Environment + InstrumentationType
By ARN list: Delete specific configurations by providing a list of resource ARNs

Request Syntax

response = client.batch_delete_instrumentation_configurations(
    DeletionTarget={
        'Scope': {
            'Service': 'string',
            'Environment': 'string',
            'InstrumentationType': 'BREAKPOINT'|'PROBE'
        },
        'ResourceArns': {
            'ResourceArns': [
                'string',
            ],
            'InstrumentationType': 'BREAKPOINT'|'PROBE'
        }
    }
)

Parameters:

DeletionTarget (dict) –

[REQUIRED]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Scope, ResourceArns.

Scope (dict) –

Delete all configurations matching the specified scope.
- Service (string) – [REQUIRED]
  
  Service name for the instrumentation configurations.
- Environment (string) – [REQUIRED]
  
  Environment identifier for the instrumentation configurations.
- InstrumentationType (string) – [REQUIRED]
  
  Instrumentation type: BREAKPOINT or PROBE.
ResourceArns (dict) –

Delete specific configurations by ARN list.
- ResourceArns (list) – [REQUIRED]
  
  List of resource ARNs to delete.
  - (string) –
- InstrumentationType (string) – [REQUIRED]
  
  Instrumentation type: BREAKPOINT or PROBE.

Return type:

dict

Returns:

Response Syntax

{
    'DeletedCount': 123,
    'SuccessfulDeletions': [
        {
            'ResourceArn': 'string',
            'SignalType': 'string',
            'LocationHash': 'string'
        },
    ],
    'Errors': [
        {
            'ResourceArn': 'string',
            'Code': 'ResourceNotFoundException'|'AccessDeniedException'|'InternalServiceException',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) –
- DeletedCount (integer) –
  
  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.
- SuccessfulDeletions (list) –
  
  List of successfully deleted configurations. Deleting by scope populates SignalType and LocationHash per item. Deleting by ARN list populates ResourceArn per item.
  - (dict) –
    
    Represents a successfully deleted instrumentation configuration.
    - ResourceArn (string) –
      
      ARN of the deleted configuration (populated only when deleting by ARN list).
    - SignalType (string) –
      
      Signal type of the deleted configuration (populated only when deleting by scope).
    - LocationHash (string) –
      
      Location hash of the deleted configuration (populated only when deleting by scope).
- Errors (list) –
  
  List of configurations that failed to delete.
  - (dict) –
    
    Represents an error that occurred when attempting to delete a configuration.
    - ResourceArn (string) –
      
      ARN of the configuration that failed to delete.
    - Code (string) –
      
      Error code indicating the type of failure.
    - Message (string) –
      
      Descriptive error message.

Exceptions

CloudWatchApplicationSignals.Client.exceptions.ValidationException
CloudWatchApplicationSignals.Client.exceptions.ThrottlingException