SecurityAgent / Paginator / ListPentests

ListPentests

class SecurityAgent.Paginator.ListPentests

paginator = client.get_paginator('list_pentests')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space to list pentests for.

• 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

{
    'pentestSummaries': [
        {
            'pentestId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Output for the ListPentests operation.

  • pentestSummaries (list) –

    The list of pentest summaries.

    • (dict) –

      Contains summary information about a pentest.

      • pentestId (string) –

        The unique identifier of the pentest.

      • agentSpaceId (string) –

        The unique identifier of the agent space that contains the pentest.

      • title (string) –

        The title of the pentest.

      • createdAt (datetime) –

        The date and time the pentest was created, in UTC format.

      • updatedAt (datetime) –

        The date and time the pentest was last updated, in UTC format.

  • NextToken (string) –

    A token to resume pagination.