aws-sdk-codegurureviewer 1.8.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-codegurureviewer.rb +3 -2
- data/lib/aws-sdk-codegurureviewer/client.rb +282 -82
- data/lib/aws-sdk-codegurureviewer/client_api.rb +41 -0
- data/lib/aws-sdk-codegurureviewer/types.rb +543 -98
- metadata +4 -4
|
@@ -18,15 +18,20 @@ module Aws::CodeGuruReviewer
|
|
|
18
18
|
AssociateRepositoryRequest = Shapes::StructureShape.new(name: 'AssociateRepositoryRequest')
|
|
19
19
|
AssociateRepositoryResponse = Shapes::StructureShape.new(name: 'AssociateRepositoryResponse')
|
|
20
20
|
AssociationId = Shapes::StringShape.new(name: 'AssociationId')
|
|
21
|
+
BranchName = Shapes::StringShape.new(name: 'BranchName')
|
|
21
22
|
ClientRequestToken = Shapes::StringShape.new(name: 'ClientRequestToken')
|
|
22
23
|
CodeCommitRepository = Shapes::StructureShape.new(name: 'CodeCommitRepository')
|
|
23
24
|
CodeReview = Shapes::StructureShape.new(name: 'CodeReview')
|
|
25
|
+
CodeReviewName = Shapes::StringShape.new(name: 'CodeReviewName')
|
|
24
26
|
CodeReviewSummaries = Shapes::ListShape.new(name: 'CodeReviewSummaries')
|
|
25
27
|
CodeReviewSummary = Shapes::StructureShape.new(name: 'CodeReviewSummary')
|
|
28
|
+
CodeReviewType = Shapes::StructureShape.new(name: 'CodeReviewType')
|
|
26
29
|
CommitDiffSourceCodeType = Shapes::StructureShape.new(name: 'CommitDiffSourceCodeType')
|
|
27
30
|
CommitId = Shapes::StringShape.new(name: 'CommitId')
|
|
28
31
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
|
29
32
|
ConnectionArn = Shapes::StringShape.new(name: 'ConnectionArn')
|
|
33
|
+
CreateCodeReviewRequest = Shapes::StructureShape.new(name: 'CreateCodeReviewRequest')
|
|
34
|
+
CreateCodeReviewResponse = Shapes::StructureShape.new(name: 'CreateCodeReviewResponse')
|
|
30
35
|
DescribeCodeReviewRequest = Shapes::StructureShape.new(name: 'DescribeCodeReviewRequest')
|
|
31
36
|
DescribeCodeReviewResponse = Shapes::StructureShape.new(name: 'DescribeCodeReviewResponse')
|
|
32
37
|
DescribeRecommendationFeedbackRequest = Shapes::StructureShape.new(name: 'DescribeRecommendationFeedbackRequest')
|
|
@@ -76,11 +81,13 @@ module Aws::CodeGuruReviewer
|
|
|
76
81
|
RecommendationSummaries = Shapes::ListShape.new(name: 'RecommendationSummaries')
|
|
77
82
|
RecommendationSummary = Shapes::StructureShape.new(name: 'RecommendationSummary')
|
|
78
83
|
Repository = Shapes::StructureShape.new(name: 'Repository')
|
|
84
|
+
RepositoryAnalysis = Shapes::StructureShape.new(name: 'RepositoryAnalysis')
|
|
79
85
|
RepositoryAssociation = Shapes::StructureShape.new(name: 'RepositoryAssociation')
|
|
80
86
|
RepositoryAssociationState = Shapes::StringShape.new(name: 'RepositoryAssociationState')
|
|
81
87
|
RepositoryAssociationStates = Shapes::ListShape.new(name: 'RepositoryAssociationStates')
|
|
82
88
|
RepositoryAssociationSummaries = Shapes::ListShape.new(name: 'RepositoryAssociationSummaries')
|
|
83
89
|
RepositoryAssociationSummary = Shapes::StructureShape.new(name: 'RepositoryAssociationSummary')
|
|
90
|
+
RepositoryHeadSourceCodeType = Shapes::StructureShape.new(name: 'RepositoryHeadSourceCodeType')
|
|
84
91
|
RepositoryNames = Shapes::ListShape.new(name: 'RepositoryNames')
|
|
85
92
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
|
86
93
|
SourceCodeType = Shapes::StructureShape.new(name: 'SourceCodeType')
|
|
@@ -137,6 +144,9 @@ module Aws::CodeGuruReviewer
|
|
|
137
144
|
CodeReviewSummary.add_member(:metrics_summary, Shapes::ShapeRef.new(shape: MetricsSummary, location_name: "MetricsSummary"))
|
|
138
145
|
CodeReviewSummary.struct_class = Types::CodeReviewSummary
|
|
139
146
|
|
|
147
|
+
CodeReviewType.add_member(:repository_analysis, Shapes::ShapeRef.new(shape: RepositoryAnalysis, required: true, location_name: "RepositoryAnalysis"))
|
|
148
|
+
CodeReviewType.struct_class = Types::CodeReviewType
|
|
149
|
+
|
|
140
150
|
CommitDiffSourceCodeType.add_member(:source_commit, Shapes::ShapeRef.new(shape: CommitId, location_name: "SourceCommit"))
|
|
141
151
|
CommitDiffSourceCodeType.add_member(:destination_commit, Shapes::ShapeRef.new(shape: CommitId, location_name: "DestinationCommit"))
|
|
142
152
|
CommitDiffSourceCodeType.struct_class = Types::CommitDiffSourceCodeType
|
|
@@ -144,6 +154,15 @@ module Aws::CodeGuruReviewer
|
|
|
144
154
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
|
145
155
|
ConflictException.struct_class = Types::ConflictException
|
|
146
156
|
|
|
157
|
+
CreateCodeReviewRequest.add_member(:name, Shapes::ShapeRef.new(shape: CodeReviewName, required: true, location_name: "Name"))
|
|
158
|
+
CreateCodeReviewRequest.add_member(:repository_association_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "RepositoryAssociationArn"))
|
|
159
|
+
CreateCodeReviewRequest.add_member(:type, Shapes::ShapeRef.new(shape: CodeReviewType, required: true, location_name: "Type"))
|
|
160
|
+
CreateCodeReviewRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
|
161
|
+
CreateCodeReviewRequest.struct_class = Types::CreateCodeReviewRequest
|
|
162
|
+
|
|
163
|
+
CreateCodeReviewResponse.add_member(:code_review, Shapes::ShapeRef.new(shape: CodeReview, location_name: "CodeReview"))
|
|
164
|
+
CreateCodeReviewResponse.struct_class = Types::CreateCodeReviewResponse
|
|
165
|
+
|
|
147
166
|
DescribeCodeReviewRequest.add_member(:code_review_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location: "uri", location_name: "CodeReviewArn"))
|
|
148
167
|
DescribeCodeReviewRequest.struct_class = Types::DescribeCodeReviewRequest
|
|
149
168
|
|
|
@@ -273,8 +292,12 @@ module Aws::CodeGuruReviewer
|
|
|
273
292
|
|
|
274
293
|
Repository.add_member(:code_commit, Shapes::ShapeRef.new(shape: CodeCommitRepository, location_name: "CodeCommit"))
|
|
275
294
|
Repository.add_member(:bitbucket, Shapes::ShapeRef.new(shape: ThirdPartySourceRepository, location_name: "Bitbucket"))
|
|
295
|
+
Repository.add_member(:git_hub_enterprise_server, Shapes::ShapeRef.new(shape: ThirdPartySourceRepository, location_name: "GitHubEnterpriseServer"))
|
|
276
296
|
Repository.struct_class = Types::Repository
|
|
277
297
|
|
|
298
|
+
RepositoryAnalysis.add_member(:repository_head, Shapes::ShapeRef.new(shape: RepositoryHeadSourceCodeType, required: true, location_name: "RepositoryHead"))
|
|
299
|
+
RepositoryAnalysis.struct_class = Types::RepositoryAnalysis
|
|
300
|
+
|
|
278
301
|
RepositoryAssociation.add_member(:association_id, Shapes::ShapeRef.new(shape: AssociationId, location_name: "AssociationId"))
|
|
279
302
|
RepositoryAssociation.add_member(:association_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AssociationArn"))
|
|
280
303
|
RepositoryAssociation.add_member(:connection_arn, Shapes::ShapeRef.new(shape: ConnectionArn, location_name: "ConnectionArn"))
|
|
@@ -301,12 +324,16 @@ module Aws::CodeGuruReviewer
|
|
|
301
324
|
RepositoryAssociationSummary.add_member(:state, Shapes::ShapeRef.new(shape: RepositoryAssociationState, location_name: "State"))
|
|
302
325
|
RepositoryAssociationSummary.struct_class = Types::RepositoryAssociationSummary
|
|
303
326
|
|
|
327
|
+
RepositoryHeadSourceCodeType.add_member(:branch_name, Shapes::ShapeRef.new(shape: BranchName, required: true, location_name: "BranchName"))
|
|
328
|
+
RepositoryHeadSourceCodeType.struct_class = Types::RepositoryHeadSourceCodeType
|
|
329
|
+
|
|
304
330
|
RepositoryNames.member = Shapes::ShapeRef.new(shape: Name)
|
|
305
331
|
|
|
306
332
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
|
307
333
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
|
308
334
|
|
|
309
335
|
SourceCodeType.add_member(:commit_diff, Shapes::ShapeRef.new(shape: CommitDiffSourceCodeType, location_name: "CommitDiff"))
|
|
336
|
+
SourceCodeType.add_member(:repository_head, Shapes::ShapeRef.new(shape: RepositoryHeadSourceCodeType, location_name: "RepositoryHead"))
|
|
310
337
|
SourceCodeType.struct_class = Types::SourceCodeType
|
|
311
338
|
|
|
312
339
|
ThirdPartySourceRepository.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "Name"))
|
|
@@ -354,6 +381,20 @@ module Aws::CodeGuruReviewer
|
|
|
354
381
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
355
382
|
end)
|
|
356
383
|
|
|
384
|
+
api.add_operation(:create_code_review, Seahorse::Model::Operation.new.tap do |o|
|
|
385
|
+
o.name = "CreateCodeReview"
|
|
386
|
+
o.http_method = "POST"
|
|
387
|
+
o.http_request_uri = "/codereviews"
|
|
388
|
+
o.input = Shapes::ShapeRef.new(shape: CreateCodeReviewRequest)
|
|
389
|
+
o.output = Shapes::ShapeRef.new(shape: CreateCodeReviewResponse)
|
|
390
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
391
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
392
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
393
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
394
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
395
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
396
|
+
end)
|
|
397
|
+
|
|
357
398
|
api.add_operation(:describe_code_review, Seahorse::Model::Operation.new.tap do |o|
|
|
358
399
|
o.name = "DescribeCodeReview"
|
|
359
400
|
o.http_method = "GET"
|
|
@@ -36,6 +36,11 @@ module Aws::CodeGuruReviewer
|
|
|
36
36
|
# connection_arn: "ConnectionArn", # required
|
|
37
37
|
# owner: "Owner", # required
|
|
38
38
|
# },
|
|
39
|
+
# git_hub_enterprise_server: {
|
|
40
|
+
# name: "Name", # required
|
|
41
|
+
# connection_arn: "ConnectionArn", # required
|
|
42
|
+
# owner: "Owner", # required
|
|
43
|
+
# },
|
|
39
44
|
# },
|
|
40
45
|
# client_request_token: "ClientRequestToken",
|
|
41
46
|
# }
|
|
@@ -45,27 +50,6 @@ module Aws::CodeGuruReviewer
|
|
|
45
50
|
# @return [Types::Repository]
|
|
46
51
|
#
|
|
47
52
|
# @!attribute [rw] client_request_token
|
|
48
|
-
# Unique, case-sensitive identifier that you provide to ensure the
|
|
49
|
-
# idempotency of the request.
|
|
50
|
-
#
|
|
51
|
-
# To add a new repository association, this parameter specifies a
|
|
52
|
-
# unique identifier for the new repository association that helps
|
|
53
|
-
# ensure idempotency.
|
|
54
|
-
#
|
|
55
|
-
# If you use the AWS CLI or one of the AWS SDKs to call this
|
|
56
|
-
# operation, you can leave this parameter empty. The CLI or SDK
|
|
57
|
-
# generates a random UUID for you and includes that in the request. If
|
|
58
|
-
# you don't use the SDK and instead generate a raw HTTP request to
|
|
59
|
-
# the Secrets Manager service endpoint, you must generate a
|
|
60
|
-
# ClientRequestToken yourself for new versions and include that value
|
|
61
|
-
# in the request.
|
|
62
|
-
#
|
|
63
|
-
# You typically interact with this value if you implement your own
|
|
64
|
-
# retry logic and want to ensure that a given repository association
|
|
65
|
-
# is not created twice. We recommend that you generate a UUID-type
|
|
66
|
-
# value to ensure uniqueness within the specified repository
|
|
67
|
-
# association.
|
|
68
|
-
#
|
|
69
53
|
# Amazon CodeGuru Reviewer uses this value to prevent the accidental
|
|
70
54
|
# creation of duplicate repository associations if there are failures
|
|
71
55
|
# and retries.
|
|
@@ -95,7 +79,9 @@ module Aws::CodeGuruReviewer
|
|
|
95
79
|
include Aws::Structure
|
|
96
80
|
end
|
|
97
81
|
|
|
98
|
-
# Information about an AWS CodeCommit repository.
|
|
82
|
+
# Information about an AWS CodeCommit repository. The CodeCommit
|
|
83
|
+
# repository must be in the same AWS Region and AWS account where its
|
|
84
|
+
# CodeGuru Reviewer code reviews are configured.
|
|
99
85
|
#
|
|
100
86
|
# @note When making an API call, you may pass CodeCommitRepository
|
|
101
87
|
# data as a hash:
|
|
@@ -105,7 +91,12 @@ module Aws::CodeGuruReviewer
|
|
|
105
91
|
# }
|
|
106
92
|
#
|
|
107
93
|
# @!attribute [rw] name
|
|
108
|
-
# The name of the AWS CodeCommit repository.
|
|
94
|
+
# The name of the AWS CodeCommit repository. For more information, see
|
|
95
|
+
# [repositoryName][1] in the *AWS CodeCommit API Reference*.
|
|
96
|
+
#
|
|
97
|
+
#
|
|
98
|
+
#
|
|
99
|
+
# [1]: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName
|
|
109
100
|
# @return [String]
|
|
110
101
|
#
|
|
111
102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/CodeCommitRepository AWS API Documentation
|
|
@@ -123,7 +114,11 @@ module Aws::CodeGuruReviewer
|
|
|
123
114
|
# @return [String]
|
|
124
115
|
#
|
|
125
116
|
# @!attribute [rw] code_review_arn
|
|
126
|
-
# The Amazon Resource Name (ARN) of the
|
|
117
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
118
|
+
#
|
|
119
|
+
#
|
|
120
|
+
#
|
|
121
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
127
122
|
# @return [String]
|
|
128
123
|
#
|
|
129
124
|
# @!attribute [rw] repository_name
|
|
@@ -131,15 +126,28 @@ module Aws::CodeGuruReviewer
|
|
|
131
126
|
# @return [String]
|
|
132
127
|
#
|
|
133
128
|
# @!attribute [rw] owner
|
|
134
|
-
# The owner of the repository.
|
|
129
|
+
# The owner of the repository. For an AWS CodeCommit repository, this
|
|
130
|
+
# is the AWS account ID of the account that owns the repository. For a
|
|
131
|
+
# GitHub, GitHub Enterprise Server, or Bitbucket repository, this is
|
|
132
|
+
# the username for the account that owns the repository.
|
|
135
133
|
# @return [String]
|
|
136
134
|
#
|
|
137
135
|
# @!attribute [rw] provider_type
|
|
138
|
-
# The
|
|
136
|
+
# The type of repository that contains the reviewed code (for example,
|
|
137
|
+
# GitHub or Bitbucket).
|
|
139
138
|
# @return [String]
|
|
140
139
|
#
|
|
141
140
|
# @!attribute [rw] state
|
|
142
|
-
# The
|
|
141
|
+
# The valid code review states are:
|
|
142
|
+
#
|
|
143
|
+
# * `Completed`\: The code review is complete.
|
|
144
|
+
#
|
|
145
|
+
# * `Pending`\: The code review started and has not completed or
|
|
146
|
+
# failed.
|
|
147
|
+
#
|
|
148
|
+
# * `Failed`\: The code review failed.
|
|
149
|
+
#
|
|
150
|
+
# * `Deleting`\: The code review is being deleted.
|
|
143
151
|
# @return [String]
|
|
144
152
|
#
|
|
145
153
|
# @!attribute [rw] state_reason
|
|
@@ -199,7 +207,11 @@ module Aws::CodeGuruReviewer
|
|
|
199
207
|
# @return [String]
|
|
200
208
|
#
|
|
201
209
|
# @!attribute [rw] code_review_arn
|
|
202
|
-
# The Amazon Resource Name (ARN) of the
|
|
210
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
211
|
+
#
|
|
212
|
+
#
|
|
213
|
+
#
|
|
214
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
203
215
|
# @return [String]
|
|
204
216
|
#
|
|
205
217
|
# @!attribute [rw] repository_name
|
|
@@ -207,7 +219,10 @@ module Aws::CodeGuruReviewer
|
|
|
207
219
|
# @return [String]
|
|
208
220
|
#
|
|
209
221
|
# @!attribute [rw] owner
|
|
210
|
-
# The owner of the repository.
|
|
222
|
+
# The owner of the repository. For an AWS CodeCommit repository, this
|
|
223
|
+
# is the AWS account ID of the account that owns the repository. For a
|
|
224
|
+
# GitHub, GitHub Enterprise Server, or Bitbucket repository, this is
|
|
225
|
+
# the username for the account that owns the repository.
|
|
211
226
|
# @return [String]
|
|
212
227
|
#
|
|
213
228
|
# @!attribute [rw] provider_type
|
|
@@ -216,6 +231,17 @@ module Aws::CodeGuruReviewer
|
|
|
216
231
|
#
|
|
217
232
|
# @!attribute [rw] state
|
|
218
233
|
# The state of the code review.
|
|
234
|
+
#
|
|
235
|
+
# The valid code review states are:
|
|
236
|
+
#
|
|
237
|
+
# * `Completed`\: The code review is complete.
|
|
238
|
+
#
|
|
239
|
+
# * `Pending`\: The code review started and has not completed or
|
|
240
|
+
# failed.
|
|
241
|
+
#
|
|
242
|
+
# * `Failed`\: The code review failed.
|
|
243
|
+
#
|
|
244
|
+
# * `Deleting`\: The code review is being deleted.
|
|
219
245
|
# @return [String]
|
|
220
246
|
#
|
|
221
247
|
# @!attribute [rw] created_time_stamp
|
|
@@ -258,14 +284,63 @@ module Aws::CodeGuruReviewer
|
|
|
258
284
|
include Aws::Structure
|
|
259
285
|
end
|
|
260
286
|
|
|
261
|
-
# The
|
|
287
|
+
# The type of a code review. There are two code review types:
|
|
288
|
+
#
|
|
289
|
+
# * `PullRequest` - A code review that is automatically triggered by a
|
|
290
|
+
# pull request on an assocaited repository. Because this type of code
|
|
291
|
+
# review is automatically generated, you cannot specify this code
|
|
292
|
+
# review type using [ `CreateCodeReview` ][1].
|
|
293
|
+
#
|
|
294
|
+
# * `RepositoryAnalysis` - A code review that analyzes all code under a
|
|
295
|
+
# specified branch in an associated respository. The assocated
|
|
296
|
+
# repository is specified using its ARN in [ `CreateCodeReview` ][1].
|
|
297
|
+
#
|
|
298
|
+
#
|
|
299
|
+
#
|
|
300
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview
|
|
301
|
+
#
|
|
302
|
+
# @note When making an API call, you may pass CodeReviewType
|
|
303
|
+
# data as a hash:
|
|
304
|
+
#
|
|
305
|
+
# {
|
|
306
|
+
# repository_analysis: { # required
|
|
307
|
+
# repository_head: { # required
|
|
308
|
+
# branch_name: "BranchName", # required
|
|
309
|
+
# },
|
|
310
|
+
# },
|
|
311
|
+
# }
|
|
312
|
+
#
|
|
313
|
+
# @!attribute [rw] repository_analysis
|
|
314
|
+
# A code review that analyzes all code under a specified branch in an
|
|
315
|
+
# associated respository. The assocated repository is specified using
|
|
316
|
+
# its ARN in [ `CreateCodeReview` ][1]
|
|
317
|
+
#
|
|
318
|
+
#
|
|
319
|
+
#
|
|
320
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview
|
|
321
|
+
# @return [Types::RepositoryAnalysis]
|
|
322
|
+
#
|
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/CodeReviewType AWS API Documentation
|
|
324
|
+
#
|
|
325
|
+
class CodeReviewType < Struct.new(
|
|
326
|
+
:repository_analysis)
|
|
327
|
+
SENSITIVE = []
|
|
328
|
+
include Aws::Structure
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
# A type of [ `SourceCodeType` ][1] that specifies the commit diff for a
|
|
332
|
+
# pull request on an associated repository.
|
|
333
|
+
#
|
|
334
|
+
#
|
|
335
|
+
#
|
|
336
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType
|
|
262
337
|
#
|
|
263
338
|
# @!attribute [rw] source_commit
|
|
264
|
-
#
|
|
339
|
+
# The SHA of the source commit used to generate a commit diff.
|
|
265
340
|
# @return [String]
|
|
266
341
|
#
|
|
267
342
|
# @!attribute [rw] destination_commit
|
|
268
|
-
#
|
|
343
|
+
# The SHA of the destination commit used to generate a commit diff.
|
|
269
344
|
# @return [String]
|
|
270
345
|
#
|
|
271
346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/CommitDiffSourceCodeType AWS API Documentation
|
|
@@ -292,6 +367,80 @@ module Aws::CodeGuruReviewer
|
|
|
292
367
|
include Aws::Structure
|
|
293
368
|
end
|
|
294
369
|
|
|
370
|
+
# @note When making an API call, you may pass CreateCodeReviewRequest
|
|
371
|
+
# data as a hash:
|
|
372
|
+
#
|
|
373
|
+
# {
|
|
374
|
+
# name: "CodeReviewName", # required
|
|
375
|
+
# repository_association_arn: "Arn", # required
|
|
376
|
+
# type: { # required
|
|
377
|
+
# repository_analysis: { # required
|
|
378
|
+
# repository_head: { # required
|
|
379
|
+
# branch_name: "BranchName", # required
|
|
380
|
+
# },
|
|
381
|
+
# },
|
|
382
|
+
# },
|
|
383
|
+
# client_request_token: "ClientRequestToken",
|
|
384
|
+
# }
|
|
385
|
+
#
|
|
386
|
+
# @!attribute [rw] name
|
|
387
|
+
# The name of the code review. Each code review of the same code
|
|
388
|
+
# review type must have a unique name in your AWS account.
|
|
389
|
+
# @return [String]
|
|
390
|
+
#
|
|
391
|
+
# @!attribute [rw] repository_association_arn
|
|
392
|
+
# The Amazon Resource Name (ARN) of the [ `RepositoryAssociation` ][1]
|
|
393
|
+
# object. You can retrieve this ARN by calling `ListRepositories`.
|
|
394
|
+
#
|
|
395
|
+
# A code review can only be created on an associated repository. This
|
|
396
|
+
# is the ARN of the associated repository.
|
|
397
|
+
#
|
|
398
|
+
#
|
|
399
|
+
#
|
|
400
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html
|
|
401
|
+
# @return [String]
|
|
402
|
+
#
|
|
403
|
+
# @!attribute [rw] type
|
|
404
|
+
# The type of code review to create. This is specified using a [
|
|
405
|
+
# `CodeReviewType` ][1] object.
|
|
406
|
+
#
|
|
407
|
+
#
|
|
408
|
+
#
|
|
409
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html
|
|
410
|
+
# @return [Types::CodeReviewType]
|
|
411
|
+
#
|
|
412
|
+
# @!attribute [rw] client_request_token
|
|
413
|
+
# Amazon CodeGuru Reviewer uses this value to prevent the accidental
|
|
414
|
+
# creation of duplicate code reviews if there are failures and
|
|
415
|
+
# retries.
|
|
416
|
+
#
|
|
417
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
418
|
+
# not need to pass this option.
|
|
419
|
+
# @return [String]
|
|
420
|
+
#
|
|
421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/CreateCodeReviewRequest AWS API Documentation
|
|
422
|
+
#
|
|
423
|
+
class CreateCodeReviewRequest < Struct.new(
|
|
424
|
+
:name,
|
|
425
|
+
:repository_association_arn,
|
|
426
|
+
:type,
|
|
427
|
+
:client_request_token)
|
|
428
|
+
SENSITIVE = []
|
|
429
|
+
include Aws::Structure
|
|
430
|
+
end
|
|
431
|
+
|
|
432
|
+
# @!attribute [rw] code_review
|
|
433
|
+
# Information about a code review.
|
|
434
|
+
# @return [Types::CodeReview]
|
|
435
|
+
#
|
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/CreateCodeReviewResponse AWS API Documentation
|
|
437
|
+
#
|
|
438
|
+
class CreateCodeReviewResponse < Struct.new(
|
|
439
|
+
:code_review)
|
|
440
|
+
SENSITIVE = []
|
|
441
|
+
include Aws::Structure
|
|
442
|
+
end
|
|
443
|
+
|
|
295
444
|
# @note When making an API call, you may pass DescribeCodeReviewRequest
|
|
296
445
|
# data as a hash:
|
|
297
446
|
#
|
|
@@ -300,7 +449,11 @@ module Aws::CodeGuruReviewer
|
|
|
300
449
|
# }
|
|
301
450
|
#
|
|
302
451
|
# @!attribute [rw] code_review_arn
|
|
303
|
-
# The Amazon Resource Name (ARN) of the
|
|
452
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
453
|
+
#
|
|
454
|
+
#
|
|
455
|
+
#
|
|
456
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
304
457
|
# @return [String]
|
|
305
458
|
#
|
|
306
459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/DescribeCodeReviewRequest AWS API Documentation
|
|
@@ -333,7 +486,11 @@ module Aws::CodeGuruReviewer
|
|
|
333
486
|
# }
|
|
334
487
|
#
|
|
335
488
|
# @!attribute [rw] code_review_arn
|
|
336
|
-
# The Amazon Resource Name (ARN)
|
|
489
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
490
|
+
#
|
|
491
|
+
#
|
|
492
|
+
#
|
|
493
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
337
494
|
# @return [String]
|
|
338
495
|
#
|
|
339
496
|
# @!attribute [rw] recommendation_id
|
|
@@ -344,6 +501,15 @@ module Aws::CodeGuruReviewer
|
|
|
344
501
|
# @!attribute [rw] user_id
|
|
345
502
|
# Optional parameter to describe the feedback for a given user. If
|
|
346
503
|
# this is not supplied, it defaults to the user making the request.
|
|
504
|
+
#
|
|
505
|
+
# The `UserId` is an IAM principal that can be specified as an AWS
|
|
506
|
+
# account ID or an Amazon Resource Name (ARN). For more information,
|
|
507
|
+
# see [ Specifying a Principal][1] in the *AWS Identity and Access
|
|
508
|
+
# Management User Guide*.
|
|
509
|
+
#
|
|
510
|
+
#
|
|
511
|
+
#
|
|
512
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying
|
|
347
513
|
# @return [String]
|
|
348
514
|
#
|
|
349
515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/DescribeRecommendationFeedbackRequest AWS API Documentation
|
|
@@ -376,8 +542,12 @@ module Aws::CodeGuruReviewer
|
|
|
376
542
|
# }
|
|
377
543
|
#
|
|
378
544
|
# @!attribute [rw] association_arn
|
|
379
|
-
# The Amazon Resource Name (ARN)
|
|
380
|
-
# retrieve this ARN by calling `ListRepositories`.
|
|
545
|
+
# The Amazon Resource Name (ARN) of the [ `RepositoryAssociation` ][1]
|
|
546
|
+
# object. You can retrieve this ARN by calling `ListRepositories`.
|
|
547
|
+
#
|
|
548
|
+
#
|
|
549
|
+
#
|
|
550
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html
|
|
381
551
|
# @return [String]
|
|
382
552
|
#
|
|
383
553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/DescribeRepositoryAssociationRequest AWS API Documentation
|
|
@@ -408,7 +578,12 @@ module Aws::CodeGuruReviewer
|
|
|
408
578
|
# }
|
|
409
579
|
#
|
|
410
580
|
# @!attribute [rw] association_arn
|
|
411
|
-
# The Amazon Resource Name (ARN)
|
|
581
|
+
# The Amazon Resource Name (ARN) of the [ `RepositoryAssociation` ][1]
|
|
582
|
+
# object. You can retrieve this ARN by calling `ListRepositories`.
|
|
583
|
+
#
|
|
584
|
+
#
|
|
585
|
+
#
|
|
586
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html
|
|
412
587
|
# @return [String]
|
|
413
588
|
#
|
|
414
589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/DisassociateRepositoryRequest AWS API Documentation
|
|
@@ -449,24 +624,35 @@ module Aws::CodeGuruReviewer
|
|
|
449
624
|
# data as a hash:
|
|
450
625
|
#
|
|
451
626
|
# {
|
|
452
|
-
# provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket
|
|
627
|
+
# provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer
|
|
453
628
|
# states: ["Completed"], # accepts Completed, Pending, Failed, Deleting
|
|
454
629
|
# repository_names: ["Name"],
|
|
455
|
-
# type: "PullRequest", # required, accepts PullRequest
|
|
630
|
+
# type: "PullRequest", # required, accepts PullRequest, RepositoryAnalysis
|
|
456
631
|
# max_results: 1,
|
|
457
632
|
# next_token: "NextToken",
|
|
458
633
|
# }
|
|
459
634
|
#
|
|
460
635
|
# @!attribute [rw] provider_types
|
|
461
636
|
# List of provider types for filtering that needs to be applied before
|
|
462
|
-
# displaying the result. For example,
|
|
463
|
-
#
|
|
637
|
+
# displaying the result. For example, `providerTypes=[GitHub]` lists
|
|
638
|
+
# code reviews from GitHub.
|
|
464
639
|
# @return [Array<String>]
|
|
465
640
|
#
|
|
466
641
|
# @!attribute [rw] states
|
|
467
642
|
# List of states for filtering that needs to be applied before
|
|
468
|
-
# displaying the result. For example,
|
|
469
|
-
#
|
|
643
|
+
# displaying the result. For example, `states=[Pending]` lists code
|
|
644
|
+
# reviews in the Pending state.
|
|
645
|
+
#
|
|
646
|
+
# The valid code review states are:
|
|
647
|
+
#
|
|
648
|
+
# * `Completed`\: The code review is complete.
|
|
649
|
+
#
|
|
650
|
+
# * `Pending`\: The code review started and has not completed or
|
|
651
|
+
# failed.
|
|
652
|
+
#
|
|
653
|
+
# * `Failed`\: The code review failed.
|
|
654
|
+
#
|
|
655
|
+
# * `Deleting`\: The code review is being deleted.
|
|
470
656
|
# @return [Array<String>]
|
|
471
657
|
#
|
|
472
658
|
# @!attribute [rw] repository_names
|
|
@@ -532,7 +718,7 @@ module Aws::CodeGuruReviewer
|
|
|
532
718
|
# }
|
|
533
719
|
#
|
|
534
720
|
# @!attribute [rw] next_token
|
|
535
|
-
# If nextToken is returned, there are more results available. The
|
|
721
|
+
# If `nextToken` is returned, there are more results available. The
|
|
536
722
|
# value of nextToken is a unique pagination token for each page. Make
|
|
537
723
|
# the call again using the returned token to retrieve the next page.
|
|
538
724
|
# Keep all other arguments unchanged.
|
|
@@ -544,19 +730,31 @@ module Aws::CodeGuruReviewer
|
|
|
544
730
|
# @return [Integer]
|
|
545
731
|
#
|
|
546
732
|
# @!attribute [rw] code_review_arn
|
|
547
|
-
# The Amazon Resource Name (ARN)
|
|
733
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
734
|
+
#
|
|
735
|
+
#
|
|
736
|
+
#
|
|
737
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
548
738
|
# @return [String]
|
|
549
739
|
#
|
|
550
740
|
# @!attribute [rw] user_ids
|
|
551
|
-
#
|
|
552
|
-
#
|
|
553
|
-
#
|
|
741
|
+
# An AWS user's account ID or Amazon Resource Name (ARN). Use this ID
|
|
742
|
+
# to query the recommendation feedback for a code review from that
|
|
743
|
+
# user.
|
|
744
|
+
#
|
|
745
|
+
# The `UserId` is an IAM principal that can be specified as an AWS
|
|
746
|
+
# account ID or an Amazon Resource Name (ARN). For more information,
|
|
747
|
+
# see [ Specifying a Principal][1] in the *AWS Identity and Access
|
|
748
|
+
# Management User Guide*.
|
|
749
|
+
#
|
|
750
|
+
#
|
|
751
|
+
#
|
|
752
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying
|
|
554
753
|
# @return [Array<String>]
|
|
555
754
|
#
|
|
556
755
|
# @!attribute [rw] recommendation_ids
|
|
557
|
-
#
|
|
558
|
-
#
|
|
559
|
-
# recommendation feedback for a given recommendation.
|
|
756
|
+
# Used to query the recommendation feedback for a given
|
|
757
|
+
# recommendation.
|
|
560
758
|
# @return [Array<String>]
|
|
561
759
|
#
|
|
562
760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/ListRecommendationFeedbackRequest AWS API Documentation
|
|
@@ -572,7 +770,7 @@ module Aws::CodeGuruReviewer
|
|
|
572
770
|
end
|
|
573
771
|
|
|
574
772
|
# @!attribute [rw] recommendation_feedback_summaries
|
|
575
|
-
# Recommendation feedback summaries corresponding to the code
|
|
773
|
+
# Recommendation feedback summaries corresponding to the code review
|
|
576
774
|
# ARN.
|
|
577
775
|
# @return [Array<Types::RecommendationFeedbackSummary>]
|
|
578
776
|
#
|
|
@@ -611,7 +809,11 @@ module Aws::CodeGuruReviewer
|
|
|
611
809
|
# @return [Integer]
|
|
612
810
|
#
|
|
613
811
|
# @!attribute [rw] code_review_arn
|
|
614
|
-
# The Amazon Resource Name (ARN) of the
|
|
812
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
813
|
+
#
|
|
814
|
+
#
|
|
815
|
+
#
|
|
816
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
615
817
|
# @return [String]
|
|
616
818
|
#
|
|
617
819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/ListRecommendationsRequest AWS API Documentation
|
|
@@ -645,7 +847,7 @@ module Aws::CodeGuruReviewer
|
|
|
645
847
|
# data as a hash:
|
|
646
848
|
#
|
|
647
849
|
# {
|
|
648
|
-
# provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket
|
|
850
|
+
# provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer
|
|
649
851
|
# states: ["Associated"], # accepts Associated, Associating, Failed, Disassociating
|
|
650
852
|
# names: ["Name"],
|
|
651
853
|
# owners: ["Owner"],
|
|
@@ -658,7 +860,32 @@ module Aws::CodeGuruReviewer
|
|
|
658
860
|
# @return [Array<String>]
|
|
659
861
|
#
|
|
660
862
|
# @!attribute [rw] states
|
|
661
|
-
# List of states to use as a filter.
|
|
863
|
+
# List of repository association states to use as a filter.
|
|
864
|
+
#
|
|
865
|
+
# The valid repository association states are:
|
|
866
|
+
#
|
|
867
|
+
# * **Associated**\: The repository association is complete.
|
|
868
|
+
#
|
|
869
|
+
# * **Associating**\: CodeGuru Reviewer is:
|
|
870
|
+
#
|
|
871
|
+
# * Setting up pull request notifications. This is required for pull
|
|
872
|
+
# requests to trigger a CodeGuru Reviewer review.
|
|
873
|
+
#
|
|
874
|
+
# <note markdown="1"> If your repository `ProviderType` is `GitHub`, `GitHub
|
|
875
|
+
# Enterprise Server`, or `Bitbucket`, CodeGuru Reviewer creates
|
|
876
|
+
# webhooks in your repository to trigger CodeGuru Reviewer
|
|
877
|
+
# reviews. If you delete these webhooks, reviews of code in your
|
|
878
|
+
# repository cannot be triggered.
|
|
879
|
+
#
|
|
880
|
+
# </note>
|
|
881
|
+
#
|
|
882
|
+
# * Setting up source code access. This is required for CodeGuru
|
|
883
|
+
# Reviewer to securely clone code in your repository.
|
|
884
|
+
#
|
|
885
|
+
# * **Failed**\: The repository failed to associate or disassociate.
|
|
886
|
+
#
|
|
887
|
+
# * **Disassociating**\: CodeGuru Reviewer is removing the
|
|
888
|
+
# repository's pull request notifications and source code access.
|
|
662
889
|
# @return [Array<String>]
|
|
663
890
|
#
|
|
664
891
|
# @!attribute [rw] names
|
|
@@ -666,10 +893,11 @@ module Aws::CodeGuruReviewer
|
|
|
666
893
|
# @return [Array<String>]
|
|
667
894
|
#
|
|
668
895
|
# @!attribute [rw] owners
|
|
669
|
-
# List of owners to use as a filter. For
|
|
670
|
-
#
|
|
671
|
-
#
|
|
672
|
-
#
|
|
896
|
+
# List of owners to use as a filter. For AWS CodeCommit, it is the
|
|
897
|
+
# name of the CodeCommit account that was used to associate the
|
|
898
|
+
# repository. For other repository source providers, such as Bitbucket
|
|
899
|
+
# and GitHub Enterprise Server, this is name of the account that was
|
|
900
|
+
# used to associate the repository.
|
|
673
901
|
# @return [Array<String>]
|
|
674
902
|
#
|
|
675
903
|
# @!attribute [rw] max_results
|
|
@@ -679,9 +907,9 @@ module Aws::CodeGuruReviewer
|
|
|
679
907
|
# `maxResults` results in a single page with a `nextToken` response
|
|
680
908
|
# element. The remaining results of the initial request can be seen by
|
|
681
909
|
# sending another `ListRepositoryAssociations` request with the
|
|
682
|
-
# returned `nextToken` value. This value can be between 1 and
|
|
910
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
|
683
911
|
# this parameter is not used, `ListRepositoryAssociations` returns up
|
|
684
|
-
# to
|
|
912
|
+
# to 100 results and a `nextToken` value if applicable.
|
|
685
913
|
# @return [Integer]
|
|
686
914
|
#
|
|
687
915
|
# @!attribute [rw] next_token
|
|
@@ -736,7 +964,18 @@ module Aws::CodeGuruReviewer
|
|
|
736
964
|
# Information about the statistics from the code review.
|
|
737
965
|
#
|
|
738
966
|
# @!attribute [rw] metered_lines_of_code_count
|
|
739
|
-
# Lines of code metered in the code review.
|
|
967
|
+
# Lines of code metered in the code review. For the initial code
|
|
968
|
+
# review pull request and all subsequent revisions, this includes all
|
|
969
|
+
# lines of code in the files added to the pull request. In subsequent
|
|
970
|
+
# revisions, for files that already existed in the pull request, this
|
|
971
|
+
# includes only the changed lines of code. In both cases, this does
|
|
972
|
+
# not include non-code lines such as comments and import statements.
|
|
973
|
+
# For example, if you submit a pull request containing 5 files, each
|
|
974
|
+
# with 500 lines of code, and in a subsequent revision you added a new
|
|
975
|
+
# file with 200 lines of code, and also modified a total of 25 lines
|
|
976
|
+
# across the initial 5 files, `MeteredLinesOfCodeCount` includes the
|
|
977
|
+
# first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and
|
|
978
|
+
# the 25 changed lines of code for a total of 2,725 lines of code.
|
|
740
979
|
# @return [Integer]
|
|
741
980
|
#
|
|
742
981
|
# @!attribute [rw] findings_count
|
|
@@ -755,7 +994,18 @@ module Aws::CodeGuruReviewer
|
|
|
755
994
|
# Information about metrics summaries.
|
|
756
995
|
#
|
|
757
996
|
# @!attribute [rw] metered_lines_of_code_count
|
|
758
|
-
# Lines of code metered in the code review.
|
|
997
|
+
# Lines of code metered in the code review. For the initial code
|
|
998
|
+
# review pull request and all subsequent revisions, this includes all
|
|
999
|
+
# lines of code in the files added to the pull request. In subsequent
|
|
1000
|
+
# revisions, for files that already existed in the pull request, this
|
|
1001
|
+
# includes only the changed lines of code. In both cases, this does
|
|
1002
|
+
# not include non-code lines such as comments and import statements.
|
|
1003
|
+
# For example, if you submit a pull request containing 5 files, each
|
|
1004
|
+
# with 500 lines of code, and in a subsequent revision you added a new
|
|
1005
|
+
# file with 200 lines of code, and also modified a total of 25 lines
|
|
1006
|
+
# across the initial 5 files, `MeteredLinesOfCodeCount` includes the
|
|
1007
|
+
# first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and
|
|
1008
|
+
# the 25 changed lines of code for a total of 2,725 lines of code.
|
|
759
1009
|
# @return [Integer]
|
|
760
1010
|
#
|
|
761
1011
|
# @!attribute [rw] findings_count
|
|
@@ -794,7 +1044,11 @@ module Aws::CodeGuruReviewer
|
|
|
794
1044
|
# }
|
|
795
1045
|
#
|
|
796
1046
|
# @!attribute [rw] code_review_arn
|
|
797
|
-
# The Amazon Resource Name (ARN)
|
|
1047
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
1048
|
+
#
|
|
1049
|
+
#
|
|
1050
|
+
#
|
|
1051
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
798
1052
|
# @return [String]
|
|
799
1053
|
#
|
|
800
1054
|
# @!attribute [rw] recommendation_id
|
|
@@ -824,7 +1078,11 @@ module Aws::CodeGuruReviewer
|
|
|
824
1078
|
# Information about the recommendation feedback.
|
|
825
1079
|
#
|
|
826
1080
|
# @!attribute [rw] code_review_arn
|
|
827
|
-
# The Amazon Resource Name (ARN)
|
|
1081
|
+
# The Amazon Resource Name (ARN) of the [ `CodeReview` ][1] object.
|
|
1082
|
+
#
|
|
1083
|
+
#
|
|
1084
|
+
#
|
|
1085
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html
|
|
828
1086
|
# @return [String]
|
|
829
1087
|
#
|
|
830
1088
|
# @!attribute [rw] recommendation_id
|
|
@@ -838,7 +1096,16 @@ module Aws::CodeGuruReviewer
|
|
|
838
1096
|
# @return [Array<String>]
|
|
839
1097
|
#
|
|
840
1098
|
# @!attribute [rw] user_id
|
|
841
|
-
# The user
|
|
1099
|
+
# The ID of the user that made the API call.
|
|
1100
|
+
#
|
|
1101
|
+
# The `UserId` is an IAM principal that can be specified as an AWS
|
|
1102
|
+
# account ID or an Amazon Resource Name (ARN). For more information,
|
|
1103
|
+
# see [ Specifying a Principal][1] in the *AWS Identity and Access
|
|
1104
|
+
# Management User Guide*.
|
|
1105
|
+
#
|
|
1106
|
+
#
|
|
1107
|
+
#
|
|
1108
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying
|
|
842
1109
|
# @return [String]
|
|
843
1110
|
#
|
|
844
1111
|
# @!attribute [rw] created_time_stamp
|
|
@@ -875,7 +1142,16 @@ module Aws::CodeGuruReviewer
|
|
|
875
1142
|
# @return [Array<String>]
|
|
876
1143
|
#
|
|
877
1144
|
# @!attribute [rw] user_id
|
|
878
|
-
# The
|
|
1145
|
+
# The ID of the user that gave the feedback.
|
|
1146
|
+
#
|
|
1147
|
+
# The `UserId` is an IAM principal that can be specified as an AWS
|
|
1148
|
+
# account ID or an Amazon Resource Name (ARN). For more information,
|
|
1149
|
+
# see [ Specifying a Principal][1] in the *AWS Identity and Access
|
|
1150
|
+
# Management User Guide*.
|
|
1151
|
+
#
|
|
1152
|
+
#
|
|
1153
|
+
#
|
|
1154
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying
|
|
879
1155
|
# @return [String]
|
|
880
1156
|
#
|
|
881
1157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/RecommendationFeedbackSummary AWS API Documentation
|
|
@@ -907,7 +1183,7 @@ module Aws::CodeGuruReviewer
|
|
|
907
1183
|
# @!attribute [rw] end_line
|
|
908
1184
|
# Last line where the recommendation is applicable in the source
|
|
909
1185
|
# commit or source branch. For a single line comment the start line
|
|
910
|
-
# and end line values
|
|
1186
|
+
# and end line values are the same.
|
|
911
1187
|
# @return [Integer]
|
|
912
1188
|
#
|
|
913
1189
|
# @!attribute [rw] description
|
|
@@ -927,7 +1203,10 @@ module Aws::CodeGuruReviewer
|
|
|
927
1203
|
include Aws::Structure
|
|
928
1204
|
end
|
|
929
1205
|
|
|
930
|
-
# Information about
|
|
1206
|
+
# Information about an associated AWS CodeCommit repository or an
|
|
1207
|
+
# associated repository that is managed by AWS CodeStar Connections (for
|
|
1208
|
+
# example, Bitbucket). This `Repository` object is not used if your
|
|
1209
|
+
# source code is in an associated GitHub repository.
|
|
931
1210
|
#
|
|
932
1211
|
# @note When making an API call, you may pass Repository
|
|
933
1212
|
# data as a hash:
|
|
@@ -941,6 +1220,11 @@ module Aws::CodeGuruReviewer
|
|
|
941
1220
|
# connection_arn: "ConnectionArn", # required
|
|
942
1221
|
# owner: "Owner", # required
|
|
943
1222
|
# },
|
|
1223
|
+
# git_hub_enterprise_server: {
|
|
1224
|
+
# name: "Name", # required
|
|
1225
|
+
# connection_arn: "ConnectionArn", # required
|
|
1226
|
+
# owner: "Owner", # required
|
|
1227
|
+
# },
|
|
944
1228
|
# }
|
|
945
1229
|
#
|
|
946
1230
|
# @!attribute [rw] code_commit
|
|
@@ -948,19 +1232,64 @@ module Aws::CodeGuruReviewer
|
|
|
948
1232
|
# @return [Types::CodeCommitRepository]
|
|
949
1233
|
#
|
|
950
1234
|
# @!attribute [rw] bitbucket
|
|
951
|
-
# Information about a Bitbucket
|
|
1235
|
+
# Information about a Bitbucket repository.
|
|
1236
|
+
# @return [Types::ThirdPartySourceRepository]
|
|
1237
|
+
#
|
|
1238
|
+
# @!attribute [rw] git_hub_enterprise_server
|
|
1239
|
+
# Information about a GitHub Enterprise Server repository.
|
|
952
1240
|
# @return [Types::ThirdPartySourceRepository]
|
|
953
1241
|
#
|
|
954
1242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/Repository AWS API Documentation
|
|
955
1243
|
#
|
|
956
1244
|
class Repository < Struct.new(
|
|
957
1245
|
:code_commit,
|
|
958
|
-
:bitbucket
|
|
1246
|
+
:bitbucket,
|
|
1247
|
+
:git_hub_enterprise_server)
|
|
1248
|
+
SENSITIVE = []
|
|
1249
|
+
include Aws::Structure
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1252
|
+
# A code review type that analyzes all code under a specified branch in
|
|
1253
|
+
# an associated respository. The assocated repository is specified using
|
|
1254
|
+
# its ARN when you call [ `CreateCodeReview` ][1].
|
|
1255
|
+
#
|
|
1256
|
+
#
|
|
1257
|
+
#
|
|
1258
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview
|
|
1259
|
+
#
|
|
1260
|
+
# @note When making an API call, you may pass RepositoryAnalysis
|
|
1261
|
+
# data as a hash:
|
|
1262
|
+
#
|
|
1263
|
+
# {
|
|
1264
|
+
# repository_head: { # required
|
|
1265
|
+
# branch_name: "BranchName", # required
|
|
1266
|
+
# },
|
|
1267
|
+
# }
|
|
1268
|
+
#
|
|
1269
|
+
# @!attribute [rw] repository_head
|
|
1270
|
+
# A [ `SourceCodeType` ][1] that specifies the tip of a branch in an
|
|
1271
|
+
# associated repository.
|
|
1272
|
+
#
|
|
1273
|
+
#
|
|
1274
|
+
#
|
|
1275
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType
|
|
1276
|
+
# @return [Types::RepositoryHeadSourceCodeType]
|
|
1277
|
+
#
|
|
1278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/RepositoryAnalysis AWS API Documentation
|
|
1279
|
+
#
|
|
1280
|
+
class RepositoryAnalysis < Struct.new(
|
|
1281
|
+
:repository_head)
|
|
959
1282
|
SENSITIVE = []
|
|
960
1283
|
include Aws::Structure
|
|
961
1284
|
end
|
|
962
1285
|
|
|
963
|
-
# Information about a repository association.
|
|
1286
|
+
# Information about a repository association. The [
|
|
1287
|
+
# `DescribeRepositoryAssociation` ][1] operation returns a
|
|
1288
|
+
# `RepositoryAssociation` object.
|
|
1289
|
+
#
|
|
1290
|
+
#
|
|
1291
|
+
#
|
|
1292
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html
|
|
964
1293
|
#
|
|
965
1294
|
# @!attribute [rw] association_id
|
|
966
1295
|
# The ID of the repository association.
|
|
@@ -972,8 +1301,15 @@ module Aws::CodeGuruReviewer
|
|
|
972
1301
|
# @return [String]
|
|
973
1302
|
#
|
|
974
1303
|
# @!attribute [rw] connection_arn
|
|
975
|
-
# The Amazon Resource Name (ARN)
|
|
976
|
-
# connection.
|
|
1304
|
+
# The Amazon Resource Name (ARN) of an AWS CodeStar Connections
|
|
1305
|
+
# connection. Its format is
|
|
1306
|
+
# `arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id`.
|
|
1307
|
+
# For more information, see [ `Connection` ][1] in the *AWS CodeStar
|
|
1308
|
+
# Connections API Reference*.
|
|
1309
|
+
#
|
|
1310
|
+
#
|
|
1311
|
+
#
|
|
1312
|
+
# [1]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html
|
|
977
1313
|
# @return [String]
|
|
978
1314
|
#
|
|
979
1315
|
# @!attribute [rw] name
|
|
@@ -981,7 +1317,10 @@ module Aws::CodeGuruReviewer
|
|
|
981
1317
|
# @return [String]
|
|
982
1318
|
#
|
|
983
1319
|
# @!attribute [rw] owner
|
|
984
|
-
# The owner of the repository.
|
|
1320
|
+
# The owner of the repository. For an AWS CodeCommit repository, this
|
|
1321
|
+
# is the AWS account ID of the account that owns the repository. For a
|
|
1322
|
+
# GitHub, GitHub Enterprise Server, or Bitbucket repository, this is
|
|
1323
|
+
# the username for the account that owns the repository.
|
|
985
1324
|
# @return [String]
|
|
986
1325
|
#
|
|
987
1326
|
# @!attribute [rw] provider_type
|
|
@@ -990,6 +1329,31 @@ module Aws::CodeGuruReviewer
|
|
|
990
1329
|
#
|
|
991
1330
|
# @!attribute [rw] state
|
|
992
1331
|
# The state of the repository association.
|
|
1332
|
+
#
|
|
1333
|
+
# The valid repository association states are:
|
|
1334
|
+
#
|
|
1335
|
+
# * **Associated**\: The repository association is complete.
|
|
1336
|
+
#
|
|
1337
|
+
# * **Associating**\: CodeGuru Reviewer is:
|
|
1338
|
+
#
|
|
1339
|
+
# * Setting up pull request notifications. This is required for pull
|
|
1340
|
+
# requests to trigger a CodeGuru Reviewer review.
|
|
1341
|
+
#
|
|
1342
|
+
# <note markdown="1"> If your repository `ProviderType` is `GitHub`, `GitHub
|
|
1343
|
+
# Enterprise Server`, or `Bitbucket`, CodeGuru Reviewer creates
|
|
1344
|
+
# webhooks in your repository to trigger CodeGuru Reviewer
|
|
1345
|
+
# reviews. If you delete these webhooks, reviews of code in your
|
|
1346
|
+
# repository cannot be triggered.
|
|
1347
|
+
#
|
|
1348
|
+
# </note>
|
|
1349
|
+
#
|
|
1350
|
+
# * Setting up source code access. This is required for CodeGuru
|
|
1351
|
+
# Reviewer to securely clone code in your repository.
|
|
1352
|
+
#
|
|
1353
|
+
# * **Failed**\: The repository failed to associate or disassociate.
|
|
1354
|
+
#
|
|
1355
|
+
# * **Disassociating**\: CodeGuru Reviewer is removing the
|
|
1356
|
+
# repository's pull request notifications and source code access.
|
|
993
1357
|
# @return [String]
|
|
994
1358
|
#
|
|
995
1359
|
# @!attribute [rw] state_reason
|
|
@@ -1024,16 +1388,33 @@ module Aws::CodeGuruReviewer
|
|
|
1024
1388
|
include Aws::Structure
|
|
1025
1389
|
end
|
|
1026
1390
|
|
|
1027
|
-
#
|
|
1391
|
+
# Summary information about a repository association. The [
|
|
1392
|
+
# `ListRepositoryAssociations` ][1] operation returns a list of
|
|
1393
|
+
# `RepositoryAssociationSummary` objects.
|
|
1394
|
+
#
|
|
1395
|
+
#
|
|
1396
|
+
#
|
|
1397
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html
|
|
1028
1398
|
#
|
|
1029
1399
|
# @!attribute [rw] association_arn
|
|
1030
|
-
# The Amazon Resource Name (ARN)
|
|
1031
|
-
#
|
|
1400
|
+
# The Amazon Resource Name (ARN) of the [ `RepositoryAssociation` ][1]
|
|
1401
|
+
# object. You can retrieve this ARN by calling `ListRepositories`.
|
|
1402
|
+
#
|
|
1403
|
+
#
|
|
1404
|
+
#
|
|
1405
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html
|
|
1032
1406
|
# @return [String]
|
|
1033
1407
|
#
|
|
1034
1408
|
# @!attribute [rw] connection_arn
|
|
1035
|
-
# The Amazon Resource Name (ARN)
|
|
1036
|
-
# connection.
|
|
1409
|
+
# The Amazon Resource Name (ARN) of an AWS CodeStar Connections
|
|
1410
|
+
# connection. Its format is
|
|
1411
|
+
# `arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id`.
|
|
1412
|
+
# For more information, see [ `Connection` ][1] in the *AWS CodeStar
|
|
1413
|
+
# Connections API Reference*.
|
|
1414
|
+
#
|
|
1415
|
+
#
|
|
1416
|
+
#
|
|
1417
|
+
# [1]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html
|
|
1037
1418
|
# @return [String]
|
|
1038
1419
|
#
|
|
1039
1420
|
# @!attribute [rw] last_updated_time_stamp
|
|
@@ -1050,7 +1431,10 @@ module Aws::CodeGuruReviewer
|
|
|
1050
1431
|
# @return [String]
|
|
1051
1432
|
#
|
|
1052
1433
|
# @!attribute [rw] owner
|
|
1053
|
-
# The owner of the repository
|
|
1434
|
+
# The owner of the repository. For an AWS CodeCommit repository, this
|
|
1435
|
+
# is the AWS account ID of the account that owns the repository. For a
|
|
1436
|
+
# GitHub, GitHub Enterprise Server, or Bitbucket repository, this is
|
|
1437
|
+
# the username for the account that owns the repository.
|
|
1054
1438
|
# @return [String]
|
|
1055
1439
|
#
|
|
1056
1440
|
# @!attribute [rw] provider_type
|
|
@@ -1060,22 +1444,30 @@ module Aws::CodeGuruReviewer
|
|
|
1060
1444
|
# @!attribute [rw] state
|
|
1061
1445
|
# The state of the repository association.
|
|
1062
1446
|
#
|
|
1063
|
-
#
|
|
1447
|
+
# The valid repository association states are:
|
|
1448
|
+
#
|
|
1449
|
+
# * **Associated**\: The repository association is complete.
|
|
1064
1450
|
#
|
|
1065
|
-
#
|
|
1451
|
+
# * **Associating**\: CodeGuru Reviewer is:
|
|
1066
1452
|
#
|
|
1067
|
-
#
|
|
1453
|
+
# * Setting up pull request notifications. This is required for pull
|
|
1454
|
+
# requests to trigger a CodeGuru Reviewer review.
|
|
1068
1455
|
#
|
|
1069
|
-
#
|
|
1456
|
+
# <note markdown="1"> If your repository `ProviderType` is `GitHub`, `GitHub
|
|
1457
|
+
# Enterprise Server`, or `Bitbucket`, CodeGuru Reviewer creates
|
|
1458
|
+
# webhooks in your repository to trigger CodeGuru Reviewer
|
|
1459
|
+
# reviews. If you delete these webhooks, reviews of code in your
|
|
1460
|
+
# repository cannot be triggered.
|
|
1070
1461
|
#
|
|
1071
|
-
#
|
|
1462
|
+
# </note>
|
|
1072
1463
|
#
|
|
1073
|
-
#
|
|
1464
|
+
# * Setting up source code access. This is required for CodeGuru
|
|
1465
|
+
# Reviewer to securely clone code in your repository.
|
|
1074
1466
|
#
|
|
1075
|
-
#
|
|
1467
|
+
# * **Failed**\: The repository failed to associate or disassociate.
|
|
1076
1468
|
#
|
|
1077
|
-
#
|
|
1078
|
-
#
|
|
1469
|
+
# * **Disassociating**\: CodeGuru Reviewer is removing the
|
|
1470
|
+
# repository's pull request notifications and source code access.
|
|
1079
1471
|
# @return [String]
|
|
1080
1472
|
#
|
|
1081
1473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/RepositoryAssociationSummary AWS API Documentation
|
|
@@ -1093,6 +1485,33 @@ module Aws::CodeGuruReviewer
|
|
|
1093
1485
|
include Aws::Structure
|
|
1094
1486
|
end
|
|
1095
1487
|
|
|
1488
|
+
# A [ `SourceCodeType` ][1] that specifies the tip of a branch in an
|
|
1489
|
+
# associated repository.
|
|
1490
|
+
#
|
|
1491
|
+
#
|
|
1492
|
+
#
|
|
1493
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType
|
|
1494
|
+
#
|
|
1495
|
+
# @note When making an API call, you may pass RepositoryHeadSourceCodeType
|
|
1496
|
+
# data as a hash:
|
|
1497
|
+
#
|
|
1498
|
+
# {
|
|
1499
|
+
# branch_name: "BranchName", # required
|
|
1500
|
+
# }
|
|
1501
|
+
#
|
|
1502
|
+
# @!attribute [rw] branch_name
|
|
1503
|
+
# The name of the branch in an associated repository. The
|
|
1504
|
+
# `RepositoryHeadSourceCodeType` specifies the tip of this branch.
|
|
1505
|
+
# @return [String]
|
|
1506
|
+
#
|
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/RepositoryHeadSourceCodeType AWS API Documentation
|
|
1508
|
+
#
|
|
1509
|
+
class RepositoryHeadSourceCodeType < Struct.new(
|
|
1510
|
+
:branch_name)
|
|
1511
|
+
SENSITIVE = []
|
|
1512
|
+
include Aws::Structure
|
|
1513
|
+
end
|
|
1514
|
+
|
|
1096
1515
|
# The resource specified in the request was not found.
|
|
1097
1516
|
#
|
|
1098
1517
|
# @!attribute [rw] message
|
|
@@ -1106,22 +1525,39 @@ module Aws::CodeGuruReviewer
|
|
|
1106
1525
|
include Aws::Structure
|
|
1107
1526
|
end
|
|
1108
1527
|
|
|
1109
|
-
#
|
|
1528
|
+
# Specifies the source code that is analyzed in a code review. A code
|
|
1529
|
+
# review can analyze the source code that is specified using a pull
|
|
1530
|
+
# request diff or a branch in an associated repository.
|
|
1110
1531
|
#
|
|
1111
1532
|
# @!attribute [rw] commit_diff
|
|
1112
|
-
#
|
|
1533
|
+
# A [ `SourceCodeType` ][1] that specifies a commit diff created by a
|
|
1534
|
+
# pull request on an associated repository.
|
|
1535
|
+
#
|
|
1536
|
+
#
|
|
1537
|
+
#
|
|
1538
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType
|
|
1113
1539
|
# @return [Types::CommitDiffSourceCodeType]
|
|
1114
1540
|
#
|
|
1541
|
+
# @!attribute [rw] repository_head
|
|
1542
|
+
# A [ `SourceCodeType` ][1] that specifies the tip of a branch in an
|
|
1543
|
+
# associated repository.
|
|
1544
|
+
#
|
|
1545
|
+
#
|
|
1546
|
+
#
|
|
1547
|
+
# [1]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType
|
|
1548
|
+
# @return [Types::RepositoryHeadSourceCodeType]
|
|
1549
|
+
#
|
|
1115
1550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/SourceCodeType AWS API Documentation
|
|
1116
1551
|
#
|
|
1117
1552
|
class SourceCodeType < Struct.new(
|
|
1118
|
-
:commit_diff
|
|
1553
|
+
:commit_diff,
|
|
1554
|
+
:repository_head)
|
|
1119
1555
|
SENSITIVE = []
|
|
1120
1556
|
include Aws::Structure
|
|
1121
1557
|
end
|
|
1122
1558
|
|
|
1123
|
-
# Information about a third
|
|
1124
|
-
#
|
|
1559
|
+
# Information about a third-party source repository connected to
|
|
1560
|
+
# CodeGuru Reviewer.
|
|
1125
1561
|
#
|
|
1126
1562
|
# @note When making an API call, you may pass ThirdPartySourceRepository
|
|
1127
1563
|
# data as a hash:
|
|
@@ -1137,12 +1573,21 @@ module Aws::CodeGuruReviewer
|
|
|
1137
1573
|
# @return [String]
|
|
1138
1574
|
#
|
|
1139
1575
|
# @!attribute [rw] connection_arn
|
|
1140
|
-
# The Amazon Resource Name (ARN)
|
|
1141
|
-
# connection.
|
|
1576
|
+
# The Amazon Resource Name (ARN) of an AWS CodeStar Connections
|
|
1577
|
+
# connection. Its format is
|
|
1578
|
+
# `arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id`.
|
|
1579
|
+
# For more information, see [ `Connection` ][1] in the *AWS CodeStar
|
|
1580
|
+
# Connections API Reference*.
|
|
1581
|
+
#
|
|
1582
|
+
#
|
|
1583
|
+
#
|
|
1584
|
+
# [1]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html
|
|
1142
1585
|
# @return [String]
|
|
1143
1586
|
#
|
|
1144
1587
|
# @!attribute [rw] owner
|
|
1145
|
-
# The
|
|
1588
|
+
# The owner of the repository. For a GitHub, GitHub Enterprise, or
|
|
1589
|
+
# Bitbucket repository, this is the username for the account that owns
|
|
1590
|
+
# the repository.
|
|
1146
1591
|
# @return [String]
|
|
1147
1592
|
#
|
|
1148
1593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19/ThirdPartySourceRepository AWS API Documentation
|