SecurityAgent / Client / list_pentest_jobs_for_pentest

list_pentest_jobs_for_pentest

SecurityAgent.Client.list_pentest_jobs_for_pentest(**kwargs)

Returns a paginated list of pentest job summaries for the specified pentest configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_pentest_jobs_for_pentest(
    maxResults=123,
    pentestId='string',
    agentSpaceId='string',
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return in a single call.

  • pentestId (string) –

    [REQUIRED]

    The unique identifier of the pentest to list jobs for.

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the agent space.

  • nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

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 use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.