RepositoryAssociation - Amazon CodeGuru Reviewer
ContentsSee Also

RepositoryAssociation

Information about a repository association. The DescribeRepositoryAssociation operation returns a RepositoryAssociation object.

Contents

AssociationArn

The Amazon Resource Name (ARN) identifying the repository association.

Type: String

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

Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$

Required: No

AssociationId

The ID of the repository association.

Type: String

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

Required: No

ConnectionArn

The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+

Required: No

CreatedTimeStamp

The time, in milliseconds since the epoch, when the repository association was created.

Type: Timestamp

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 repository association.

Type: KMSKeyDetails object

Required: No

LastUpdatedTimeStamp

The time, in milliseconds since the epoch, when the repository association was last updated.

Type: Timestamp

Required: No

Name

The name of the repository.

Type: String

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

Pattern: ^\S[\w.-]*$

Required: No

Owner

The owner of the repository. For an AWS CodeCommit repository, this is the AWS 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 AWS account ID.

Type: String

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

Pattern: ^\S(.*\S)?$

Required: No

ProviderType

The provider type of the repository association.

Type: String

Valid Values: CodeCommit | GitHub | Bitbucket | GitHubEnterpriseServer | S3Bucket

Required: No

S3RepositoryDetails

Specifies the name of an S3 bucket and a CodeArtifacts object that contains the S3 object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.

Type: S3RepositoryDetails object

Required: No

State

The state of the repository association.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      Note

      If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

  • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

Type: String

Valid Values: Associated | Associating | Failed | Disassociating | Disassociated

Required: No

StateReason

A description of why the repository association is in the current state.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

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