

# PentestJob
<a name="API_PentestJob"></a>

Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.

## Contents
<a name="API_PentestJob_Contents"></a>

 ** actors **   <a name="securityagent-Type-PentestJob-actors"></a>
The list of actors used during the pentest job.  
Type: Array of [Actor](API_Actor.md) objects  
Required: No

 ** allowedDomains **   <a name="securityagent-Type-PentestJob-allowedDomains"></a>
The list of domains allowed during the pentest job.  
Type: Array of [Endpoint](API_Endpoint.md) objects  
Required: No

 ** codeRemediationStrategy **   <a name="securityagent-Type-PentestJob-codeRemediationStrategy"></a>
The code remediation strategy for the pentest job.  
Type: String  
Valid Values: `AUTOMATIC | DISABLED`   
Required: No

 ** createdAt **   <a name="securityagent-Type-PentestJob-createdAt"></a>
The date and time the pentest job was created, in UTC format.  
Type: Timestamp  
Required: No

 ** documents **   <a name="securityagent-Type-PentestJob-documents"></a>
The list of documents providing context for the pentest job.  
Type: Array of [DocumentInfo](API_DocumentInfo.md) objects  
Required: No

 ** endpoints **   <a name="securityagent-Type-PentestJob-endpoints"></a>
The list of endpoints being tested in the pentest job.  
Type: Array of [Endpoint](API_Endpoint.md) objects  
Required: No

 ** errorInformation **   <a name="securityagent-Type-PentestJob-errorInformation"></a>
Error information if the pentest job encountered an error.  
Type: [ErrorInformation](API_ErrorInformation.md) object  
Required: No

 ** excludePaths **   <a name="securityagent-Type-PentestJob-excludePaths"></a>
The list of paths excluded from the pentest job.  
Type: Array of [Endpoint](API_Endpoint.md) objects  
Required: No

 ** excludeRiskTypes **   <a name="securityagent-Type-PentestJob-excludeRiskTypes"></a>
The list of risk types excluded from the pentest job.  
Type: Array of strings  
Valid Values: `CROSS_SITE_SCRIPTING | DEFAULT_CREDENTIALS | INSECURE_DIRECT_OBJECT_REFERENCE | PRIVILEGE_ESCALATION | SERVER_SIDE_TEMPLATE_INJECTION | COMMAND_INJECTION | CODE_INJECTION | SQL_INJECTION | ARBITRARY_FILE_UPLOAD | INSECURE_DESERIALIZATION | LOCAL_FILE_INCLUSION | INFORMATION_DISCLOSURE | PATH_TRAVERSAL | SERVER_SIDE_REQUEST_FORGERY | JSON_WEB_TOKEN_VULNERABILITIES | XML_EXTERNAL_ENTITY | FILE_DELETION | OTHER | GRAPHQL_VULNERABILITIES | BUSINESS_LOGIC_VULNERABILITIES | CRYPTOGRAPHIC_VULNERABILITIES | DENIAL_OF_SERVICE | FILE_ACCESS | FILE_CREATION | DATABASE_MODIFICATION | DATABASE_ACCESS | OUTBOUND_SERVICE_REQUEST | UNKNOWN`   
Required: No

 ** executionContext **   <a name="securityagent-Type-PentestJob-executionContext"></a>
The execution context messages for the pentest job.  
Type: Array of [ExecutionContext](API_ExecutionContext.md) objects  
Required: No

 ** integratedRepositories **   <a name="securityagent-Type-PentestJob-integratedRepositories"></a>
The list of integrated repositories associated with the pentest job.  
Type: Array of [IntegratedRepository](API_IntegratedRepository.md) objects  
Required: No

 ** logConfig **   <a name="securityagent-Type-PentestJob-logConfig"></a>
The CloudWatch Logs configuration for the pentest job.  
Type: [CloudWatchLog](API_CloudWatchLog.md) object  
Required: No

 ** networkTrafficConfig **   <a name="securityagent-Type-PentestJob-networkTrafficConfig"></a>
The network traffic configuration for the pentest job.  
Type: [NetworkTrafficConfig](API_NetworkTrafficConfig.md) object  
Required: No

 ** overview **   <a name="securityagent-Type-PentestJob-overview"></a>
An overview of the pentest job results.  
Type: String  
Required: No

 ** pentestId **   <a name="securityagent-Type-PentestJob-pentestId"></a>
The unique identifier of the pentest associated with the job.  
Type: String  
Required: No

 ** pentestJobId **   <a name="securityagent-Type-PentestJob-pentestJobId"></a>
The unique identifier of the pentest job.  
Type: String  
Required: No

 ** serviceRole **   <a name="securityagent-Type-PentestJob-serviceRole"></a>
The IAM service role used for the pentest job.  
Type: String  
Required: No

 ** sourceCode **   <a name="securityagent-Type-PentestJob-sourceCode"></a>
The list of source code repositories analyzed during the pentest job.  
Type: Array of [SourceCodeRepository](API_SourceCodeRepository.md) objects  
Required: No

 ** status **   <a name="securityagent-Type-PentestJob-status"></a>
The current status of the pentest job.  
Type: String  
Valid Values: `IN_PROGRESS | STOPPING | STOPPED | FAILED | COMPLETED`   
Required: No

 ** steps **   <a name="securityagent-Type-PentestJob-steps"></a>
The list of steps in the pentest job execution.  
Type: Array of [Step](API_Step.md) objects  
Required: No

 ** title **   <a name="securityagent-Type-PentestJob-title"></a>
The title of the pentest job.  
Type: String  
Required: No

 ** updatedAt **   <a name="securityagent-Type-PentestJob-updatedAt"></a>
The date and time the pentest job was last updated, in UTC format.  
Type: Timestamp  
Required: No

 ** vpcConfig **   <a name="securityagent-Type-PentestJob-vpcConfig"></a>
The VPC configuration for the pentest job.  
Type: [VpcConfig](API_VpcConfig.md) object  
Required: No

## See Also
<a name="API_PentestJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityagent-2025-09-06/PentestJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityagent-2025-09-06/PentestJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityagent-2025-09-06/PentestJob) 