Repository repository
The repository to associate.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
RepositoryAssociation repositoryAssociation
Information about the repository association.
String name
The name of the AWS CodeCommit repository.
String name
The name of the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the code review to describe.
String repositoryName
The name of the repository.
String owner
The owner of the repository.
String providerType
The provider type of the repository association.
String state
The state of the code review.
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.
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 code review to describe.
String repositoryName
The name of the repository.
String owner
The owner of the repository.
String providerType
The provider type of the repository association.
String state
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 the code review.
String pullRequestId
The pull request ID for the code review.
MetricsSummary metricsSummary
The statistics from the code review.
String codeReviewArn
The Amazon Resource Name (ARN) of the code review to describe.
CodeReview codeReview
Information about the code review.
String codeReviewArn
The Amazon Resource Name (ARN) that identifies the code review.
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.
RecommendationFeedback recommendationFeedback
The recommendation feedback given by the user.
String associationArn
The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling
ListRepositories.
RepositoryAssociation repositoryAssociation
Information about the repository association.
String associationArn
The Amazon Resource Name (ARN) identifying the association.
RepositoryAssociation repositoryAssociation
Information about the disassociated repository.
List<E> providerTypes
List of provider types for filtering that needs to be applied before displaying the result. For example, "providerTypes=[GitHub]" will list 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]" will list code reviews in the Pending state.
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) that identifies the code review.
List<E> userIds
Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user.
List<E> recommendationIds
Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation.
List<E> recommendationFeedbackSummaries
Recommendation feedback summaries corresponding to the code reivew 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.
List<E> providerTypes
List of provider types to use as a filter.
List<E> states
List of states to use as a filter.
List<E> names
List of repository names to use as a filter.
List<E> owners
List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit 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 25. If this parameter is not
used, ListRepositoryAssociations returns up to 25 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 codeReviewArn
The Amazon Resource Name (ARN) that identifies the code review.
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) that identifies the code review.
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 user principal that made the API call.
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 identifier for the user that gave the feedback.
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 will be 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 Cloud 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) identifying the repository connection.
String name
The name of the repository.
String owner
The owner of the repository.
String providerType
The provider type of the repository association.
String state
The state of the repository association.
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.
String associationArn
The Amazon Resource Name (ARN) identifying the repository association.
String connectionArn
The Amazon Resource Name (ARN) identifying the repository connection.
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 association.
String providerType
The provider type of the repository association.
String state
The state of the repository association.
Amazon CodeGuru Reviewer is associated with the repository.
The association is in progress.
The association failed.
Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
CommitDiffSourceCodeType commitDiff
The commit diff for the pull request.
Copyright © 2020. All rights reserved.