AWS CLI Command Reference

[ aws . codeguru-reviewer ]

associate-repository

Description

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 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 Connect to a repository source provider 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-repository
--repository <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--repository (structure)

The repository to associate.

CodeCommit -> (structure)

Information about an AWS CodeCommit repository.

Name -> (string)

The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference .

Bitbucket -> (structure)

Information about a Bitbucket repository.

Name -> (string)

The name of the third party source repository.

ConnectionArn -> (string)

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 https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ in the AWS CodeStar Connections API Reference .

Owner -> (string)

The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.

GitHubEnterpriseServer -> (structure)

Information about a GitHub Enterprise Server repository.

Name -> (string)

The name of the third party source repository.

ConnectionArn -> (string)

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 https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ in the AWS CodeStar Connections API Reference .

Owner -> (string)

The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.

Shorthand Syntax:

CodeCommit={Name=string},Bitbucket={Name=string,ConnectionArn=string,Owner=string},GitHubEnterpriseServer={Name=string,ConnectionArn=string,Owner=string}

JSON Syntax:

{
  "CodeCommit": {
    "Name": "string"
  },
  "Bitbucket": {
    "Name": "string",
    "ConnectionArn": "string",
    "Owner": "string"
  },
  "GitHubEnterpriseServer": {
    "Name": "string",
    "ConnectionArn": "string",
    "Owner": "string"
  }
}

--client-request-token (string)

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

--tags (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To create a Bitbucket repository association

The following associate-repository example creates a respository association using an existing Bitbucket repository.

aws codeguru-reviewer associate-repository \
    --repository 'Bitbucket={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'

Output:

{
    "RepositoryAssociation": {
        "ProviderType": "Bitbucket",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596216896.979,
        "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "Owner": "sample-owner"
    }
}

For more information, see `AssociateRepository<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_AssociateRepository.html>`__ in the Amazon DevOps Guru API Reference.

Example 2: To create a GitHub Enterprise repository association

The following associate-repository example creates a respository association using an existing GitHub Enterprise repository.

aws codeguru-reviewer associate-repository \
    --repository 'GitHubEnterpriseServer={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'

Output:

{
    "RepositoryAssociation": {
        "ProviderType": "GitHubEnterpriseServer",
        "Name": "mySampleRepo",
        "LastUpdatedTimeStamp": 1596216896.979,
        "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "CreatedTimeStamp": 1596216896.979,
        "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "Owner": "sample-owner"
    }
}

For more information, see `AssociateRepository<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_AssociateRepository.html>`__ in the Amazon DevOps Guru API Reference

Example 3: To create an AWS CodeCommit repository association

The following associate-repository example creates a respository association using an existing AWS CodeCommit repository.

aws codeguru-reviewer associate-repository \
    --repository CodeCommit={Name=mySampleRepo}

Output:

{
    "RepositoryAssociation": {
        "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "Name": "My-ecs-beta-repo",
        "LastUpdatedTimeStamp": 1595634764.029,
        "ProviderType": "CodeCommit",
        "CreatedTimeStamp": 1595634764.029,
        "Owner": "544120495673",
        "State": "Associating",
        "StateReason": "Pending Repository Association",
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:544120495673:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

For more information, see `AssociateRepository<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_AssociateRepository.html>`__ in the Amazon DevOps Guru API Reference

Output

RepositoryAssociation -> (structure)

Information about the repository association.

AssociationId -> (string)

The ID of the repository association.

AssociationArn -> (string)

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

ConnectionArn -> (string)

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 https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ in the AWS CodeStar Connections API Reference .

Name -> (string)

The name of the repository.

Owner -> (string)

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.

ProviderType -> (string)

The provider type of the repository association.

State -> (string)

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

StateReason -> (string)

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

LastUpdatedTimeStamp -> (timestamp)

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

CreatedTimeStamp -> (timestamp)

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

Tags -> (map)

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.

key -> (string)

value -> (string)

© Copyright 2018, Amazon Web Services. Created using Sphinx.