[ aws . codeguru-reviewer ]
describe-repository-association¶
Description¶
Returns a ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object that contains information about the requested repository association.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-repository-association
--association-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--association-arn (string)
The Amazon Resource Name (ARN) of the `
RepositoryAssociationhttps://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object. You can retrieve this ARN by calling `ListRepositoryAssociationshttps://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
--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 return information about a GitHub repository association
The following describe-repository-association example returns information about a repository association that uses a GitHub Enterprise repository and is in the Associated state.
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"RepositoryAssociation": {
"AssociationId": "b822717e-0711-4e8a-bada-0e738289c75e",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1588102637.649,
"ProviderType": "GitHub",
"CreatedTimeStamp": 1588102615.636,
"Owner": "sample-owner",
"State": "Associated",
"StateReason": "Pull Request Notification configuration successful",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
For more information, see `DescribeRepositoryAssociation<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html>`__ in the Amazon DevOps Guru API Reference
Example 2: To return information about a failed repository association
The following describe-repository-association example returns information about a repository association that uses a GitHub Enterprise repository and is in the Failed state.
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596217036.892,
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"State": "Failed",
"StateReason": "Failed, Please retry.",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "sample-owner"
}
}
For more information, see `DescribeRepositoryAssociation<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html>`__ in the Amazon DevOps Guru API Reference.
Example 3: To return information about a disassociating repository association
The following describe-repository-association example returns information about a repository association that uses a GitHub Enterprise repository and is in the Disassociating state.
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596217036.892,
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"State": "Disassociating",
"StateReason": "Source code access removal in progress",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "sample-owner"
}
}
For more information, see `DescribeRepositoryAssociation<https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.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 `Connectionhttps://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
ProviderTypeisGitHub,GitHub Enterprise Server, orBitbucket, 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, orSecret). 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)