"documentation":"<p>Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.</p> <p>You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.</p>"
},
"DescribeCodeReview":{
"name":"DescribeCodeReview",
"http":{
"method":"GET",
"requestUri":"/codereviews/{CodeReviewArn}"
},
"input":{"shape":"DescribeCodeReviewRequest"},
"output":{"shape":"DescribeCodeReviewResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Returns the metadaata associated with the code review along with its status.</p>"
"documentation":"<p> Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations. </p>"
"documentation":"<p>Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.</p>"
"documentation":"<p> Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. </p>"
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p> <p>To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.</p> <p>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.</p> <p>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.</p> <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries. </p>",
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
}
}
},
"DescribeCodeReviewResponse":{
"type":"structure",
"members":{
"CodeReview":{
"shape":"CodeReview",
"documentation":"<p> Information about the code review. </p>"
}
}
},
"DescribeRecommendationFeedbackRequest":{
"type":"structure",
"required":[
"CodeReviewArn",
"RecommendationId"
],
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. </p>",
"location":"querystring",
"locationName":"RecommendationId"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request. </p>",
"location":"querystring",
"locationName":"UserId"
}
}
},
"DescribeRecommendationFeedbackResponse":{
"type":"structure",
"members":{
"RecommendationFeedback":{
"shape":"RecommendationFeedback",
"documentation":"<p> The recommendation feedback given by the user. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling <code>ListRepositories</code>.</p>",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"ProviderTypes"
},
"States":{
"shape":"JobStates",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"States"
},
"RepositoryNames":{
"shape":"RepositoryNames",
"documentation":"<p> List of repository names for filtering that needs to be applied before displaying the result. </p>",
"location":"querystring",
"locationName":"RepositoryNames"
},
"Type":{
"shape":"Type",
"documentation":"<p> The type of code reviews to list in the response. </p>",
"location":"querystring",
"locationName":"Type"
},
"MaxResults":{
"shape":"ListCodeReviewsMaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListCodeReviewsResponse":{
"type":"structure",
"members":{
"CodeReviewSummaries":{
"shape":"CodeReviewSummaries",
"documentation":"<p> A list of code reviews that meet the criteria of the request. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. </p>"
}
}
},
"ListRecommendationFeedbackRequest":{
"type":"structure",
"required":["CodeReviewArn"],
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
},
"UserIds":{
"shape":"UserIds",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"UserIds"
},
"RecommendationIds":{
"shape":"RecommendationIds",
"documentation":"<p> 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. </p>",
"location":"querystring",
"locationName":"RecommendationIds"
}
}
},
"ListRecommendationFeedbackResponse":{
"type":"structure",
"members":{
"RecommendationFeedbackSummaries":{
"shape":"RecommendationFeedbackSummaries",
"documentation":"<p> Recommendation feedback summaries corresponding to the code reivew ARN. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> 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. </p>"
}
}
},
"ListRecommendationsRequest":{
"type":"structure",
"required":["CodeReviewArn"],
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. </p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
}
}
},
"ListRecommendationsResponse":{
"type":"structure",
"members":{
"RecommendationSummaries":{
"shape":"RecommendationSummaries",
"documentation":"<p> List of recommendations for the requested code review. </p>"
"documentation":"<p>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.</p>",
"documentation":"<p>The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 25. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to 25 results and a <code>nextToken</code> value if applicable. </p>",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>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.</p> </note>",
"documentation":"<p>A list of repository associations that meet the criteria of the request.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListRecommendations</code> request. When the results of a <code>ListRecommendations</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback. </p>"
}
}
},
"PutRecommendationFeedbackResponse":{
"type":"structure",
"members":{
}
},
"Reaction":{
"type":"string",
"enum":[
"ThumbsUp",
"ThumbsDown"
]
},
"Reactions":{
"type":"list",
"member":{"shape":"Reaction"},
"max":1,
"min":0
},
"RecommendationFeedback":{
"type":"structure",
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback. </p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> The user principal that made the API call. </p>"
},
"CreatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time at which the feedback was created. </p>"
},
"LastUpdatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time at which the feedback was last updated. </p>"
}
},
"documentation":"<p> Information about the recommendation feedback. </p>"
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. </p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> The identifier for the user that gave the feedback. </p>"
}
},
"documentation":"<p> Information about recommendation feedback summaries. </p>"
},
"RecommendationId":{
"type":"string",
"max":64,
"min":1
},
"RecommendationIds":{
"type":"list",
"member":{"shape":"RecommendationId"},
"max":100,
"min":1
},
"RecommendationSummaries":{
"type":"list",
"member":{"shape":"RecommendationSummary"}
},
"RecommendationSummary":{
"type":"structure",
"members":{
"FilePath":{
"shape":"FilePath",
"documentation":"<p>Name of the file on which a recommendation is provided.</p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"StartLine":{
"shape":"LineNumber",
"documentation":"<p> Start line from where the recommendation is applicable in the source commit or source branch. </p>"
},
"EndLine":{
"shape":"LineNumber",
"documentation":"<p> 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. </p>"
},
"Description":{
"shape":"Text",
"documentation":"<p> A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line. </p>"
}
},
"documentation":"<p> Information about recommendations. </p>"
"documentation":"<p>The state of the repository association.</p> <dl> <dt>Associated</dt> <dd> <p>Amazon CodeGuru Reviewer is associated with the repository. </p> </dd> <dt>Associating</dt> <dd> <p>The association is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The association failed. </p> </dd> <dt>Disassociating</dt> <dd> <p>Amazon CodeGuru Reviewer is in the process of disassociating with the repository. </p> </dd> </dl>"