PentestJob ¶

class PentestJob(TypedDict, closed=True):
    pentest_job_id: NotRequired["str"]
    """<p>The unique identifier of the pentest job.</p>"""
    pentest_id: NotRequired["str"]
    """<p>The unique identifier of the pentest associated with the job.</p>"""
    title: NotRequired["str"]
    """<p>The title of the pentest job.</p>"""
    overview: NotRequired["str"]
    """<p>An overview of the pentest job results.</p>"""
    status: NotRequired["capo_securityagent.types.job_status.JobStatus"]
    """<p>The current status of the pentest job.</p>"""
    endpoints: NotRequired["capo_securityagent.types.endpoint_list.EndpointList"]
    """<p>The list of endpoints being tested in the pentest job.</p>"""
    actors: NotRequired["capo_securityagent.types.actor_list.ActorList"]
    """<p>The list of actors used during the pentest job.</p>"""
    documents: NotRequired["capo_securityagent.types.document_list.DocumentList"]
    """<p>The list of documents providing context for the pentest job.</p>"""
    source_code: NotRequired[
        "capo_securityagent.types.source_code_repository_list.SourceCodeRepositoryList"
    ]
    """<p>The list of source code repositories analyzed during the pentest job.</p>"""
    exclude_paths: NotRequired["capo_securityagent.types.endpoint_list.EndpointList"]
    """<p>The list of paths excluded from the pentest job.</p>"""
    allowed_domains: NotRequired["capo_securityagent.types.endpoint_list.EndpointList"]
    """<p>The list of domains allowed during the pentest job.</p>"""
    exclude_risk_types: NotRequired[
        "capo_securityagent.types.risk_type_list.RiskTypeList"
    ]
    """<p>The list of risk types excluded from the pentest job.</p>"""
    steps: NotRequired["capo_securityagent.types.step_list.StepList"]
    """<p>The list of steps in the pentest job execution.</p>"""
    execution_context: NotRequired[
        "capo_securityagent.types.execution_context_list.ExecutionContextList"
    ]
    """<p>The execution context messages for the pentest job.</p>"""
    service_role: NotRequired["capo_securityagent.types.service_role.ServiceRole"]
    """<p>The IAM service role used for the pentest job.</p>"""
    log_config: NotRequired["capo_securityagent.types.cloud_watch_log.CloudWatchLog"]
    """<p>The CloudWatch Logs configuration for the pentest job.</p>"""
    vpc_config: NotRequired["capo_securityagent.types.vpc_config.VpcConfig"]
    """<p>The VPC configuration for the pentest job.</p>"""
    network_traffic_config: NotRequired[
        "capo_securityagent.types.network_traffic_config.NetworkTrafficConfig"
    ]
    """<p>The network traffic configuration for the pentest job.</p>"""
    error_information: NotRequired[
        "capo_securityagent.types.error_information.ErrorInformation"
    ]
    """<p>Error information if the pentest job encountered an error.</p>"""
    integrated_repositories: NotRequired[
        "capo_securityagent.types.integrated_repository_list.IntegratedRepositoryList"
    ]
    """<p>The list of integrated repositories associated with the pentest job.</p>"""
    trusted_ca_certificates: NotRequired[
        "capo_securityagent.types.trusted_ca_certificate_list.TrustedCaCertificateList"
    ]
    """<p>The trust anchors used to validate target endpoint TLS certificates during the pentest job.</p>"""
    code_remediation_strategy: NotRequired[
        "capo_securityagent.types.code_remediation_strategy.CodeRemediationStrategy"
    ]
    """<p>The code remediation strategy for the pentest job.</p>"""
    clean_up_strategy: NotRequired[
        "capo_securityagent.types.clean_up_strategy.CleanUpStrategy"
    ]
    """<p>Strategy for cleaning up resources after pentest job completion.</p>"""
    disable_managed_skills: NotRequired[
        "capo_securityagent.types.skill_type_list.SkillTypeList"
    ]
    """<p>A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.</p>"""
    max_task_hours: NotRequired["float"]
    """<p>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.</p>"""
    job_type: NotRequired["capo_securityagent.types.job_type.JobType"]
    """<p>The type of the pentest job. Valid values are FULL, REVALIDATION, and CICD.</p>"""
    selected_finding_ids: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.</p>"""
    report_destination: NotRequired[
        "capo_securityagent.types.report_destination.ReportDestination"
    ]
    """<p>The destination for publishing scan reports to an integrated document provider.</p>"""
    report_url: NotRequired["str"]
    """<p>The URL to view this pentest job's findings report in the console.</p>"""
    scope_result: NotRequired["capo_securityagent.types.scope_result.ScopeResult"]
    """<p>The scoping outcome for this CI/CD pentest job. Present only for jobs of type CICD.</p>"""
    scope_changes: NotRequired[
        "capo_securityagent.types.scope_change_list.ScopeChangeList"
    ]
    """<p>The code changes that defined the scope of this CI/CD pentest job. Present only for jobs of type CICD.</p>"""
    cicd_configuration: NotRequired[
        "capo_securityagent.types.ci_cd_configuration.CiCdConfiguration"
    ]
    test_scope: NotRequired["capo_securityagent.types.test_scope.TestScope"]
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the pentest job was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the pentest job was last updated, in UTC format.</p>"""