SecurityAgent / Client / list_threat_models

list_threat_models¶

SecurityAgent.Client.list_threat_models(**kwargs)¶

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

Request Syntax

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

Parameters:

maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – A token to use for paginating results that are returned in the response.
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space to list threat models for.

Return type:

dict

Returns:

Response Syntax

{
    'threatModelSummaries': [
        {
            'threatModelId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListThreatModels operation.
- threatModelSummaries (list) –
  
  The list of threat model summaries.
  - (dict) –
    
    Contains summary information about a threat model.
    - threatModelId (string) –
      
      The unique identifier of the threat model.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space that contains the threat model.
    - title (string) –
      
      The title of the threat model.
    - createdAt (datetime) –
      
      The date and time the threat model was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the threat model was last updated, in UTC format.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response.