RepositoryAssociationSummary - Amazon CodeGuru Reviewer

RepositoryAssociationSummary

Summary information about a repository association. The ListRepositoryAssociations operation returns a list of RepositoryAssociationSummary objects.

Contents

AssociationArn

The Amazon Resource Name (ARN) of the RepositoryAssociation object.

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

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

LastUpdatedTimeStamp

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

Type: Timestamp

Required: No

Name

The name of the repository association.

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 or Bitbucket repository, this is the username for the account that owns the repository.

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

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

Type: String

Valid Values: Associated | Associating | Failed | Disassociating

Required: No

See Also

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