Associate Repository

codegurureviewer_associate_repository

R Documentation

Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer

Description

Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.

If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.

Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide.

You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.

Usage

codegurureviewer_associate_repository(Repository, ClientRequestToken,
  Tags, KMSKeyDetails)

Arguments

Repository

[required] The repository to associate.

ClientRequestToken

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

Tags

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.

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.

Value

A list with the following syntax:

list(
  RepositoryAssociation = list(
    AssociationId = "string",
    AssociationArn = "string",
    ConnectionArn = "string",
    Name = "string",
    Owner = "string",
    ProviderType = "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket",
    State = "Associated"|"Associating"|"Failed"|"Disassociating"|"Disassociated",
    StateReason = "string",
    LastUpdatedTimeStamp = as.POSIXct(
      "2015-01-01"
    ),
    CreatedTimeStamp = as.POSIXct(
      "2015-01-01"
    ),
    KMSKeyDetails = list(
      KMSKeyId = "string",
      EncryptionOption = "AWS_OWNED_CMK"|"CUSTOMER_MANAGED_CMK"
    ),
    S3RepositoryDetails = list(
      BucketName = "string",
      CodeArtifacts = list(
        SourceCodeArtifactsObjectKey = "string",
        BuildArtifactsObjectKey = "string"
      )
    )
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$associate_repository(
  Repository = list(
    CodeCommit = list(
      Name = "string"
    ),
    Bitbucket = list(
      Name = "string",
      ConnectionArn = "string",
      Owner = "string"
    ),
    GitHubEnterpriseServer = list(
      Name = "string",
      ConnectionArn = "string",
      Owner = "string"
    ),
    S3Bucket = list(
      Name = "string",
      BucketName = "string"
    )
  ),
  ClientRequestToken = "string",
  Tags = list(
    "string"
  ),
  KMSKeyDetails = list(
    KMSKeyId = "string",
    EncryptionOption = "AWS_OWNED_CMK"|"CUSTOMER_MANAGED_CMK"
  )
)