SecurityAgent / Client / list_threat_model_jobs

list_threat_model_jobs¶

SecurityAgent.Client.list_threat_model_jobs(**kwargs)¶

Returns a paginated list of threat model job summaries for the specified threat model.

Request Syntax

response = client.list_threat_model_jobs(
    maxResults=123,
    threatModelId='string',
    agentSpaceId='string',
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call.
threatModelId (string) –
[REQUIRED]

The unique identifier of the threat model to list jobs for.
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space.
nextToken (string) – A token to use for paginating results that are returned in the response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Output for the ListThreatModelJobs operation.
- threatModelJobSummaries (list) –
  
  The list of threat model job summaries.
  - (dict) –
    
    Contains summary information about a threat model job.
    - threatModelJobId (string) –
      
      The unique identifier of the threat model job.
    - threatModelId (string) –
      
      The unique identifier of the threat model associated with the job.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space.
    - 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.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response.