Skip to content

RequestMetadata

Source code in docs_src/capo_codeguru_reviewer/types/request_metadata.py 
14
15
16
17
18
19
20
21
22
class RequestMetadata(TypedDict, closed=True):
    request_id: NotRequired["capo_codeguru_reviewer.types.request_id.RequestId"]
    """<p>The ID of the request. This is required for a pull request code review.</p>"""
    requester: NotRequired["capo_codeguru_reviewer.types.requester.Requester"]
    """<p>An identifier, such as a name or account ID, that is associated with the requester. The <code>Requester</code> is used to capture the <code>author/actor</code> name of the event request.</p>"""
    event_info: NotRequired["capo_codeguru_reviewer.types.event_info.EventInfo"]
    """<p>Information about the event associated with a code review.</p>"""
    vendor_name: NotRequired["capo_codeguru_reviewer.types.vendor_name.VendorName"]
    """<p>The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's <code>ProviderType</code> is <code>S3Bucket</code> and the CI/CD repository vendor name is GitHub. For more information, see the definition for <code>ProviderType</code> in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a>.</p>"""

event_info instance-attribute 

event_info: NotRequired[EventInfo]

Information about the event associated with a code review.

request_id instance-attribute 

request_id: NotRequired[RequestId]

The ID of the request. This is required for a pull request code review.

requester instance-attribute 

requester: NotRequired[Requester]

An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

vendor_name instance-attribute 

vendor_name: NotRequired[VendorName]

The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.