Skip to content

CodeReviewSummary

Source code in docs_src/capo_codeguru_reviewer/types/code_review_summary.py
class CodeReviewSummary(TypedDict, closed=True):
    name: NotRequired["capo_codeguru_reviewer.types.name.Name"]
    """<p>The name of the code review.</p>"""
    code_review_arn: NotRequired["capo_codeguru_reviewer.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object. </p>"""
    repository_name: NotRequired["capo_codeguru_reviewer.types.name.Name"]
    """<p>The name of the repository.</p>"""
    owner: NotRequired["capo_codeguru_reviewer.types.owner.Owner"]
    """<p>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.</p>"""
    provider_type: NotRequired[
        "capo_codeguru_reviewer.types.provider_type.ProviderType"
    ]
    """<p>The provider type of the repository association.</p>"""
    state: NotRequired["capo_codeguru_reviewer.types.job_state.JobState"]
    """<p>The state of the code review.</p> <p>The valid code review states are:</p> <ul> <li> <p> <code>Completed</code>: The code review is complete.</p> </li> <li> <p> <code>Pending</code>: The code review started and has not completed or failed.</p> </li> <li> <p> <code>Failed</code>: The code review failed.</p> </li> <li> <p> <code>Deleting</code>: The code review is being deleted.</p> </li> </ul>"""
    created_time_stamp: NotRequired["capo_codeguru_reviewer.types.time_stamp.TimeStamp"]
    """<p>The time, in milliseconds since the epoch, when the code review was created.</p>"""
    last_updated_time_stamp: NotRequired[
        "capo_codeguru_reviewer.types.time_stamp.TimeStamp"
    ]
    """<p>The time, in milliseconds since the epoch, when the code review was last updated.</p>"""
    type: NotRequired["capo_codeguru_reviewer.types.type.Type"]
    """<p>The type of the code review.</p>"""
    pull_request_id: NotRequired[
        "capo_codeguru_reviewer.types.pull_request_id.PullRequestId"
    ]
    """<p>The pull request ID for the code review.</p>"""
    metrics_summary: NotRequired[
        "capo_codeguru_reviewer.types.metrics_summary.MetricsSummary"
    ]
    """<p>The statistics from the code review.</p>"""
    source_code_type: NotRequired[
        "capo_codeguru_reviewer.types.source_code_type.SourceCodeType"
    ]

code_review_arn instance-attribute

code_review_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the CodeReview object.

created_time_stamp instance-attribute

created_time_stamp: NotRequired[TimeStamp]

The time, in milliseconds since the epoch, when the code review was created.

last_updated_time_stamp instance-attribute

last_updated_time_stamp: NotRequired[TimeStamp]

The time, in milliseconds since the epoch, when the code review was last updated.

metrics_summary instance-attribute

metrics_summary: NotRequired[MetricsSummary]

The statistics from the code review.

name instance-attribute

name: NotRequired[Name]

The name of the code review.

owner instance-attribute

owner: NotRequired[Owner]

The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

provider_type instance-attribute

provider_type: NotRequired[ProviderType]

The provider type of the repository association.

pull_request_id instance-attribute

pull_request_id: NotRequired[PullRequestId]

The pull request ID for the code review.

repository_name instance-attribute

repository_name: NotRequired[Name]

The name of the repository.

source_code_type instance-attribute

source_code_type: NotRequired[SourceCodeType]

state instance-attribute

state: NotRequired[JobState]

The state of the code review.

The valid code review states are:

  • Completed: The code review is complete.

  • Pending: The code review started and has not completed or failed.

  • Failed: The code review failed.

  • Deleting: The code review is being deleted.

type instance-attribute

type: NotRequired[Type]

The type of the code review.