Skip to content

CreatePentestInput

Source code in docs_src/capo_securityagent/types/create_pentest_input.py
class CreatePentestInput(TypedDict, closed=True):
    title: "str"
    """<p>The title of the pentest.</p>"""
    agent_space_id: "str"
    """<p>The unique identifier of the agent space to create the pentest in.</p>"""
    assets: NotRequired["capo_securityagent.types.assets.Assets"]
    """<p>The assets to include in the pentest, such as endpoints, actors, documents, and source code.</p>"""
    exclude_risk_types: NotRequired[
        "capo_securityagent.types.risk_type_list.RiskTypeList"
    ]
    """<p>The list of risk types to exclude from the pentest.</p>"""
    service_role: NotRequired["capo_securityagent.types.service_role.ServiceRole"]
    """<p>The IAM service role to use for the pentest.</p>"""
    log_config: NotRequired["capo_securityagent.types.cloud_watch_log.CloudWatchLog"]
    """<p>The CloudWatch Logs configuration for the pentest.</p>"""
    vpc_config: NotRequired["capo_securityagent.types.vpc_config.VpcConfig"]
    """<p>The VPC configuration for the pentest.</p>"""
    network_traffic_config: NotRequired[
        "capo_securityagent.types.network_traffic_config.NetworkTrafficConfig"
    ]
    """<p>The network traffic configuration for the pentest, including custom headers and traffic rules.</p>"""
    code_remediation_strategy: NotRequired[
        "capo_securityagent.types.code_remediation_strategy.CodeRemediationStrategy"
    ]
    """<p>The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.</p>"""
    disable_managed_skills: NotRequired[
        "capo_securityagent.types.skill_type_list.SkillTypeList"
    ]
    """<p>A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.</p>"""
    max_task_hours: NotRequired["float"]
    """<p>The maximum number of billable task hours allowed for jobs started from this pentest. Must be a positive number. If not set, jobs run to completion with no budget cap.</p>"""
    report_destination: NotRequired[
        "capo_securityagent.types.report_destination.ReportDestination"
    ]
    """<p>The destination for publishing scan reports to an integrated document provider.</p>"""
    report_filters: NotRequired["capo_securityagent.types.report_filters.ReportFilters"]
    """<p>The report-generation filters applied when the report is exported.</p>"""
    cicd_configuration: NotRequired[
        "capo_securityagent.types.ci_cd_configuration.CiCdConfiguration"
    ]
    """<p>The CI/CD pentesting configuration to apply to the pentest.</p>"""
    test_scope: NotRequired["capo_securityagent.types.test_scope.TestScope"]

agent_space_id instance-attribute

agent_space_id: str

The unique identifier of the agent space to create the pentest in.

assets instance-attribute

assets: NotRequired[Assets]

The assets to include in the pentest, such as endpoints, actors, documents, and source code.

cicd_configuration instance-attribute

cicd_configuration: NotRequired[CiCdConfiguration]

The CI/CD pentesting configuration to apply to the pentest.

code_remediation_strategy instance-attribute

code_remediation_strategy: NotRequired[CodeRemediationStrategy]

The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

disable_managed_skills instance-attribute

disable_managed_skills: NotRequired[SkillTypeList]

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

exclude_risk_types instance-attribute

exclude_risk_types: NotRequired[RiskTypeList]

The list of risk types to exclude from the pentest.

log_config instance-attribute

log_config: NotRequired[CloudWatchLog]

The CloudWatch Logs configuration for the pentest.

max_task_hours instance-attribute

max_task_hours: NotRequired[float]

The maximum number of billable task hours allowed for jobs started from this pentest. Must be a positive number. If not set, jobs run to completion with no budget cap.

network_traffic_config instance-attribute

network_traffic_config: NotRequired[NetworkTrafficConfig]

The network traffic configuration for the pentest, including custom headers and traffic rules.

report_destination instance-attribute

report_destination: NotRequired[ReportDestination]

The destination for publishing scan reports to an integrated document provider.

report_filters instance-attribute

report_filters: NotRequired[ReportFilters]

The report-generation filters applied when the report is exported.

service_role instance-attribute

service_role: NotRequired[ServiceRole]

The IAM service role to use for the pentest.

test_scope instance-attribute

test_scope: NotRequired[TestScope]

title instance-attribute

title: str

The title of the pentest.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfig]

The VPC configuration for the pentest.