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().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• pentestId (string) –

  [REQUIRED]

  Identifier of the pentest for which to retrieve associated jobs

• agentSpaceId (string) –

  [REQUIRED]

  ID of the agent space where the pentest exists

• 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) –

    List of pentest job summaries associated with the pentest

    • (dict) –

      Summary information for a pentest job

      • pentestJobId (string) –

        Unique identifier of the pentest job

      • pentestId (string) –

        Identifier of the parent pentest

      • title (string) –

        Title or name of the pentest

      • status (string) –

        Current status of the pentest job

      • createdAt (datetime) –

        Timestamp when the pentest job was created

      • updatedAt (datetime) –

        Timestamp when the pentest job was last updated

  • NextToken (string) –

    A token to resume pagination.