Skip to content

AssociateRepositoryRequest

Source code in docs_src/capo_codeguru_reviewer/types/associate_repository_request.py
class AssociateRepositoryRequest(TypedDict, closed=True):
    repository: "capo_codeguru_reviewer.types.repository.Repository"
    """<p>The repository to associate.</p>"""
    client_request_token: NotRequired[
        "capo_codeguru_reviewer.types.client_request_token.ClientRequestToken"
    ]
    """<p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.</p>"""
    tags: NotRequired["capo_codeguru_reviewer.types.tag_map.TagMap"]
    """<p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A <i>tag key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag keys are case sensitive.</p> </li> <li> <p>An optional field known as a <i>tag value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.</p> </li> </ul>"""
    kms_key_details: NotRequired[
        "capo_codeguru_reviewer.types.kms_key_details.KMSKeyDetails"
    ]
    """<p>A <code>KMSKeyDetails</code> object that contains:</p> <ul> <li> <p>The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).</p> </li> <li> <p>The ID of the Amazon Web Services KMS key that is associated with this repository association.</p> </li> </ul>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.

kms_key_details instance-attribute

kms_key_details: NotRequired[KMSKeyDetails]

A KMSKeyDetails object that contains:

  • The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).

  • The ID of the Amazon Web Services KMS key that is associated with this repository association.

repository instance-attribute

repository: Repository

The repository to associate.

tags instance-attribute

tags: NotRequired[TagMap]

An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:

  • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive.

  • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.