/AWS1/CL_SAGPENTESTJOB¶
Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_pentestjobid TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING¶
The unique identifier of the pentest job.
iv_pentestid TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING¶
The unique identifier of the pentest associated with the job.
iv_title TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING¶
The title of the pentest job.
iv_overview TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING¶
An overview of the pentest job results.
iv_status TYPE /AWS1/SAGJOBSTATUS /AWS1/SAGJOBSTATUS¶
The current status of the pentest job.
it_endpoints TYPE /AWS1/CL_SAGENDPOINT=>TT_ENDPOINTLIST TT_ENDPOINTLIST¶
The list of endpoints being tested in the pentest job.
it_actors TYPE /AWS1/CL_SAGACTOR=>TT_ACTORLIST TT_ACTORLIST¶
The list of actors used during the pentest job.
it_documents TYPE /AWS1/CL_SAGDOCUMENTINFO=>TT_DOCUMENTLIST TT_DOCUMENTLIST¶
The list of documents providing context for the pentest job.
it_sourcecode TYPE /AWS1/CL_SAGSOURCECODEREPO=>TT_SOURCECODEREPOSITORYLIST TT_SOURCECODEREPOSITORYLIST¶
The list of source code repositories analyzed during the pentest job.
it_excludepaths TYPE /AWS1/CL_SAGENDPOINT=>TT_ENDPOINTLIST TT_ENDPOINTLIST¶
The list of paths excluded from the pentest job.
it_alloweddomains TYPE /AWS1/CL_SAGENDPOINT=>TT_ENDPOINTLIST TT_ENDPOINTLIST¶
The list of domains allowed during the pentest job.
it_excluderisktypes TYPE /AWS1/CL_SAGRISKTYPELIST_W=>TT_RISKTYPELIST TT_RISKTYPELIST¶
The list of risk types excluded from the pentest job.
it_steps TYPE /AWS1/CL_SAGSTEP=>TT_STEPLIST TT_STEPLIST¶
The list of steps in the pentest job execution.
it_executioncontext TYPE /AWS1/CL_SAGEXECUTIONCONTEXT=>TT_EXECUTIONCONTEXTLIST TT_EXECUTIONCONTEXTLIST¶
The execution context messages for the pentest job.
iv_servicerole TYPE /AWS1/SAGSERVICEROLE /AWS1/SAGSERVICEROLE¶
The IAM service role used for the pentest job.
io_logconfig TYPE REF TO /AWS1/CL_SAGCLOUDWATCHLOG /AWS1/CL_SAGCLOUDWATCHLOG¶
The CloudWatch Logs configuration for the pentest job.
io_vpcconfig TYPE REF TO /AWS1/CL_SAGVPCCONFIG /AWS1/CL_SAGVPCCONFIG¶
The VPC configuration for the pentest job.
io_networktrafficconfig TYPE REF TO /AWS1/CL_SAGNETWORKTRAFCONFIG /AWS1/CL_SAGNETWORKTRAFCONFIG¶
The network traffic configuration for the pentest job.
io_errorinformation TYPE REF TO /AWS1/CL_SAGERRORINFORMATION /AWS1/CL_SAGERRORINFORMATION¶
Error information if the pentest job encountered an error.
it_integratedrepositories TYPE /AWS1/CL_SAGINTGRTDREPOSITORY=>TT_INTEGRATEDREPOSITORYLIST TT_INTEGRATEDREPOSITORYLIST¶
The list of integrated repositories associated with the pentest job.
iv_coderemediationstrategy TYPE /AWS1/SAGCODEREMEDSTRATEGY /AWS1/SAGCODEREMEDSTRATEGY¶
The code remediation strategy for the pentest job.
iv_cleanupstrategy TYPE /AWS1/SAGCLEANUPSTRATEGY /AWS1/SAGCLEANUPSTRATEGY¶
Strategy for cleaning up resources after pentest job completion.
it_disablemanagedskills TYPE /AWS1/CL_SAGSKILLTYPELIST_W=>TT_SKILLTYPELIST TT_SKILLTYPELIST¶
A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
iv_maxtaskhours TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped.
iv_jobtype TYPE /AWS1/SAGJOBTYPE /AWS1/SAGJOBTYPE¶
The type of the pentest job. Valid values are FULL and REVALIDATION.
it_selectedfindingids TYPE /AWS1/CL_SAGSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.
iv_createdat TYPE /AWS1/SAGTIMESTAMP /AWS1/SAGTIMESTAMP¶
The date and time the pentest job was created, in UTC format.
iv_updatedat TYPE /AWS1/SAGTIMESTAMP /AWS1/SAGTIMESTAMP¶
The date and time the pentest job was last updated, in UTC format.
Queryable Attributes¶
pentestJobId¶
The unique identifier of the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PENTESTJOBID() |
Getter for PENTESTJOBID, with configurable default |
ASK_PENTESTJOBID() |
Getter for PENTESTJOBID w/ exceptions if field has no value |
HAS_PENTESTJOBID() |
Determine if PENTESTJOBID has a value |
pentestId¶
The unique identifier of the pentest associated with the job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PENTESTID() |
Getter for PENTESTID, with configurable default |
ASK_PENTESTID() |
Getter for PENTESTID w/ exceptions if field has no value |
HAS_PENTESTID() |
Determine if PENTESTID has a value |
title¶
The title of the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
overview¶
An overview of the pentest job results.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OVERVIEW() |
Getter for OVERVIEW, with configurable default |
ASK_OVERVIEW() |
Getter for OVERVIEW w/ exceptions if field has no value |
HAS_OVERVIEW() |
Determine if OVERVIEW has a value |
status¶
The current status of the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
endpoints¶
The list of endpoints being tested in the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINTS() |
Getter for ENDPOINTS, with configurable default |
ASK_ENDPOINTS() |
Getter for ENDPOINTS w/ exceptions if field has no value |
HAS_ENDPOINTS() |
Determine if ENDPOINTS has a value |
actors¶
The list of actors used during the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTORS() |
Getter for ACTORS, with configurable default |
ASK_ACTORS() |
Getter for ACTORS w/ exceptions if field has no value |
HAS_ACTORS() |
Determine if ACTORS has a value |
documents¶
The list of documents providing context for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTS() |
Getter for DOCUMENTS, with configurable default |
ASK_DOCUMENTS() |
Getter for DOCUMENTS w/ exceptions if field has no value |
HAS_DOCUMENTS() |
Determine if DOCUMENTS has a value |
sourceCode¶
The list of source code repositories analyzed during the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCECODE() |
Getter for SOURCECODE, with configurable default |
ASK_SOURCECODE() |
Getter for SOURCECODE w/ exceptions if field has no value |
HAS_SOURCECODE() |
Determine if SOURCECODE has a value |
excludePaths¶
The list of paths excluded from the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXCLUDEPATHS() |
Getter for EXCLUDEPATHS, with configurable default |
ASK_EXCLUDEPATHS() |
Getter for EXCLUDEPATHS w/ exceptions if field has no value |
HAS_EXCLUDEPATHS() |
Determine if EXCLUDEPATHS has a value |
allowedDomains¶
The list of domains allowed during the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALLOWEDDOMAINS() |
Getter for ALLOWEDDOMAINS, with configurable default |
ASK_ALLOWEDDOMAINS() |
Getter for ALLOWEDDOMAINS w/ exceptions if field has no valu |
HAS_ALLOWEDDOMAINS() |
Determine if ALLOWEDDOMAINS has a value |
excludeRiskTypes¶
The list of risk types excluded from the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXCLUDERISKTYPES() |
Getter for EXCLUDERISKTYPES, with configurable default |
ASK_EXCLUDERISKTYPES() |
Getter for EXCLUDERISKTYPES w/ exceptions if field has no va |
HAS_EXCLUDERISKTYPES() |
Determine if EXCLUDERISKTYPES has a value |
steps¶
The list of steps in the pentest job execution.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STEPS() |
Getter for STEPS, with configurable default |
ASK_STEPS() |
Getter for STEPS w/ exceptions if field has no value |
HAS_STEPS() |
Determine if STEPS has a value |
executionContext¶
The execution context messages for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONCONTEXT() |
Getter for EXECUTIONCONTEXT, with configurable default |
ASK_EXECUTIONCONTEXT() |
Getter for EXECUTIONCONTEXT w/ exceptions if field has no va |
HAS_EXECUTIONCONTEXT() |
Determine if EXECUTIONCONTEXT has a value |
serviceRole¶
The IAM service role used for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEROLE() |
Getter for SERVICEROLE, with configurable default |
ASK_SERVICEROLE() |
Getter for SERVICEROLE w/ exceptions if field has no value |
HAS_SERVICEROLE() |
Determine if SERVICEROLE has a value |
logConfig¶
The CloudWatch Logs configuration for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGCONFIG() |
Getter for LOGCONFIG |
vpcConfig¶
The VPC configuration for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCCONFIG() |
Getter for VPCCONFIG |
networkTrafficConfig¶
The network traffic configuration for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKTRAFFICCONFIG() |
Getter for NETWORKTRAFFICCONFIG |
errorInformation¶
Error information if the pentest job encountered an error.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERRORINFORMATION() |
Getter for ERRORINFORMATION |
integratedRepositories¶
The list of integrated repositories associated with the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INTEGRATEDREPOSITORIES() |
Getter for INTEGRATEDREPOSITORIES, with configurable default |
ASK_INTEGRATEDREPOSITORIES() |
Getter for INTEGRATEDREPOSITORIES w/ exceptions if field has |
HAS_INTEGRATEDREPOSITORIES() |
Determine if INTEGRATEDREPOSITORIES has a value |
codeRemediationStrategy¶
The code remediation strategy for the pentest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODEREMEDIATIONSTRATEGY() |
Getter for CODEREMEDIATIONSTRATEGY, with configurable defaul |
ASK_CODEREMEDIATIONSTRATEGY() |
Getter for CODEREMEDIATIONSTRATEGY w/ exceptions if field ha |
HAS_CODEREMEDIATIONSTRATEGY() |
Determine if CODEREMEDIATIONSTRATEGY has a value |
cleanUpStrategy¶
Strategy for cleaning up resources after pentest job completion.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLEANUPSTRATEGY() |
Getter for CLEANUPSTRATEGY, with configurable default |
ASK_CLEANUPSTRATEGY() |
Getter for CLEANUPSTRATEGY w/ exceptions if field has no val |
HAS_CLEANUPSTRATEGY() |
Determine if CLEANUPSTRATEGY has a value |
disableManagedSkills¶
A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISABLEMANAGEDSKILLS() |
Getter for DISABLEMANAGEDSKILLS, with configurable default |
ASK_DISABLEMANAGEDSKILLS() |
Getter for DISABLEMANAGEDSKILLS w/ exceptions if field has n |
HAS_DISABLEMANAGEDSKILLS() |
Determine if DISABLEMANAGEDSKILLS has a value |
maxTaskHours¶
The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXTASKHOURS() |
Getter for MAXTASKHOURS, with configurable default |
ASK_MAXTASKHOURS() |
Getter for MAXTASKHOURS w/ exceptions if field has no value |
STR_MAXTASKHOURS() |
String format for MAXTASKHOURS, with configurable default |
HAS_MAXTASKHOURS() |
Determine if MAXTASKHOURS has a value |
jobType¶
The type of the pentest job. Valid values are FULL and REVALIDATION.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBTYPE() |
Getter for JOBTYPE, with configurable default |
ASK_JOBTYPE() |
Getter for JOBTYPE w/ exceptions if field has no value |
HAS_JOBTYPE() |
Determine if JOBTYPE has a value |
selectedFindingIds¶
The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELECTEDFINDINGIDS() |
Getter for SELECTEDFINDINGIDS, with configurable default |
ASK_SELECTEDFINDINGIDS() |
Getter for SELECTEDFINDINGIDS w/ exceptions if field has no |
HAS_SELECTEDFINDINGIDS() |
Determine if SELECTEDFINDINGIDS has a value |
createdAt¶
The date and time the pentest job was created, in UTC format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The date and time the pentest job was last updated, in UTC format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_PENTESTJOBLIST¶
TYPES TT_PENTESTJOBLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SAGPENTESTJOB WITH DEFAULT KEY
.