SecurityAgent / Client / start_threat_model_job

start_threat_model_job¶

SecurityAgent.Client.start_threat_model_job(**kwargs)¶

Starts a new threat model job for a threat model configuration.

Request Syntax

response = client.start_threat_model_job(
    agentSpaceId='string',
    threatModelId='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space.
threatModelId (string) –
[REQUIRED]

The unique identifier of the threat model to start a job for.

Return type:

dict

Returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'threatModelId': 'string',
    'threatModelJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

(dict) –

Output for the StartThreatModelJob operation.
- title (string) –
  
  The title of the threat model job.
- status (string) –
  
  The current status of the threat model job.
- createdAt (datetime) –
  
  The date and time the threat model job was created, in UTC format.
- updatedAt (datetime) –
  
  The date and time the threat model job was last updated, in UTC format.
- threatModelId (string) –
  
  The unique identifier of the threat model.
- threatModelJobId (string) –
  
  The unique identifier of the started threat model job.
- agentSpaceId (string) –
  
  The unique identifier of the agent space.