Skip to content

CodeReviewJob

Source code in docs_src/capo_securityagent/types/code_review_job.py
class CodeReviewJob(TypedDict, closed=True):
    code_review_job_id: NotRequired["str"]
    """<p>The unique identifier of the code review job.</p>"""
    code_review_id: NotRequired["str"]
    """<p>The unique identifier of the code review associated with the job.</p>"""
    title: NotRequired["str"]
    """<p>The title of the code review job.</p>"""
    overview: NotRequired["str"]
    """<p>An overview of the code review job results.</p>"""
    status: NotRequired["capo_securityagent.types.job_status.JobStatus"]
    """<p>The current status of the code review job.</p>"""
    documents: NotRequired["capo_securityagent.types.document_list.DocumentList"]
    """<p>The list of documents providing context for the code review job.</p>"""
    source_code: NotRequired[
        "capo_securityagent.types.source_code_repository_list.SourceCodeRepositoryList"
    ]
    """<p>The list of source code repositories analyzed during the code review job.</p>"""
    steps: NotRequired["capo_securityagent.types.step_list.StepList"]
    """<p>The list of steps in the code review job execution.</p>"""
    execution_context: NotRequired[
        "capo_securityagent.types.execution_context_list.ExecutionContextList"
    ]
    """<p>The execution context messages for the code review job.</p>"""
    service_role: NotRequired["capo_securityagent.types.service_role.ServiceRole"]
    """<p>The IAM service role used for the code review job.</p>"""
    log_config: NotRequired["capo_securityagent.types.cloud_watch_log.CloudWatchLog"]
    """<p>The CloudWatch Logs configuration for the code review job.</p>"""
    error_information: NotRequired[
        "capo_securityagent.types.error_information.ErrorInformation"
    ]
    """<p>Error information if the code review job encountered an error.</p>"""
    integrated_repositories: NotRequired[
        "capo_securityagent.types.integrated_repository_list.IntegratedRepositoryList"
    ]
    """<p>The list of integrated repositories associated with the code review job.</p>"""
    code_remediation_strategy: NotRequired[
        "capo_securityagent.types.code_remediation_strategy.CodeRemediationStrategy"
    ]
    """<p>The code remediation strategy for the code review job.</p>"""
    max_task_hours: NotRequired["float"]
    """<p>The maximum number of billable task hours allowed for this code review job. If the cumulative task hours reach this limit, the job is gracefully stopped.</p>"""
    report_destination: NotRequired[
        "capo_securityagent.types.report_destination.ReportDestination"
    ]
    """<p>The destination for publishing scan reports to an integrated document provider.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the code review job was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the code review job was last updated, in UTC format.</p>"""

code_remediation_strategy instance-attribute

code_remediation_strategy: NotRequired[CodeRemediationStrategy]

The code remediation strategy for the code review job.

code_review_id instance-attribute

code_review_id: NotRequired[str]

The unique identifier of the code review associated with the job.

code_review_job_id instance-attribute

code_review_job_id: NotRequired[str]

The unique identifier of the code review job.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time the code review job was created, in UTC format.

documents instance-attribute

documents: NotRequired[DocumentList]

The list of documents providing context for the code review job.

error_information instance-attribute

error_information: NotRequired[ErrorInformation]

Error information if the code review job encountered an error.

execution_context instance-attribute

execution_context: NotRequired[ExecutionContextList]

The execution context messages for the code review job.

integrated_repositories instance-attribute

integrated_repositories: NotRequired[IntegratedRepositoryList]

The list of integrated repositories associated with the code review job.

log_config instance-attribute

log_config: NotRequired[CloudWatchLog]

The CloudWatch Logs configuration for the code review job.

max_task_hours instance-attribute

max_task_hours: NotRequired[float]

The maximum number of billable task hours allowed for this code review job. If the cumulative task hours reach this limit, the job is gracefully stopped.

overview instance-attribute

overview: NotRequired[str]

An overview of the code review job results.

report_destination instance-attribute

report_destination: NotRequired[ReportDestination]

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

service_role instance-attribute

service_role: NotRequired[ServiceRole]

The IAM service role used for the code review job.

source_code instance-attribute

source_code: NotRequired[SourceCodeRepositoryList]

The list of source code repositories analyzed during the code review job.

status instance-attribute

status: NotRequired[JobStatus]

The current status of the code review job.

steps instance-attribute

steps: NotRequired[StepList]

The list of steps in the code review job execution.

title instance-attribute

title: NotRequired[str]

The title of the code review job.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time the code review job was last updated, in UTC format.