SecurityAgent / Client / batch_get_threat_model_job_tasks

batch_get_threat_model_job_tasks¶

SecurityAgent.Client.batch_get_threat_model_job_tasks(**kwargs)¶

Retrieves information about one or more tasks within a threat model job.

Request Syntax

response = client.batch_get_threat_model_job_tasks(
    agentSpaceId='string',
    threatModelJobTaskIds=[
        'string',
    ]
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space that contains the tasks.
threatModelJobTaskIds (list) –
[REQUIRED]

The list of task identifiers to retrieve.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'threatModelJobTasks': [
        {
            'taskId': 'string',
            'threatModelId': 'string',
            'threatModelJobId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'description': 'string',
            'executionStatus': 'IN_PROGRESS'|'ABORTED'|'COMPLETED'|'INTERNAL_ERROR'|'FAILED',
            'logsLocation': {
                'logType': 'CLOUDWATCH',
                'cloudWatchLog': {
                    'logGroup': 'string',
                    'logStream': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

(dict) –

Output for the BatchGetThreatModelJobTasks operation.
- threatModelJobTasks (list) –
  
  The list of threat model job tasks that were found.
  - (dict) –
    
    Represents an individual task within a threat model job.
    - taskId (string) –
      
      The unique identifier of the task.
    - threatModelId (string) –
      
      The unique identifier of the threat model associated with the task.
    - threatModelJobId (string) –
      
      The unique identifier of the threat model job that contains the task.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space.
    - title (string) –
      
      The title of the task.
    - description (string) –
      
      A description of the task.
    - executionStatus (string) –
      
      The current execution status of the task.
    - logsLocation (dict) –
      
      The location of the task execution logs.
      - logType (string) –
        
        The type of log storage. Currently, only CLOUDWATCH is supported.
      - cloudWatchLog (dict) –
        
        The CloudWatch Logs location for the task logs.
        
        logGroup (string) –
        
        The name of the CloudWatch log group.
        
        logStream (string) –
        
        The name of the CloudWatch log stream.
    - createdAt (datetime) –
      
      The date and time the task was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the task was last updated, in UTC format.
- notFound (list) –
  
  The list of task identifiers that were not found.
  - (string) –