SecurityAgent / Client / list_threats

list_threats¶

SecurityAgent.Client.list_threats(**kwargs)¶

Returns a paginated list of threats for a threat model job.

Request Syntax

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

Parameters:

threatJobId (string) –
[REQUIRED]

The unique identifier of the threat model job to list threats 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.
maxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'threats': [
        {
            'threatId': 'string',
            'threatJobId': 'string',
            'title': 'string',
            'statement': 'string',
            'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFO',
            'status': 'OPEN'|'RESOLVED'|'DISMISSED',
            'stride': [
                'SPOOFING'|'TAMPERING'|'REPUDIATION'|'INFORMATION_DISCLOSURE'|'DENIAL_OF_SERVICE'|'ELEVATION_OF_PRIVILEGE',
            ],
            'createdBy': 'CUSTOMER'|'AGENT',
            'updatedBy': 'CUSTOMER'|'AGENT',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListThreats operation.
- threats (list) –
  
  The list of threat summaries.
  - (dict) –
    
    Contains summary information about a threat.
    - threatId (string) –
      
      The unique identifier of the threat.
    - threatJobId (string) –
      
      The unique identifier of the threat model job that produced the threat.
    - title (string) –
      
      A short title summarizing the threat.
    - statement (string) –
      
      The natural-language threat statement.
    - severity (string) –
      
      The severity level of the threat.
    - status (string) –
      
      The current status of the threat.
    - stride (list) –
      
      The STRIDE categories applicable to this threat.
      - (string) –
        
        STRIDE threat classification category.
    - createdBy (string) –
      
      Who created this threat.
    - updatedBy (string) –
      
      Who last updated this threat.
    - createdAt (datetime) –
      
      The date and time the threat was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the threat was last updated, in UTC format.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response.