SecurityAgent / Paginator / ListPentestJobsForPentest

ListPentestJobsForPentest¶

class SecurityAgent.Paginator.ListPentestJobsForPentest¶

paginator = client.get_paginator('list_pentest_jobs_for_pentest')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

pentestId (string) –
[REQUIRED]

The unique identifier of the pentest 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

{
    'pentestJobSummaries': [
        {
            'pentestJobId': 'string',
            'pentestId': '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 ListPentestJobsForPentest operation.
- pentestJobSummaries (list) –
  
  The list of pentest job summaries.
  - (dict) –
    
    Contains summary information about a pentest job.
    - pentestJobId (string) –
      
      The unique identifier of the pentest job.
    - pentestId (string) –
      
      The unique identifier of the pentest associated with the job.
    - title (string) –
      
      The title of the pentest job.
    - status (string) –
      
      The current status of the pentest job.
    - createdAt (datetime) –
      
      The date and time the pentest job was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the pentest job was last updated, in UTC format.
- NextToken (string) –
  
  A token to resume pagination.