Repository repository
The repository to associate.
String clientRequestToken
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
Map<K,V> 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.
KMSKeyDetails 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.
RepositoryAssociation repositoryAssociation
Information about the repository association.
Map<K,V> 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.
String name
The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference.
String name
The name of the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
String repositoryName
The name of the repository.
String 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.
String providerType
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
String state
The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
String stateReason
The reason for the state of the code review.
Date createdTimeStamp
The time, in milliseconds since the epoch, when the code review was created.
Date lastUpdatedTimeStamp
The time, in milliseconds since the epoch, when the code review was last updated.
String type
The type of code review.
String pullRequestId
The pull request ID for the code review.
SourceCodeType sourceCodeType
The type of the source code for the code review.
String associationArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation that contains the reviewed source code. You can retrieve associated
repository ARNs by calling
ListRepositoryAssociations .
Metrics metrics
The statistics from the code review.
String name
The name of the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
String repositoryName
The name of the repository.
String 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.
String providerType
The provider type of the repository association.
String state
The state of the code review.
The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
Date createdTimeStamp
The time, in milliseconds since the epoch, when the code review was created.
Date lastUpdatedTimeStamp
The time, in milliseconds since the epoch, when the code review was last updated.
String type
The type of the code review.
String pullRequestId
The pull request ID for the code review.
MetricsSummary metricsSummary
The statistics from the code review.
RepositoryAnalysis repositoryAnalysis
A code review that analyzes all code under a specified branch in an associated repository. The associated
repository is specified using its ARN in
CreateCodeReview .
String name
The name of the code review. The name of each code review in your AWS account must be unique.
String repositoryAssociationArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
A code review can only be created on an associated repository. This is the ARN of the associated repository.
CodeReviewType type
The type of code review to create. This is specified using a
CodeReviewType object. You can create a code review only of type
RepositoryAnalysis.
String clientRequestToken
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
CodeReview codeReview
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
CodeReview codeReview
Information about the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
String recommendationId
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
String userId
Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name
(ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.
RecommendationFeedback recommendationFeedback
The recommendation feedback given by the user.
String associationArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
RepositoryAssociation repositoryAssociation
Information about the repository association.
Map<K,V> 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.
String associationArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
RepositoryAssociation repositoryAssociation
Information about the disassociated repository.
Map<K,V> 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.
String kMSKeyId
The ID of the AWS KMS key that is associated with a respository association.
String encryptionOption
The encryption option for a repository association. It is either owned by AWS Key Management Service (KMS) (
AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).
List<E> providerTypes
List of provider types for filtering that needs to be applied before displaying the result. For example,
providerTypes=[GitHub] lists code reviews from GitHub.
List<E> states
List of states for filtering that needs to be applied before displaying the result. For example,
states=[Pending] lists code reviews in the Pending state.
The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
List<E> repositoryNames
List of repository names for filtering that needs to be applied before displaying the result.
String type
The type of code reviews to list in the response.
Integer maxResults
The maximum number of results that are returned per call. The default is 100.
String nextToken
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
String nextToken
If nextToken is returned, there are more results available. The value of nextToken is a unique
pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all
other arguments unchanged.
Integer maxResults
The maximum number of results that are returned per call. The default is 100.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
List<E> userIds
An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name
(ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.
List<E> recommendationIds
Used to query the recommendation feedback for a given recommendation.
List<E> recommendationFeedbackSummaries
Recommendation feedback summaries corresponding to the code review ARN.
String nextToken
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
String nextToken
Pagination token.
Integer maxResults
The maximum number of results that are returned per call. The default is 100.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
List<E> providerTypes
List of provider types to use as a filter.
List<E> states
List of repository association states to use as a filter.
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.
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.
List<E> names
List of repository names to use as a filter.
List<E> owners
List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository.
Integer maxResults
The maximum number of repository association results returned by ListRepositoryAssociations in
paginated output. When this parameter is used, ListRepositoryAssociations only returns
maxResults results in a single page with a nextToken response element. The remaining
results of the initial request can be seen by sending another ListRepositoryAssociations request
with the returned nextToken value. This value can be between 1 and 100. If this parameter is not
used, ListRepositoryAssociations returns up to 100 results and a nextToken value if
applicable.
String nextToken
The nextToken value returned from a previous paginated ListRepositoryAssociations
request where maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value.
Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
List<E> repositoryAssociationSummaries
A list of repository associations that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListRecommendations request. When the
results of a ListRecommendations request exceed maxResults, this value can be used to
retrieve the next page of results. This value is null when there are no more results to return.
String resourceArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
Map<K,V> 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.
Long meteredLinesOfCodeCount
Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions,
this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that
already existed in the pull request, this includes only the changed lines of code. In both cases, this does not
include non-code lines such as comments and import statements. For example, if you submit a pull request
containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines
of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount
includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for
a total of 2,725 lines of code.
Long findingsCount
Total number of recommendations found in the code review.
Long meteredLinesOfCodeCount
Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions,
this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that
already existed in the pull request, this includes only the changed lines of code. In both cases, this does not
include non-code lines such as comments and import statements. For example, if you submit a pull request
containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines
of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount
includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for
a total of 2,725 lines of code.
Long findingsCount
Total number of recommendations found in the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
String recommendationId
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
List<E> reactions
List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
String codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview
object.
String recommendationId
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
List<E> reactions
List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback.
String userId
The ID of the user that made the API call.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name
(ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.
Date createdTimeStamp
The time at which the feedback was created.
Date lastUpdatedTimeStamp
The time at which the feedback was last updated.
String recommendationId
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
List<E> reactions
List for storing reactions. Reactions are utf-8 text code for emojis.
String userId
The ID of the user that gave the feedback.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name
(ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.
String filePath
Name of the file on which a recommendation is provided.
String recommendationId
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Integer startLine
Start line from where the recommendation is applicable in the source commit or source branch.
Integer endLine
Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.
String description
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
CodeCommitRepository codeCommit
Information about an AWS CodeCommit repository.
ThirdPartySourceRepository bitbucket
Information about a Bitbucket repository.
ThirdPartySourceRepository gitHubEnterpriseServer
Information about a GitHub Enterprise Server repository.
RepositoryHeadSourceCodeType repositoryHead
A
SourceCodeType that specifies the tip of a branch in an associated repository.
String associationId
The ID of the repository association.
String associationArn
The Amazon Resource Name (ARN) identifying the repository association.
String 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.
String name
The name of the repository.
String 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.
String providerType
The provider type of the repository association.
String 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.
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.
String stateReason
A description of why the repository association is in the current state.
Date lastUpdatedTimeStamp
The time, in milliseconds since the epoch, when the repository association was last updated.
Date createdTimeStamp
The time, in milliseconds since the epoch, when the repository association was created.
KMSKeyDetails 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.
String associationArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
String 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.
Date lastUpdatedTimeStamp
The time, in milliseconds since the epoch, since the repository association was last updated.
String associationId
The repository association ID.
String name
The name of the repository association.
String 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.
String providerType
The provider type of the repository association.
String 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.
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.
String branchName
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the
tip of this branch.
CommitDiffSourceCodeType commitDiff
A
SourceCodeType that specifies a commit diff created by a pull request on an associated
repository.
RepositoryHeadSourceCodeType repositoryHead
String resourceArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
Map<K,V> 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.
String name
The name of the third party source repository.
String 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.
String owner
The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
String resourceArn
The Amazon Resource Name (ARN) of the
RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations .
List<E> tagKeys
A list of the keys for each tag you want to remove from an associated repository.
Copyright © 2021. All rights reserved.