SecurityAgent / Client / batch_delete_threat_models

batch_delete_threat_models¶

SecurityAgent.Client.batch_delete_threat_models(**kwargs)¶

Deletes one or more threat models from an agent space.

Request Syntax

response = client.batch_delete_threat_models(
    threatModelIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

threatModelIds (list) –
[REQUIRED]

The list of threat model identifiers to delete.
- (string) –
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space that contains the threat models to delete.

Return type:

dict

Returns:

Response Syntax

{
    'deleted': [
        'string',
    ],
    'failed': [
        {
            'threatModelId': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) –

Output for the BatchDeleteThreatModels operation.
- deleted (list) –
  
  The list of threat model identifiers that were successfully deleted.
  - (string) –
- failed (list) –
  
  The list of threat models that failed to delete, including the reason for each failure.
  - (dict) –
    
    Contains information about a threat model that failed to delete.
    - threatModelId (string) –
      
      The unique identifier of the threat model that failed to delete.
    - reason (string) –
      
      The reason the threat model failed to delete.