AssociateRepository - Amazon CodeGuru

AssociateRepository

Use to associate an AWS CodeCommit repository or a repostory managed by AWS 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 AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

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

Note

You cannot use the CodeGuru Reviewer SDK or the AWS 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.

Request Syntax

POST /associations HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "KMSKeyDetails": { "EncryptionOption": "string", "KMSKeyId": "string" }, "Repository": { "Bitbucket": { "ConnectionArn": "string", "Name": "string", "Owner": "string" }, "CodeCommit": { "Name": "string" }, "GitHubEnterpriseServer": { "ConnectionArn": "string", "Name": "string", "Owner": "string" }, "S3Bucket": { "BucketName": "string", "Name": "string" } }, "Tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w-]+$

Required: No

KMSKeyDetails

A KMSKeyDetails object that contains:

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

  • The ID of the AWS KMS key that is associated with this respository association.

Type: KMSKeyDetails object

Required: No

Repository

The repository to associate.

Type: Repository object

Required: Yes

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.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "RepositoryAssociation": { "AssociationArn": "string", "AssociationId": "string", "ConnectionArn": "string", "CreatedTimeStamp": number, "KMSKeyDetails": { "EncryptionOption": "string", "KMSKeyId": "string" }, "LastUpdatedTimeStamp": number, "Name": "string", "Owner": "string", "ProviderType": "string", "S3RepositoryDetails": { "BucketName": "string", "CodeArtifacts": { "BuildArtifactsObjectKey": "string", "SourceCodeArtifactsObjectKey": "string" } }, "State": "string", "StateReason": "string" }, "Tags": { "string" : "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RepositoryAssociation

Information about the repository association.

Type: RepositoryAssociation object

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.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: