SecurityAgent / Paginator / ListThreatModelJobs

ListThreatModelJobs¶

class SecurityAgent.Paginator.ListThreatModelJobs¶

paginator = client.get_paginator('list_threat_model_jobs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_threat_model_jobs().

Request Syntax

response_iterator = paginator.paginate(
    threatModelId='string',
    agentSpaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

threatModelId (string) –
[REQUIRED]

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

The unique identifier of the agent space.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous 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 resume pagination.