SecurityAgent / Client / start_pentest_job

start_pentest_job

SecurityAgent.Client.start_pentest_job(**kwargs)

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

See also: AWS API Documentation

Request Syntax

response = client.start_pentest_job(
    agentSpaceId='string',
    pentestId='string'
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space.

• pentestId (string) –

  [REQUIRED]

  The unique identifier of the pentest to start a job for.

Return type:

dict

Returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'pentestId': 'string',
    'pentestJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

• (dict) –

  Output for the StartPentestJob operation.

  • 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.

  • pentestId (string) –

    The unique identifier of the pentest.

  • pentestJobId (string) –

    The unique identifier of the started pentest job.

  • agentSpaceId (string) –

    The unique identifier of the agent space.