SecurityAgent / Client / start_pentest_job

start_pentest_job

SecurityAgent.Client.start_pentest_job(**kwargs)

Initiates the execution of a pentest

See also: AWS API Documentation

Request Syntax

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

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  ID of the agent space where the pentest exists

• pentestId (string) –

  [REQUIRED]

  Identifier of the pentest to execute

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

    Title of the pentest job

  • 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

  • pentestId (string) –

    Unique identifier of the pentest

  • pentestJobId (string) –

    Unique identifier of the pentest job

  • agentSpaceId (string) –

    ID of the agent space where the pentest exists