@aws-sdk/client-codeguru-reviewer 3.162.0 → 3.163.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.
- package/CHANGELOG.md +8 -0
- package/README.md +13 -12
- package/dist-types/CodeGuruReviewer.d.ts +43 -79
- package/dist-types/CodeGuruReviewerClient.d.ts +13 -12
- package/dist-types/commands/AssociateRepositoryCommand.d.ts +14 -16
- package/dist-types/commands/CreateCodeReviewCommand.d.ts +4 -7
- package/dist-types/commands/DescribeCodeReviewCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecommendationFeedbackCommand.d.ts +1 -3
- package/dist-types/commands/DescribeRepositoryAssociationCommand.d.ts +2 -6
- package/dist-types/commands/ListCodeReviewsCommand.d.ts +1 -3
- package/dist-types/commands/ListRecommendationFeedbackCommand.d.ts +2 -7
- package/dist-types/commands/ListRecommendationsCommand.d.ts +1 -3
- package/dist-types/commands/ListRepositoryAssociationsCommand.d.ts +2 -18
- package/dist-types/commands/PutRecommendationFeedbackCommand.d.ts +2 -3
- package/dist-types/models/models_0.d.ts +344 -728
- package/package.json +6 -6
|
@@ -25,91 +25,76 @@ export declare enum EncryptionOption {
|
|
|
25
25
|
* <ul>
|
|
26
26
|
* <li>
|
|
27
27
|
* <p>The encryption option for a repository association. It is either owned by Amazon Web Services
|
|
28
|
-
*
|
|
28
|
+
* Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed
|
|
29
|
+
* (<code>CUSTOMER_MANAGED_CMK</code>).</p>
|
|
29
30
|
* </li>
|
|
30
31
|
* <li>
|
|
31
|
-
* <p>The ID of the Amazon Web Services KMS key that
|
|
32
|
-
*
|
|
32
|
+
* <p>The ID of the Amazon Web Services KMS key that is associated with a repository
|
|
33
|
+
* association.</p>
|
|
33
34
|
* </li>
|
|
34
35
|
* </ul>
|
|
35
36
|
*/
|
|
36
37
|
export interface KMSKeyDetails {
|
|
37
38
|
/**
|
|
38
|
-
* <p>The ID of the Amazon Web Services KMS key that is associated with a
|
|
39
|
+
* <p>The ID of the Amazon Web Services KMS key that is associated with a repository association.</p>
|
|
39
40
|
*/
|
|
40
41
|
KMSKeyId?: string;
|
|
41
42
|
/**
|
|
42
|
-
* <p>The encryption option for a repository association. It is either owned by Amazon Web Services
|
|
43
|
-
*
|
|
43
|
+
* <p>The encryption option for a repository association. It is either owned by Amazon Web Services Key
|
|
44
|
+
* Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed
|
|
45
|
+
* (<code>CUSTOMER_MANAGED_CMK</code>).</p>
|
|
44
46
|
*/
|
|
45
47
|
EncryptionOption?: EncryptionOption | string;
|
|
46
48
|
}
|
|
47
49
|
/**
|
|
48
|
-
* <p>
|
|
49
|
-
* Information about a third-party source repository connected to CodeGuru Reviewer.
|
|
50
|
-
* </p>
|
|
50
|
+
* <p>Information about a third-party source repository connected to CodeGuru Reviewer.</p>
|
|
51
51
|
*/
|
|
52
52
|
export interface ThirdPartySourceRepository {
|
|
53
53
|
/**
|
|
54
|
-
* <p>
|
|
55
|
-
* The name of the third party source repository.
|
|
56
|
-
* </p>
|
|
54
|
+
* <p>The name of the third party source repository.</p>
|
|
57
55
|
*/
|
|
58
56
|
Name: string | undefined;
|
|
59
57
|
/**
|
|
60
|
-
* <p>
|
|
61
|
-
* The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is
|
|
62
|
-
* <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see
|
|
63
|
-
* <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">
|
|
64
|
-
* <code>Connection</code>
|
|
65
|
-
* </a> in
|
|
66
|
-
* the <i>Amazon Web Services CodeStar Connections API Reference</i>.
|
|
67
|
-
* </p>
|
|
58
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.</p>
|
|
68
59
|
*/
|
|
69
60
|
ConnectionArn: string | undefined;
|
|
70
61
|
/**
|
|
71
|
-
* <p>
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* this can be the username or Amazon Web Services account ID.
|
|
75
|
-
* </p>
|
|
62
|
+
* <p>The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository,
|
|
63
|
+
* this is the username for the account that owns the repository. For an S3 repository, this
|
|
64
|
+
* can be the username or Amazon Web Services account ID </p>
|
|
76
65
|
*/
|
|
77
66
|
Owner: string | undefined;
|
|
78
67
|
}
|
|
79
68
|
/**
|
|
80
|
-
* <p>Information about an Amazon Web Services CodeCommit repository. The CodeCommit repository must be in
|
|
81
|
-
*
|
|
69
|
+
* <p>Information about an Amazon Web Services CodeCommit repository. The CodeCommit repository must be in
|
|
70
|
+
* the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are
|
|
71
|
+
* configured.</p>
|
|
82
72
|
*/
|
|
83
73
|
export interface CodeCommitRepository {
|
|
84
74
|
/**
|
|
85
|
-
* <p>The name of the Amazon Web Services CodeCommit repository. For more information, see
|
|
86
|
-
*
|
|
87
|
-
* in the <i>Amazon Web Services CodeCommit API Reference</i>.</p>
|
|
75
|
+
* <p>The name of the Amazon Web Services CodeCommit repository. For more information, see <a href="https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName">repositoryName</a> in the <i>Amazon Web Services CodeCommit API
|
|
76
|
+
* Reference</i>.</p>
|
|
88
77
|
*/
|
|
89
78
|
Name: string | undefined;
|
|
90
79
|
}
|
|
91
80
|
/**
|
|
92
|
-
* <p>
|
|
93
|
-
* Information about a repository in an S3 bucket.
|
|
94
|
-
* </p>
|
|
81
|
+
* <p>Information about a repository in an S3 bucket.</p>
|
|
95
82
|
*/
|
|
96
83
|
export interface S3Repository {
|
|
97
84
|
/**
|
|
98
|
-
* <p>
|
|
85
|
+
* <p>The name of the repository in the S3 bucket.</p>
|
|
99
86
|
*/
|
|
100
87
|
Name: string | undefined;
|
|
101
88
|
/**
|
|
102
|
-
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with
|
|
103
|
-
* <code>codeguru-reviewer-</code>. </p>
|
|
89
|
+
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with <code>codeguru-reviewer-</code>. </p>
|
|
104
90
|
*/
|
|
105
91
|
BucketName: string | undefined;
|
|
106
92
|
}
|
|
107
93
|
/**
|
|
108
|
-
* <p>
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
* </p>
|
|
94
|
+
* <p>Information about an associated Amazon Web Services CodeCommit repository or an associated repository
|
|
95
|
+
* that is managed by Amazon Web Services CodeStar Connections (for example, Bitbucket). This
|
|
96
|
+
* <code>Repository</code> object is not used if your source code is in an associated
|
|
97
|
+
* GitHub repository.</p>
|
|
113
98
|
*/
|
|
114
99
|
export interface Repository {
|
|
115
100
|
/**
|
|
@@ -117,21 +102,15 @@ export interface Repository {
|
|
|
117
102
|
*/
|
|
118
103
|
CodeCommit?: CodeCommitRepository;
|
|
119
104
|
/**
|
|
120
|
-
* <p>
|
|
121
|
-
* Information about a Bitbucket repository.
|
|
122
|
-
* </p>
|
|
105
|
+
* <p> Information about a Bitbucket repository. </p>
|
|
123
106
|
*/
|
|
124
107
|
Bitbucket?: ThirdPartySourceRepository;
|
|
125
108
|
/**
|
|
126
|
-
* <p>
|
|
127
|
-
* Information about a GitHub Enterprise Server repository.
|
|
128
|
-
* </p>
|
|
109
|
+
* <p>Information about a GitHub Enterprise Server repository.</p>
|
|
129
110
|
*/
|
|
130
111
|
GitHubEnterpriseServer?: ThirdPartySourceRepository;
|
|
131
112
|
/**
|
|
132
|
-
* <p>
|
|
133
|
-
* Information about a repository in an S3 bucket.
|
|
134
|
-
* </p>
|
|
113
|
+
* <p>Information about a repository in an S3 bucket.</p>
|
|
135
114
|
*/
|
|
136
115
|
S3Bucket?: S3Repository;
|
|
137
116
|
}
|
|
@@ -142,13 +121,11 @@ export interface AssociateRepositoryRequest {
|
|
|
142
121
|
Repository: Repository | undefined;
|
|
143
122
|
/**
|
|
144
123
|
* <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository
|
|
145
|
-
*
|
|
124
|
+
* associations if there are failures and retries.</p>
|
|
146
125
|
*/
|
|
147
126
|
ClientRequestToken?: string;
|
|
148
127
|
/**
|
|
149
|
-
* <p>
|
|
150
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
151
|
-
* </p>
|
|
128
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
152
129
|
* <ul>
|
|
153
130
|
* <li>
|
|
154
131
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -169,11 +146,12 @@ export interface AssociateRepositoryRequest {
|
|
|
169
146
|
* <ul>
|
|
170
147
|
* <li>
|
|
171
148
|
* <p>The encryption option for this repository association. It is either owned by Amazon Web Services
|
|
172
|
-
*
|
|
149
|
+
* Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed
|
|
150
|
+
* (<code>CUSTOMER_MANAGED_CMK</code>).</p>
|
|
173
151
|
* </li>
|
|
174
152
|
* <li>
|
|
175
|
-
* <p>The ID of the Amazon Web Services KMS key that
|
|
176
|
-
*
|
|
153
|
+
* <p>The ID of the Amazon Web Services KMS key that is associated with this repository
|
|
154
|
+
* association.</p>
|
|
177
155
|
* </li>
|
|
178
156
|
* </ul>
|
|
179
157
|
*/
|
|
@@ -187,47 +165,47 @@ export declare enum ProviderType {
|
|
|
187
165
|
S3_BUCKET = "S3Bucket"
|
|
188
166
|
}
|
|
189
167
|
/**
|
|
190
|
-
* <p>Code artifacts are source code artifacts and build artifacts used in a repository
|
|
168
|
+
* <p>Code artifacts are source code artifacts and build artifacts used in a repository
|
|
169
|
+
* analysis or a pull request review.</p>
|
|
191
170
|
* <ul>
|
|
192
171
|
* <li>
|
|
193
172
|
* <p>Source code artifacts are source code files in a Git repository that are
|
|
194
|
-
*
|
|
173
|
+
* compressed into a .zip file.</p>
|
|
195
174
|
* </li>
|
|
196
175
|
* <li>
|
|
197
|
-
* <p>Build artifacts are .jar or .class files that are compressed in a .zip
|
|
176
|
+
* <p>Build artifacts are .jar or .class files that are compressed in a .zip
|
|
177
|
+
* file.</p>
|
|
198
178
|
* </li>
|
|
199
179
|
* </ul>
|
|
200
180
|
*/
|
|
201
181
|
export interface CodeArtifacts {
|
|
202
182
|
/**
|
|
203
|
-
* <p>The S3 object key for a source code .zip file. This is required for all code
|
|
183
|
+
* <p>The S3 object key for a source code .zip file. This is required for all code
|
|
184
|
+
* reviews.</p>
|
|
204
185
|
*/
|
|
205
186
|
SourceCodeArtifactsObjectKey: string | undefined;
|
|
206
187
|
/**
|
|
207
|
-
* <p>The S3 object key for a build artifacts .zip file that
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
188
|
+
* <p>The S3 object key for a build artifacts .zip file that contains .jar or .class files.
|
|
189
|
+
* This is required for a code review with security analysis. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/code-review-security.html">Create
|
|
190
|
+
* code reviews with security analysis</a> in the <i>Amazon CodeGuru Reviewer User
|
|
191
|
+
* Guide</i>.</p>
|
|
211
192
|
*/
|
|
212
193
|
BuildArtifactsObjectKey?: string;
|
|
213
194
|
}
|
|
214
195
|
/**
|
|
215
|
-
* <p>
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
* </p>
|
|
196
|
+
* <p>Specifies the name of an S3 bucket and a <code>CodeArtifacts</code> object that contains
|
|
197
|
+
* the S3 object keys for a source code .zip file and for a build artifacts .zip file that
|
|
198
|
+
* contains .jar or .class files.</p>
|
|
219
199
|
*/
|
|
220
200
|
export interface S3RepositoryDetails {
|
|
221
201
|
/**
|
|
222
|
-
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with
|
|
223
|
-
* <code>codeguru-reviewer-</code>. </p>
|
|
202
|
+
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with <code>codeguru-reviewer-</code>. </p>
|
|
224
203
|
*/
|
|
225
204
|
BucketName?: string;
|
|
226
205
|
/**
|
|
227
|
-
* <p>
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
* </p>
|
|
206
|
+
* <p>A <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> object includes the
|
|
207
|
+
* S3 object key for a source code .zip file and for a build artifacts .zip file that contains
|
|
208
|
+
* .jar or .class files.</p>
|
|
231
209
|
*/
|
|
232
210
|
CodeArtifacts?: CodeArtifacts;
|
|
233
211
|
}
|
|
@@ -239,11 +217,8 @@ export declare enum RepositoryAssociationState {
|
|
|
239
217
|
FAILED = "Failed"
|
|
240
218
|
}
|
|
241
219
|
/**
|
|
242
|
-
* <p>Information about a repository association. The
|
|
243
|
-
*
|
|
244
|
-
* <code>DescribeRepositoryAssociation</code>
|
|
245
|
-
* </a>
|
|
246
|
-
* operation returns a <code>RepositoryAssociation</code> object.</p>
|
|
220
|
+
* <p>Information about a repository association. The <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html">DescribeRepositoryAssociation</a> operation returns a
|
|
221
|
+
* <code>RepositoryAssociation</code> object.</p>
|
|
247
222
|
*/
|
|
248
223
|
export interface RepositoryAssociation {
|
|
249
224
|
/**
|
|
@@ -255,14 +230,7 @@ export interface RepositoryAssociation {
|
|
|
255
230
|
*/
|
|
256
231
|
AssociationArn?: string;
|
|
257
232
|
/**
|
|
258
|
-
* <p>
|
|
259
|
-
* The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is
|
|
260
|
-
* <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see
|
|
261
|
-
* <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">
|
|
262
|
-
* <code>Connection</code>
|
|
263
|
-
* </a> in
|
|
264
|
-
* the <i>Amazon Web Services CodeStar Connections API Reference</i>.
|
|
265
|
-
* </p>
|
|
233
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.</p>
|
|
266
234
|
*/
|
|
267
235
|
ConnectionArn?: string;
|
|
268
236
|
/**
|
|
@@ -285,54 +253,35 @@ export interface RepositoryAssociation {
|
|
|
285
253
|
* <ul>
|
|
286
254
|
* <li>
|
|
287
255
|
* <p>
|
|
288
|
-
* <b>Associated</b>: The repository
|
|
289
|
-
* association is complete.
|
|
290
|
-
* </p>
|
|
256
|
+
* <b>Associated</b>: The repository association is complete.</p>
|
|
291
257
|
* </li>
|
|
292
258
|
* <li>
|
|
293
259
|
* <p>
|
|
294
|
-
* <b>Associating</b>: CodeGuru Reviewer is
|
|
295
|
-
* </p>
|
|
260
|
+
* <b>Associating</b>: CodeGuru Reviewer is:</p>
|
|
296
261
|
* <ul>
|
|
297
262
|
* <li>
|
|
298
|
-
* <p>
|
|
299
|
-
*
|
|
300
|
-
* for pull requests to trigger a CodeGuru Reviewer review.
|
|
301
|
-
* </p>
|
|
263
|
+
* <p>Setting up pull request notifications. This is required
|
|
264
|
+
* for pull requests to trigger a CodeGuru Reviewer review.</p>
|
|
302
265
|
* <note>
|
|
303
|
-
* <p>
|
|
304
|
-
* If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>,
|
|
305
|
-
* CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks,
|
|
306
|
-
* reviews of code in your repository cannot be triggered.
|
|
307
|
-
* </p>
|
|
266
|
+
* <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p>
|
|
308
267
|
* </note>
|
|
309
268
|
* </li>
|
|
310
269
|
* <li>
|
|
311
|
-
* <p>
|
|
312
|
-
* Setting up source code access. This is required for CodeGuru Reviewer to securely
|
|
313
|
-
* clone code in your repository.
|
|
314
|
-
* </p>
|
|
270
|
+
* <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p>
|
|
315
271
|
* </li>
|
|
316
272
|
* </ul>
|
|
317
273
|
* </li>
|
|
318
274
|
* <li>
|
|
319
275
|
* <p>
|
|
320
|
-
* <b>Failed</b>: The repository failed to associate or disassociate
|
|
321
|
-
* </p>
|
|
276
|
+
* <b>Failed</b>: The repository failed to associate or disassociate.</p>
|
|
322
277
|
* </li>
|
|
323
278
|
* <li>
|
|
324
279
|
* <p>
|
|
325
|
-
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and
|
|
326
|
-
* source code access.
|
|
327
|
-
* </p>
|
|
280
|
+
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.</p>
|
|
328
281
|
* </li>
|
|
329
282
|
* <li>
|
|
330
283
|
* <p>
|
|
331
|
-
* <b>Disassociated</b>: CodeGuru Reviewer successfully disassociated the repository. You can create a new association
|
|
332
|
-
* with this repository if you want to review source code in it later. You can control access to code reviews created in an
|
|
333
|
-
* associated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to
|
|
334
|
-
* associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
|
|
335
|
-
* </p>
|
|
284
|
+
* <b>Disassociated</b>: 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 anassociated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p>
|
|
336
285
|
* </li>
|
|
337
286
|
* </ul>
|
|
338
287
|
*/
|
|
@@ -342,11 +291,13 @@ export interface RepositoryAssociation {
|
|
|
342
291
|
*/
|
|
343
292
|
StateReason?: string;
|
|
344
293
|
/**
|
|
345
|
-
* <p>The time, in milliseconds since the epoch, when the repository association was last
|
|
294
|
+
* <p>The time, in milliseconds since the epoch, when the repository association was last
|
|
295
|
+
* updated.</p>
|
|
346
296
|
*/
|
|
347
297
|
LastUpdatedTimeStamp?: Date;
|
|
348
298
|
/**
|
|
349
|
-
* <p>The time, in milliseconds since the epoch, when the repository association was
|
|
299
|
+
* <p>The time, in milliseconds since the epoch, when the repository association was
|
|
300
|
+
* created.</p>
|
|
350
301
|
*/
|
|
351
302
|
CreatedTimeStamp?: Date;
|
|
352
303
|
/**
|
|
@@ -354,20 +305,20 @@ export interface RepositoryAssociation {
|
|
|
354
305
|
* <ul>
|
|
355
306
|
* <li>
|
|
356
307
|
* <p>The encryption option for this repository association. It is either owned by Amazon Web Services
|
|
357
|
-
*
|
|
308
|
+
* Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed
|
|
309
|
+
* (<code>CUSTOMER_MANAGED_CMK</code>).</p>
|
|
358
310
|
* </li>
|
|
359
311
|
* <li>
|
|
360
|
-
* <p>The ID of the Amazon Web Services KMS key that
|
|
361
|
-
*
|
|
312
|
+
* <p>The ID of the Amazon Web Services KMS key that is associated with this repository
|
|
313
|
+
* association.</p>
|
|
362
314
|
* </li>
|
|
363
315
|
* </ul>
|
|
364
316
|
*/
|
|
365
317
|
KMSKeyDetails?: KMSKeyDetails;
|
|
366
318
|
/**
|
|
367
|
-
* <p>
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
* </p>
|
|
319
|
+
* <p>Specifies the name of an S3 bucket and a <code>CodeArtifacts</code> object that contains
|
|
320
|
+
* the S3 object keys for a source code .zip file and for a build artifacts .zip file that
|
|
321
|
+
* contains .jar or .class files.</p>
|
|
371
322
|
*/
|
|
372
323
|
S3RepositoryDetails?: S3RepositoryDetails;
|
|
373
324
|
}
|
|
@@ -377,9 +328,7 @@ export interface AssociateRepositoryResponse {
|
|
|
377
328
|
*/
|
|
378
329
|
RepositoryAssociation?: RepositoryAssociation;
|
|
379
330
|
/**
|
|
380
|
-
* <p>
|
|
381
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
382
|
-
* </p>
|
|
331
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
383
332
|
* <ul>
|
|
384
333
|
* <li>
|
|
385
334
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -398,7 +347,8 @@ export interface AssociateRepositoryResponse {
|
|
|
398
347
|
}
|
|
399
348
|
/**
|
|
400
349
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
401
|
-
* resource associated with the request. Resolve the conflict before retrying this request.
|
|
350
|
+
* resource associated with the request. Resolve the conflict before retrying this request.
|
|
351
|
+
* </p>
|
|
402
352
|
*/
|
|
403
353
|
export declare class ConflictException extends __BaseException {
|
|
404
354
|
readonly name: "ConflictException";
|
|
@@ -446,29 +396,20 @@ export declare class ValidationException extends __BaseException {
|
|
|
446
396
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
447
397
|
}
|
|
448
398
|
/**
|
|
449
|
-
* <p>
|
|
450
|
-
*
|
|
451
|
-
* <code>SourceCodeType</code>
|
|
452
|
-
* </a> that specifies
|
|
453
|
-
* the tip of a branch in an associated repository.
|
|
454
|
-
* </p>
|
|
399
|
+
* <p>A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the tip of a branch in an associated
|
|
400
|
+
* repository.</p>
|
|
455
401
|
*/
|
|
456
402
|
export interface RepositoryHeadSourceCodeType {
|
|
457
403
|
/**
|
|
458
|
-
* <p>
|
|
459
|
-
*
|
|
460
|
-
* the tip of this branch.
|
|
461
|
-
* </p>
|
|
404
|
+
* <p>The name of the branch in an associated repository. The
|
|
405
|
+
* <code>RepositoryHeadSourceCodeType</code> specifies the tip of this branch.</p>
|
|
462
406
|
*/
|
|
463
407
|
BranchName: string | undefined;
|
|
464
408
|
}
|
|
465
409
|
/**
|
|
466
|
-
* <p>
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
* </a> that
|
|
470
|
-
* specifies a code diff between a source and destination branch in an associated repository.
|
|
471
|
-
* </p>
|
|
410
|
+
* <p>A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that
|
|
411
|
+
* specifies a code diff between a source and destination branch in an associated
|
|
412
|
+
* repository.</p>
|
|
472
413
|
*/
|
|
473
414
|
export interface BranchDiffSourceCodeType {
|
|
474
415
|
/**
|
|
@@ -481,25 +422,20 @@ export interface BranchDiffSourceCodeType {
|
|
|
481
422
|
DestinationBranchName: string | undefined;
|
|
482
423
|
}
|
|
483
424
|
/**
|
|
484
|
-
* <p>
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
* specifies the commit diff for a pull request on an associated repository. The <code>SourceCommit</code>
|
|
489
|
-
* and <code>DestinationCommit</code> fields are required to do a pull request code review.
|
|
490
|
-
* </p>
|
|
425
|
+
* <p>A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that
|
|
426
|
+
* specifies the commit diff for a pull request on an associated repository. The
|
|
427
|
+
* <code>SourceCommit</code> and <code>DestinationCommit</code> fields are required to do a
|
|
428
|
+
* pull request code review.</p>
|
|
491
429
|
*/
|
|
492
430
|
export interface CommitDiffSourceCodeType {
|
|
493
431
|
/**
|
|
494
|
-
* <p>
|
|
495
|
-
*
|
|
496
|
-
* </p>
|
|
432
|
+
* <p>The SHA of the source commit used to generate a commit diff. This field is required for
|
|
433
|
+
* a pull request code review.</p>
|
|
497
434
|
*/
|
|
498
435
|
SourceCommit?: string;
|
|
499
436
|
/**
|
|
500
|
-
* <p>
|
|
501
|
-
*
|
|
502
|
-
* </p>
|
|
437
|
+
* <p>The SHA of the destination commit used to generate a commit diff. This field is required
|
|
438
|
+
* for a pull request code review.</p>
|
|
503
439
|
*/
|
|
504
440
|
DestinationCommit?: string;
|
|
505
441
|
/**
|
|
@@ -508,12 +444,13 @@ export interface CommitDiffSourceCodeType {
|
|
|
508
444
|
MergeBaseCommit?: string;
|
|
509
445
|
}
|
|
510
446
|
/**
|
|
511
|
-
* <p>Information about an event. The event might be a push, pull request, scheduled request,
|
|
447
|
+
* <p>Information about an event. The event might be a push, pull request, scheduled request,
|
|
448
|
+
* or another type of event.</p>
|
|
512
449
|
*/
|
|
513
450
|
export interface EventInfo {
|
|
514
451
|
/**
|
|
515
|
-
* <p>The name of the event. The possible names are <code>pull_request</code>,
|
|
516
|
-
*
|
|
452
|
+
* <p>The name of the event. The possible names are <code>pull_request</code>,
|
|
453
|
+
* <code>workflow_dispatch</code>, <code>schedule</code>, and <code>push</code>
|
|
517
454
|
* </p>
|
|
518
455
|
*/
|
|
519
456
|
Name?: string;
|
|
@@ -528,8 +465,8 @@ export declare enum VendorName {
|
|
|
528
465
|
NATIVE_S3 = "NativeS3"
|
|
529
466
|
}
|
|
530
467
|
/**
|
|
531
|
-
* <p>Metadata that is associated with a code review. This applies to both pull request
|
|
532
|
-
*
|
|
468
|
+
* <p>Metadata that is associated with a code review. This applies to both pull request and
|
|
469
|
+
* repository analysis code reviews.</p>
|
|
533
470
|
*/
|
|
534
471
|
export interface RequestMetadata {
|
|
535
472
|
/**
|
|
@@ -538,7 +475,8 @@ export interface RequestMetadata {
|
|
|
538
475
|
RequestId?: string;
|
|
539
476
|
/**
|
|
540
477
|
* <p>An identifier, such as a name or account ID, that is associated with the requester. The
|
|
541
|
-
*
|
|
478
|
+
* <code>Requester</code> is used to capture the <code>author/actor</code> name of the
|
|
479
|
+
* event request.</p>
|
|
542
480
|
*/
|
|
543
481
|
Requester?: string;
|
|
544
482
|
/**
|
|
@@ -548,181 +486,123 @@ export interface RequestMetadata {
|
|
|
548
486
|
/**
|
|
549
487
|
* <p>The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code
|
|
550
488
|
* review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code
|
|
551
|
-
* review by GitHub scripts from a GitHub repository, then the repository association's
|
|
552
|
-
* <code>S3Bucket</code> and the CI/CD repository vendor name
|
|
553
|
-
* information, see the definition for <code>ProviderType</code> in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a
|
|
489
|
+
* review by GitHub scripts from a GitHub repository, then the repository association's
|
|
490
|
+
* <code>ProviderType</code> is <code>S3Bucket</code> and the CI/CD repository vendor name
|
|
491
|
+
* is GitHub. For more information, see the definition for <code>ProviderType</code> in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a>.</p>
|
|
554
492
|
*/
|
|
555
493
|
VendorName?: VendorName | string;
|
|
556
494
|
}
|
|
557
495
|
/**
|
|
558
|
-
* <p>
|
|
559
|
-
*
|
|
560
|
-
* .
|
|
561
|
-
* </p>
|
|
496
|
+
* <p>Information about an associated repository in an S3 bucket. The associated repository
|
|
497
|
+
* contains a source code .zip file and a build artifacts .zip file that contains .jar or
|
|
498
|
+
* .class files.</p>
|
|
562
499
|
*/
|
|
563
500
|
export interface S3BucketRepository {
|
|
564
501
|
/**
|
|
565
|
-
* <p>
|
|
566
|
-
*
|
|
567
|
-
* </p>
|
|
502
|
+
* <p>The name of the repository when the <code>ProviderType</code> is
|
|
503
|
+
* <code>S3Bucket</code>.</p>
|
|
568
504
|
*/
|
|
569
505
|
Name: string | undefined;
|
|
570
506
|
/**
|
|
571
|
-
* <p>
|
|
572
|
-
* An <code>S3RepositoryDetails</code> object that specifies the name of an S3 bucket and
|
|
573
|
-
* a <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> object includes the S3
|
|
574
|
-
* object keys for a source code .zip file and for a build artifacts .zip file.
|
|
575
|
-
* </p>
|
|
507
|
+
* <p>An <code>S3RepositoryDetails</code> object that specifies the name of an S3 bucket and a <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> object includes the S3 object keys for a source code .zip file and for a build artifacts .zip file.</p>
|
|
576
508
|
*/
|
|
577
509
|
Details?: S3RepositoryDetails;
|
|
578
510
|
}
|
|
579
511
|
/**
|
|
580
|
-
* <p>
|
|
581
|
-
* Specifies the source code that is analyzed in a code review.
|
|
582
|
-
* </p>
|
|
512
|
+
* <p>Specifies the source code that is analyzed in a code review.</p>
|
|
583
513
|
*/
|
|
584
514
|
export interface SourceCodeType {
|
|
585
515
|
/**
|
|
586
|
-
* <p>
|
|
587
|
-
*
|
|
588
|
-
* <code>SourceCodeType</code>
|
|
589
|
-
* </a> that
|
|
590
|
-
* specifies a commit diff created by a pull request on an associated repository.
|
|
591
|
-
* </p>
|
|
516
|
+
* <p>A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a commit diff created by a pull request on an
|
|
517
|
+
* associated repository.</p>
|
|
592
518
|
*/
|
|
593
519
|
CommitDiff?: CommitDiffSourceCodeType;
|
|
594
520
|
/**
|
|
595
|
-
* <p>
|
|
596
|
-
*
|
|
597
|
-
* <code>SourceCodeType</code>
|
|
598
|
-
* </a> that specifies
|
|
599
|
-
* the tip of a branch in an associated repository.
|
|
600
|
-
* </p>
|
|
521
|
+
* <p>A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the tip of a branch in an associated
|
|
522
|
+
* repository.</p>
|
|
601
523
|
*/
|
|
602
524
|
RepositoryHead?: RepositoryHeadSourceCodeType;
|
|
603
525
|
/**
|
|
604
|
-
* <p>
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
* </a> that
|
|
608
|
-
* specifies a source branch name and a destination branch name in an associated repository.
|
|
609
|
-
* </p>
|
|
526
|
+
* <p>A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that
|
|
527
|
+
* specifies a source branch name and a destination branch name in an associated
|
|
528
|
+
* repository.</p>
|
|
610
529
|
*/
|
|
611
530
|
BranchDiff?: BranchDiffSourceCodeType;
|
|
612
531
|
/**
|
|
613
|
-
* <p>
|
|
614
|
-
* Information about an associated repository in an S3 bucket that includes its name and an <code>S3RepositoryDetails</code> object.
|
|
615
|
-
* The <code>S3RepositoryDetails</code> object includes the name of an S3 bucket, an S3 key for a source code .zip file, and
|
|
616
|
-
* an S3 key for a build artifacts .zip file. <code>S3BucketRepository</code> is required in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">
|
|
617
|
-
* <code>SourceCodeType</code>
|
|
618
|
-
* </a> for
|
|
619
|
-
* <code>S3BucketRepository</code> based code reviews.
|
|
620
|
-
* </p>
|
|
532
|
+
* <p>Information about an associated repository in an S3 bucket that includes its name and an <code>S3RepositoryDetails</code> object. The <code>S3RepositoryDetails</code> object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. <code>S3BucketRepository</code> is required in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> for <code>S3BucketRepository</code> based code reviews.</p>
|
|
621
533
|
*/
|
|
622
534
|
S3BucketRepository?: S3BucketRepository;
|
|
623
535
|
/**
|
|
624
|
-
* <p>Metadata that is associated with a code review. This applies to any type of code review
|
|
625
|
-
*
|
|
626
|
-
* an event trigger, such as a push or a
|
|
536
|
+
* <p>Metadata that is associated with a code review. This applies to any type of code review
|
|
537
|
+
* supported by CodeGuru Reviewer. The <code>RequestMetadaa</code> field captures any event metadata. For
|
|
538
|
+
* example, it might capture metadata associated with an event trigger, such as a push or a
|
|
539
|
+
* pull request.</p>
|
|
627
540
|
*/
|
|
628
541
|
RequestMetadata?: RequestMetadata;
|
|
629
542
|
}
|
|
630
543
|
/**
|
|
631
|
-
* <p>
|
|
632
|
-
*
|
|
633
|
-
* <code>CreateCodeReview</code>
|
|
634
|
-
* </a>. </p>
|
|
544
|
+
* <p>A code review type that analyzes all code under a specified branch in an associated
|
|
545
|
+
* repository. The associated repository is specified using its ARN when you call <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.</p>
|
|
635
546
|
*/
|
|
636
547
|
export interface RepositoryAnalysis {
|
|
637
548
|
/**
|
|
638
|
-
* <p>
|
|
639
|
-
*
|
|
640
|
-
* <code>SourceCodeType</code>
|
|
641
|
-
* </a> that
|
|
642
|
-
* specifies the tip of a branch in an associated repository.
|
|
643
|
-
* </p>
|
|
549
|
+
* <p>A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the tip of a branch in an associated
|
|
550
|
+
* repository.</p>
|
|
644
551
|
*/
|
|
645
552
|
RepositoryHead?: RepositoryHeadSourceCodeType;
|
|
646
553
|
/**
|
|
647
|
-
* <p>
|
|
648
|
-
* Specifies the source code that is analyzed in a code review.
|
|
649
|
-
* </p>
|
|
554
|
+
* <p>Specifies the source code that is analyzed in a code review.</p>
|
|
650
555
|
*/
|
|
651
556
|
SourceCodeType?: SourceCodeType;
|
|
652
557
|
}
|
|
653
558
|
/**
|
|
654
|
-
* <p>
|
|
655
|
-
* The type of a code review. There are two code review types:
|
|
656
|
-
* </p>
|
|
559
|
+
* <p>The type of a code review. There are two code review types:</p>
|
|
657
560
|
* <ul>
|
|
658
561
|
* <li>
|
|
659
562
|
* <p>
|
|
660
|
-
* <code>PullRequest</code> - A code review that is automatically triggered by a pull
|
|
661
|
-
*
|
|
563
|
+
* <code>PullRequest</code> - A code review that is automatically triggered by a pull
|
|
564
|
+
* request on an associated repository.</p>
|
|
662
565
|
* </li>
|
|
663
566
|
* <li>
|
|
664
567
|
* <p>
|
|
665
|
-
*
|
|
666
|
-
*
|
|
667
|
-
*
|
|
668
|
-
* <code>CreateCodeReview</code>
|
|
669
|
-
* </a>. </p>
|
|
568
|
+
* <code>RepositoryAnalysis</code> - A code review that analyzes all code under a
|
|
569
|
+
* specified branch in an associated repository. The associated repository is specified
|
|
570
|
+
* using its ARN in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.</p>
|
|
670
571
|
* </li>
|
|
671
572
|
* </ul>
|
|
672
573
|
*/
|
|
673
574
|
export interface CodeReviewType {
|
|
674
575
|
/**
|
|
675
|
-
* <p>
|
|
676
|
-
*
|
|
677
|
-
* <code>CreateCodeReview</code>
|
|
678
|
-
* </a>. </p>
|
|
576
|
+
* <p>A code review that analyzes all code under a specified branch in an associated
|
|
577
|
+
* repository. The associated repository is specified using its ARN in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.</p>
|
|
679
578
|
*/
|
|
680
579
|
RepositoryAnalysis: RepositoryAnalysis | undefined;
|
|
681
580
|
/**
|
|
682
|
-
* <p>They types of analysis performed during a repository analysis or a pull request review.
|
|
683
|
-
* <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
581
|
+
* <p>They types of analysis performed during a repository analysis or a pull request review.
|
|
582
|
+
* You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
684
583
|
*/
|
|
685
584
|
AnalysisTypes?: (AnalysisType | string)[];
|
|
686
585
|
}
|
|
687
586
|
export interface CreateCodeReviewRequest {
|
|
688
587
|
/**
|
|
689
|
-
* <p>
|
|
690
|
-
*
|
|
691
|
-
* </p>
|
|
588
|
+
* <p>The name of the code review. The name of each code review in your Amazon Web Services account must be
|
|
589
|
+
* unique.</p>
|
|
692
590
|
*/
|
|
693
591
|
Name: string | undefined;
|
|
694
592
|
/**
|
|
695
|
-
* <p>
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
* <code>RepositoryAssociation</code>
|
|
699
|
-
* </a> object.
|
|
700
|
-
* You can retrieve this ARN by calling
|
|
701
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
702
|
-
* <code>ListRepositoryAssociations</code>
|
|
703
|
-
* </a>.
|
|
704
|
-
* </p>
|
|
705
|
-
* <p>
|
|
706
|
-
* A code review can only be created on an associated repository. This is the ARN of the
|
|
707
|
-
* associated repository.
|
|
708
|
-
* </p>
|
|
593
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
594
|
+
* <p>A code review can only be created on an associated repository. This is the ARN of the
|
|
595
|
+
* associated repository.</p>
|
|
709
596
|
*/
|
|
710
597
|
RepositoryAssociationArn: string | undefined;
|
|
711
598
|
/**
|
|
712
|
-
* <p>
|
|
713
|
-
*
|
|
714
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">
|
|
715
|
-
* <code>CodeReviewType</code>
|
|
716
|
-
* </a>
|
|
717
|
-
* object. You can create a code review only of type <code>RepositoryAnalysis</code>.
|
|
718
|
-
* </p>
|
|
599
|
+
* <p>The type of code review to create. This is specified using a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">CodeReviewType</a>
|
|
600
|
+
* object. You can create a code review only of type <code>RepositoryAnalysis</code>.</p>
|
|
719
601
|
*/
|
|
720
602
|
Type: CodeReviewType | undefined;
|
|
721
603
|
/**
|
|
722
|
-
* <p>
|
|
723
|
-
*
|
|
724
|
-
* reviews if there are failures and retries.
|
|
725
|
-
* </p>
|
|
604
|
+
* <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews
|
|
605
|
+
* if there are failures and retries.</p>
|
|
726
606
|
*/
|
|
727
607
|
ClientRequestToken?: string;
|
|
728
608
|
}
|
|
@@ -732,16 +612,14 @@ export declare enum ConfigFileState {
|
|
|
732
612
|
PRESENT_WITH_ERRORS = "PresentWithErrors"
|
|
733
613
|
}
|
|
734
614
|
/**
|
|
735
|
-
* <p>
|
|
736
|
-
* Information about the statistics from the code review.
|
|
737
|
-
* </p>
|
|
615
|
+
* <p>Information about the statistics from the code review.</p>
|
|
738
616
|
*/
|
|
739
617
|
export interface Metrics {
|
|
740
618
|
/**
|
|
741
619
|
* <p>
|
|
742
|
-
* <code>MeteredLinesOfCodeCount</code> is the number of lines of code in the repository
|
|
743
|
-
* This does not include non-code lines such as comments and
|
|
744
|
-
*
|
|
620
|
+
* <code>MeteredLinesOfCodeCount</code> is the number of lines of code in the repository
|
|
621
|
+
* where the code review happened. This does not include non-code lines such as comments and
|
|
622
|
+
* blank lines.</p>
|
|
745
623
|
*/
|
|
746
624
|
MeteredLinesOfCodeCount?: number;
|
|
747
625
|
/**
|
|
@@ -754,9 +632,7 @@ export interface Metrics {
|
|
|
754
632
|
*/
|
|
755
633
|
SuppressedLinesOfCodeCount?: number;
|
|
756
634
|
/**
|
|
757
|
-
* <p>
|
|
758
|
-
* Total number of recommendations found in the code review.
|
|
759
|
-
* </p>
|
|
635
|
+
* <p>Total number of recommendations found in the code review.</p>
|
|
760
636
|
*/
|
|
761
637
|
FindingsCount?: number;
|
|
762
638
|
}
|
|
@@ -771,28 +647,21 @@ export declare enum Type {
|
|
|
771
647
|
REPOSITORY_ANALYSIS = "RepositoryAnalysis"
|
|
772
648
|
}
|
|
773
649
|
/**
|
|
774
|
-
* <p>
|
|
775
|
-
*
|
|
776
|
-
* </p>
|
|
650
|
+
* <p>Information about a code review. A code review belongs to the associated repository that
|
|
651
|
+
* contains the reviewed code.</p>
|
|
777
652
|
*/
|
|
778
653
|
export interface CodeReview {
|
|
779
654
|
/**
|
|
780
|
-
* <p>
|
|
781
|
-
* The name of the code review.
|
|
782
|
-
* </p>
|
|
655
|
+
* <p>The name of the code review.</p>
|
|
783
656
|
*/
|
|
784
657
|
Name?: string;
|
|
785
658
|
/**
|
|
786
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
787
|
-
* <code>CodeReview</code>
|
|
788
|
-
* </a> object.
|
|
659
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
789
660
|
* </p>
|
|
790
661
|
*/
|
|
791
662
|
CodeReviewArn?: string;
|
|
792
663
|
/**
|
|
793
|
-
* <p>
|
|
794
|
-
* The name of the repository.
|
|
795
|
-
* </p>
|
|
664
|
+
* <p>The name of the repository.</p>
|
|
796
665
|
*/
|
|
797
666
|
RepositoryName?: string;
|
|
798
667
|
/**
|
|
@@ -802,9 +671,8 @@ export interface CodeReview {
|
|
|
802
671
|
*/
|
|
803
672
|
Owner?: string;
|
|
804
673
|
/**
|
|
805
|
-
* <p>
|
|
806
|
-
*
|
|
807
|
-
* </p>
|
|
674
|
+
* <p>The type of repository that contains the reviewed code (for example, GitHub or
|
|
675
|
+
* Bitbucket).</p>
|
|
808
676
|
*/
|
|
809
677
|
ProviderType?: ProviderType | string;
|
|
810
678
|
/**
|
|
@@ -812,85 +680,59 @@ export interface CodeReview {
|
|
|
812
680
|
* <ul>
|
|
813
681
|
* <li>
|
|
814
682
|
* <p>
|
|
815
|
-
* <code>Completed</code>: The code review is complete
|
|
816
|
-
* </p>
|
|
683
|
+
* <code>Completed</code>: The code review is complete.</p>
|
|
817
684
|
* </li>
|
|
818
685
|
* <li>
|
|
819
686
|
* <p>
|
|
820
|
-
* <code>Pending</code>: The code review started and has not completed or failed
|
|
821
|
-
* </p>
|
|
687
|
+
* <code>Pending</code>: The code review started and has not completed or failed.</p>
|
|
822
688
|
* </li>
|
|
823
689
|
* <li>
|
|
824
690
|
* <p>
|
|
825
|
-
* <code>Failed</code>: The code review failed
|
|
826
|
-
* </p>
|
|
691
|
+
* <code>Failed</code>: The code review failed.</p>
|
|
827
692
|
* </li>
|
|
828
693
|
* <li>
|
|
829
694
|
* <p>
|
|
830
|
-
* <code>Deleting</code>: The code review is being deleted
|
|
831
|
-
* </p>
|
|
695
|
+
* <code>Deleting</code>: The code review is being deleted.</p>
|
|
832
696
|
* </li>
|
|
833
697
|
* </ul>
|
|
834
698
|
*/
|
|
835
699
|
State?: JobState | string;
|
|
836
700
|
/**
|
|
837
|
-
* <p>
|
|
838
|
-
* The reason for the state of the code review.
|
|
839
|
-
* </p>
|
|
701
|
+
* <p>The reason for the state of the code review.</p>
|
|
840
702
|
*/
|
|
841
703
|
StateReason?: string;
|
|
842
704
|
/**
|
|
843
|
-
* <p>
|
|
844
|
-
* The time, in milliseconds since the epoch, when the code review was created.
|
|
845
|
-
* </p>
|
|
705
|
+
* <p>The time, in milliseconds since the epoch, when the code review was created.</p>
|
|
846
706
|
*/
|
|
847
707
|
CreatedTimeStamp?: Date;
|
|
848
708
|
/**
|
|
849
|
-
* <p>
|
|
850
|
-
* The time, in milliseconds since the epoch, when the code review was last updated.
|
|
851
|
-
* </p>
|
|
709
|
+
* <p>The time, in milliseconds since the epoch, when the code review was last updated.</p>
|
|
852
710
|
*/
|
|
853
711
|
LastUpdatedTimeStamp?: Date;
|
|
854
712
|
/**
|
|
855
|
-
* <p>
|
|
856
|
-
* The type of code review.
|
|
857
|
-
* </p>
|
|
713
|
+
* <p>The type of code review.</p>
|
|
858
714
|
*/
|
|
859
715
|
Type?: Type | string;
|
|
860
716
|
/**
|
|
861
|
-
* <p>
|
|
862
|
-
* The pull request ID for the code review.
|
|
863
|
-
* </p>
|
|
717
|
+
* <p>The pull request ID for the code review.</p>
|
|
864
718
|
*/
|
|
865
719
|
PullRequestId?: string;
|
|
866
720
|
/**
|
|
867
|
-
* <p>
|
|
868
|
-
* The type of the source code for the code review.
|
|
869
|
-
* </p>
|
|
721
|
+
* <p>The type of the source code for the code review.</p>
|
|
870
722
|
*/
|
|
871
723
|
SourceCodeType?: SourceCodeType;
|
|
872
724
|
/**
|
|
873
|
-
* <p>
|
|
874
|
-
*
|
|
875
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
876
|
-
* <code>RepositoryAssociation</code>
|
|
877
|
-
* </a> that contains
|
|
878
|
-
* the reviewed source code. You can retrieve associated repository ARNs by calling
|
|
879
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
880
|
-
* <code>ListRepositoryAssociations</code>
|
|
881
|
-
* </a>.
|
|
882
|
-
* </p>
|
|
725
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> that contains the reviewed source code. You can retrieve
|
|
726
|
+
* associated repository ARNs by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
883
727
|
*/
|
|
884
728
|
AssociationArn?: string;
|
|
885
729
|
/**
|
|
886
|
-
* <p>
|
|
887
|
-
* The statistics from the code review.
|
|
888
|
-
* </p>
|
|
730
|
+
* <p>The statistics from the code review.</p>
|
|
889
731
|
*/
|
|
890
732
|
Metrics?: Metrics;
|
|
891
733
|
/**
|
|
892
|
-
* <p>The types of analysis performed during a repository analysis or a pull request review.
|
|
893
|
-
* <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
734
|
+
* <p>The types of analysis performed during a repository analysis or a pull request review.
|
|
735
|
+
* You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
894
736
|
*/
|
|
895
737
|
AnalysisTypes?: (AnalysisType | string)[];
|
|
896
738
|
/**
|
|
@@ -902,16 +744,13 @@ export interface CodeReview {
|
|
|
902
744
|
}
|
|
903
745
|
export interface CreateCodeReviewResponse {
|
|
904
746
|
/**
|
|
905
|
-
* <p>
|
|
906
|
-
*
|
|
907
|
-
* </p>
|
|
747
|
+
* <p>Information about a code review. A code review belongs to the associated repository that
|
|
748
|
+
* contains the reviewed code.</p>
|
|
908
749
|
*/
|
|
909
750
|
CodeReview?: CodeReview;
|
|
910
751
|
}
|
|
911
752
|
/**
|
|
912
|
-
* <p>
|
|
913
|
-
* The resource specified in the request was not found.
|
|
914
|
-
* </p>
|
|
753
|
+
* <p> The resource specified in the request was not found. </p>
|
|
915
754
|
*/
|
|
916
755
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
917
756
|
readonly name: "ResourceNotFoundException";
|
|
@@ -924,44 +763,35 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
924
763
|
}
|
|
925
764
|
export interface DescribeCodeReviewRequest {
|
|
926
765
|
/**
|
|
927
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
928
|
-
* <code>CodeReview</code>
|
|
929
|
-
* </a> object.
|
|
766
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
930
767
|
* </p>
|
|
931
768
|
*/
|
|
932
769
|
CodeReviewArn: string | undefined;
|
|
933
770
|
}
|
|
934
771
|
export interface DescribeCodeReviewResponse {
|
|
935
772
|
/**
|
|
936
|
-
* <p>
|
|
937
|
-
* Information about the code review.
|
|
938
|
-
* </p>
|
|
773
|
+
* <p>Information about the code review.</p>
|
|
939
774
|
*/
|
|
940
775
|
CodeReview?: CodeReview;
|
|
941
776
|
}
|
|
942
777
|
export interface DescribeRecommendationFeedbackRequest {
|
|
943
778
|
/**
|
|
944
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
945
|
-
* <code>CodeReview</code>
|
|
946
|
-
* </a> object.
|
|
779
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
947
780
|
* </p>
|
|
948
781
|
*/
|
|
949
782
|
CodeReviewArn: string | undefined;
|
|
950
783
|
/**
|
|
951
|
-
* <p>
|
|
952
|
-
*
|
|
953
|
-
* </p>
|
|
784
|
+
* <p>The recommendation ID that can be used to track the provided recommendations and then to
|
|
785
|
+
* collect the feedback.</p>
|
|
954
786
|
*/
|
|
955
787
|
RecommendationId: string | undefined;
|
|
956
788
|
/**
|
|
957
|
-
* <p>
|
|
958
|
-
*
|
|
959
|
-
* </p>
|
|
789
|
+
* <p>Optional parameter to describe the feedback for a given user. If this is not supplied,
|
|
790
|
+
* it defaults to the user making the request.</p>
|
|
960
791
|
* <p>
|
|
961
792
|
* The <code>UserId</code> is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For
|
|
962
793
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying">
|
|
963
|
-
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i
|
|
964
|
-
* </p>
|
|
794
|
+
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
965
795
|
*/
|
|
966
796
|
UserId?: string;
|
|
967
797
|
}
|
|
@@ -970,74 +800,50 @@ export declare enum Reaction {
|
|
|
970
800
|
THUMBS_UP = "ThumbsUp"
|
|
971
801
|
}
|
|
972
802
|
/**
|
|
973
|
-
* <p>
|
|
974
|
-
* Information about the recommendation feedback.
|
|
975
|
-
* </p>
|
|
803
|
+
* <p>Information about the recommendation feedback.</p>
|
|
976
804
|
*/
|
|
977
805
|
export interface RecommendationFeedback {
|
|
978
806
|
/**
|
|
979
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
980
|
-
* <code>CodeReview</code>
|
|
981
|
-
* </a> object.
|
|
807
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
982
808
|
* </p>
|
|
983
809
|
*/
|
|
984
810
|
CodeReviewArn?: string;
|
|
985
811
|
/**
|
|
986
|
-
* <p>
|
|
987
|
-
*
|
|
988
|
-
* </p>
|
|
812
|
+
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
813
|
+
* it can be used to collect the feedback.</p>
|
|
989
814
|
*/
|
|
990
815
|
RecommendationId?: string;
|
|
991
816
|
/**
|
|
992
|
-
* <p>
|
|
993
|
-
*
|
|
994
|
-
* </p>
|
|
817
|
+
* <p>List for storing reactions. Reactions are utf-8 text code for emojis. You can send an
|
|
818
|
+
* empty list to clear off all your feedback.</p>
|
|
995
819
|
*/
|
|
996
820
|
Reactions?: (Reaction | string)[];
|
|
997
821
|
/**
|
|
998
|
-
* <p>
|
|
999
|
-
* The ID of the user that made the API call.
|
|
1000
|
-
* </p>
|
|
822
|
+
* <p>The ID of the user that made the API call.</p>
|
|
1001
823
|
* <p>
|
|
1002
824
|
* The <code>UserId</code> is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For
|
|
1003
825
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying">
|
|
1004
|
-
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i
|
|
1005
|
-
* </p>
|
|
826
|
+
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
1006
827
|
*/
|
|
1007
828
|
UserId?: string;
|
|
1008
829
|
/**
|
|
1009
|
-
* <p>
|
|
1010
|
-
* The time at which the feedback was created.
|
|
1011
|
-
* </p>
|
|
830
|
+
* <p>The time at which the feedback was created.</p>
|
|
1012
831
|
*/
|
|
1013
832
|
CreatedTimeStamp?: Date;
|
|
1014
833
|
/**
|
|
1015
|
-
* <p>
|
|
1016
|
-
* The time at which the feedback was last updated.
|
|
1017
|
-
* </p>
|
|
834
|
+
* <p>The time at which the feedback was last updated.</p>
|
|
1018
835
|
*/
|
|
1019
836
|
LastUpdatedTimeStamp?: Date;
|
|
1020
837
|
}
|
|
1021
838
|
export interface DescribeRecommendationFeedbackResponse {
|
|
1022
839
|
/**
|
|
1023
|
-
* <p>
|
|
1024
|
-
* The recommendation feedback given by the user.
|
|
1025
|
-
* </p>
|
|
840
|
+
* <p>The recommendation feedback given by the user.</p>
|
|
1026
841
|
*/
|
|
1027
842
|
RecommendationFeedback?: RecommendationFeedback;
|
|
1028
843
|
}
|
|
1029
844
|
export interface DescribeRepositoryAssociationRequest {
|
|
1030
845
|
/**
|
|
1031
|
-
* <p>
|
|
1032
|
-
* The Amazon Resource Name (ARN) of the
|
|
1033
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1034
|
-
* <code>RepositoryAssociation</code>
|
|
1035
|
-
* </a> object.
|
|
1036
|
-
* You can retrieve this ARN by calling
|
|
1037
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1038
|
-
* <code>ListRepositoryAssociations</code>
|
|
1039
|
-
* </a>.
|
|
1040
|
-
* </p>
|
|
846
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1041
847
|
*/
|
|
1042
848
|
AssociationArn: string | undefined;
|
|
1043
849
|
}
|
|
@@ -1047,9 +853,7 @@ export interface DescribeRepositoryAssociationResponse {
|
|
|
1047
853
|
*/
|
|
1048
854
|
RepositoryAssociation?: RepositoryAssociation;
|
|
1049
855
|
/**
|
|
1050
|
-
* <p>
|
|
1051
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
1052
|
-
* </p>
|
|
856
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1053
857
|
* <ul>
|
|
1054
858
|
* <li>
|
|
1055
859
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -1080,16 +884,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1080
884
|
}
|
|
1081
885
|
export interface DisassociateRepositoryRequest {
|
|
1082
886
|
/**
|
|
1083
|
-
* <p>
|
|
1084
|
-
* The Amazon Resource Name (ARN) of the
|
|
1085
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1086
|
-
* <code>RepositoryAssociation</code>
|
|
1087
|
-
* </a> object.
|
|
1088
|
-
* You can retrieve this ARN by calling
|
|
1089
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1090
|
-
* <code>ListRepositoryAssociations</code>
|
|
1091
|
-
* </a>.
|
|
1092
|
-
* </p>
|
|
887
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1093
888
|
*/
|
|
1094
889
|
AssociationArn: string | undefined;
|
|
1095
890
|
}
|
|
@@ -1099,9 +894,7 @@ export interface DisassociateRepositoryResponse {
|
|
|
1099
894
|
*/
|
|
1100
895
|
RepositoryAssociation?: RepositoryAssociation;
|
|
1101
896
|
/**
|
|
1102
|
-
* <p>
|
|
1103
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
1104
|
-
* </p>
|
|
897
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1105
898
|
* <ul>
|
|
1106
899
|
* <li>
|
|
1107
900
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -1120,82 +913,71 @@ export interface DisassociateRepositoryResponse {
|
|
|
1120
913
|
}
|
|
1121
914
|
export interface ListCodeReviewsRequest {
|
|
1122
915
|
/**
|
|
1123
|
-
* <p>
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
916
|
+
* <p>List of provider types for filtering that needs to be applied before displaying the
|
|
917
|
+
* result. For example, <code>providerTypes=[GitHub]</code> lists code reviews from
|
|
918
|
+
* GitHub.</p>
|
|
1126
919
|
*/
|
|
1127
920
|
ProviderTypes?: (ProviderType | string)[];
|
|
1128
921
|
/**
|
|
1129
|
-
* <p>
|
|
1130
|
-
*
|
|
1131
|
-
* </p>
|
|
922
|
+
* <p>List of states for filtering that needs to be applied before displaying the result. For
|
|
923
|
+
* example, <code>states=[Pending]</code> lists code reviews in the Pending state.</p>
|
|
1132
924
|
* <p>The valid code review states are:</p>
|
|
1133
925
|
* <ul>
|
|
1134
926
|
* <li>
|
|
1135
927
|
* <p>
|
|
1136
|
-
* <code>Completed</code>: The code review is complete
|
|
1137
|
-
* </p>
|
|
928
|
+
* <code>Completed</code>: The code review is complete.</p>
|
|
1138
929
|
* </li>
|
|
1139
930
|
* <li>
|
|
1140
931
|
* <p>
|
|
1141
|
-
* <code>Pending</code>: The code review started and has not completed or failed
|
|
1142
|
-
* </p>
|
|
932
|
+
* <code>Pending</code>: The code review started and has not completed or failed.</p>
|
|
1143
933
|
* </li>
|
|
1144
934
|
* <li>
|
|
1145
935
|
* <p>
|
|
1146
|
-
* <code>Failed</code>: The code review failed
|
|
1147
|
-
* </p>
|
|
936
|
+
* <code>Failed</code>: The code review failed.</p>
|
|
1148
937
|
* </li>
|
|
1149
938
|
* <li>
|
|
1150
939
|
* <p>
|
|
1151
|
-
* <code>Deleting</code>: The code review is being deleted
|
|
1152
|
-
* </p>
|
|
940
|
+
* <code>Deleting</code>: The code review is being deleted.</p>
|
|
1153
941
|
* </li>
|
|
1154
942
|
* </ul>
|
|
1155
943
|
*/
|
|
1156
944
|
States?: (JobState | string)[];
|
|
1157
945
|
/**
|
|
1158
|
-
* <p>
|
|
1159
|
-
*
|
|
1160
|
-
* </p>
|
|
946
|
+
* <p>List of repository names for filtering that needs to be applied before displaying the
|
|
947
|
+
* result.</p>
|
|
1161
948
|
*/
|
|
1162
949
|
RepositoryNames?: string[];
|
|
1163
950
|
/**
|
|
1164
|
-
* <p>
|
|
1165
|
-
* The type of code reviews to list in the response.
|
|
1166
|
-
* </p>
|
|
951
|
+
* <p>The type of code reviews to list in the response.</p>
|
|
1167
952
|
*/
|
|
1168
953
|
Type: Type | string | undefined;
|
|
1169
954
|
/**
|
|
1170
|
-
* <p>
|
|
1171
|
-
* The maximum number of results that are returned per call. The default is 100.
|
|
1172
|
-
* </p>
|
|
955
|
+
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1173
956
|
*/
|
|
1174
957
|
MaxResults?: number;
|
|
1175
958
|
/**
|
|
1176
|
-
* <p>
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
959
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
960
|
+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
961
|
+
* using the returned token to retrieve the next page. Keep all other arguments
|
|
962
|
+
* unchanged.</p>
|
|
1180
963
|
*/
|
|
1181
964
|
NextToken?: string;
|
|
1182
965
|
}
|
|
1183
966
|
/**
|
|
1184
|
-
* <p>
|
|
1185
|
-
* Information about metrics summaries.
|
|
1186
|
-
* </p>
|
|
967
|
+
* <p>Information about metrics summaries.</p>
|
|
1187
968
|
*/
|
|
1188
969
|
export interface MetricsSummary {
|
|
1189
970
|
/**
|
|
1190
|
-
* <p>
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1194
|
-
* and import statements. For example, if you submit a pull request
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1197
|
-
* code
|
|
1198
|
-
*
|
|
971
|
+
* <p>Lines of code metered in the code review. For the initial code review pull request and
|
|
972
|
+
* all subsequent revisions, this includes all lines of code in the files added to the pull
|
|
973
|
+
* request. In subsequent revisions, for files that already existed in the pull request, this
|
|
974
|
+
* includes only the changed lines of code. In both cases, this does not include non-code
|
|
975
|
+
* lines such as comments and import statements. For example, if you submit a pull request
|
|
976
|
+
* containing 5 files, each with 500 lines of code, and in a subsequent revision you added a
|
|
977
|
+
* new file with 200 lines of code, and also modified a total of 25 lines across the initial 5
|
|
978
|
+
* files, <code>MeteredLinesOfCodeCount</code> includes the first 5 files (5 * 500 = 2,500
|
|
979
|
+
* lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725
|
|
980
|
+
* lines of code.</p>
|
|
1199
981
|
*/
|
|
1200
982
|
MeteredLinesOfCodeCount?: number;
|
|
1201
983
|
/**
|
|
@@ -1209,42 +991,32 @@ export interface MetricsSummary {
|
|
|
1209
991
|
* the <code>aws-codeguru-reviewer.yml</code> file, then
|
|
1210
992
|
* <code>SuppressedLinesOfCodeCount</code> returns 200 (2 * 100) as the total number of
|
|
1211
993
|
* lines of code suppressed. However, if you submit a pull request for the same repository,
|
|
1212
|
-
* then
|
|
1213
|
-
*
|
|
1214
|
-
* <code>SuppressedLinesOfCodeCount</code>
|
|
994
|
+
* then <code>SuppressedLinesOfCodeCount</code> only includes the lines in the 2 files that
|
|
995
|
+
* changed. If only 1 of the 2 files changed in the pull request, then
|
|
996
|
+
* <code>SuppressedLinesOfCodeCount</code> returns 100 (1 * 100) as the total number of
|
|
1215
997
|
* lines of code suppressed.</p>
|
|
1216
998
|
*/
|
|
1217
999
|
SuppressedLinesOfCodeCount?: number;
|
|
1218
1000
|
/**
|
|
1219
|
-
* <p>
|
|
1220
|
-
* Total number of recommendations found in the code review.
|
|
1221
|
-
* </p>
|
|
1001
|
+
* <p>Total number of recommendations found in the code review.</p>
|
|
1222
1002
|
*/
|
|
1223
1003
|
FindingsCount?: number;
|
|
1224
1004
|
}
|
|
1225
1005
|
/**
|
|
1226
|
-
* <p>
|
|
1227
|
-
* Information about the summary of the code review.
|
|
1228
|
-
* </p>
|
|
1006
|
+
* <p>Information about the summary of the code review.</p>
|
|
1229
1007
|
*/
|
|
1230
1008
|
export interface CodeReviewSummary {
|
|
1231
1009
|
/**
|
|
1232
|
-
* <p>
|
|
1233
|
-
* The name of the code review.
|
|
1234
|
-
* </p>
|
|
1010
|
+
* <p>The name of the code review.</p>
|
|
1235
1011
|
*/
|
|
1236
1012
|
Name?: string;
|
|
1237
1013
|
/**
|
|
1238
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
1239
|
-
* <code>CodeReview</code>
|
|
1240
|
-
* </a> object.
|
|
1014
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
1241
1015
|
* </p>
|
|
1242
1016
|
*/
|
|
1243
1017
|
CodeReviewArn?: string;
|
|
1244
1018
|
/**
|
|
1245
|
-
* <p>
|
|
1246
|
-
* The name of the repository.
|
|
1247
|
-
* </p>
|
|
1019
|
+
* <p>The name of the repository.</p>
|
|
1248
1020
|
*/
|
|
1249
1021
|
RepositoryName?: string;
|
|
1250
1022
|
/**
|
|
@@ -1254,190 +1026,144 @@ export interface CodeReviewSummary {
|
|
|
1254
1026
|
*/
|
|
1255
1027
|
Owner?: string;
|
|
1256
1028
|
/**
|
|
1257
|
-
* <p>
|
|
1258
|
-
* The provider type of the repository association.
|
|
1259
|
-
* </p>
|
|
1029
|
+
* <p>The provider type of the repository association.</p>
|
|
1260
1030
|
*/
|
|
1261
1031
|
ProviderType?: ProviderType | string;
|
|
1262
1032
|
/**
|
|
1263
|
-
* <p>
|
|
1264
|
-
* The state of the code review.
|
|
1265
|
-
* </p>
|
|
1033
|
+
* <p>The state of the code review.</p>
|
|
1266
1034
|
* <p>The valid code review states are:</p>
|
|
1267
1035
|
* <ul>
|
|
1268
1036
|
* <li>
|
|
1269
1037
|
* <p>
|
|
1270
|
-
* <code>Completed</code>: The code review is complete
|
|
1271
|
-
* </p>
|
|
1038
|
+
* <code>Completed</code>: The code review is complete.</p>
|
|
1272
1039
|
* </li>
|
|
1273
1040
|
* <li>
|
|
1274
1041
|
* <p>
|
|
1275
|
-
* <code>Pending</code>: The code review started and has not completed or failed
|
|
1276
|
-
* </p>
|
|
1042
|
+
* <code>Pending</code>: The code review started and has not completed or failed.</p>
|
|
1277
1043
|
* </li>
|
|
1278
1044
|
* <li>
|
|
1279
1045
|
* <p>
|
|
1280
|
-
* <code>Failed</code>: The code review failed
|
|
1281
|
-
* </p>
|
|
1046
|
+
* <code>Failed</code>: The code review failed.</p>
|
|
1282
1047
|
* </li>
|
|
1283
1048
|
* <li>
|
|
1284
1049
|
* <p>
|
|
1285
|
-
* <code>Deleting</code>: The code review is being deleted
|
|
1286
|
-
* </p>
|
|
1050
|
+
* <code>Deleting</code>: The code review is being deleted.</p>
|
|
1287
1051
|
* </li>
|
|
1288
1052
|
* </ul>
|
|
1289
1053
|
*/
|
|
1290
1054
|
State?: JobState | string;
|
|
1291
1055
|
/**
|
|
1292
|
-
* <p>
|
|
1293
|
-
* The time, in milliseconds since the epoch, when the code review was created.
|
|
1294
|
-
* </p>
|
|
1056
|
+
* <p>The time, in milliseconds since the epoch, when the code review was created.</p>
|
|
1295
1057
|
*/
|
|
1296
1058
|
CreatedTimeStamp?: Date;
|
|
1297
1059
|
/**
|
|
1298
|
-
* <p>
|
|
1299
|
-
* The time, in milliseconds since the epoch, when the code review was last updated.
|
|
1300
|
-
* </p>
|
|
1060
|
+
* <p>The time, in milliseconds since the epoch, when the code review was last updated.</p>
|
|
1301
1061
|
*/
|
|
1302
1062
|
LastUpdatedTimeStamp?: Date;
|
|
1303
1063
|
/**
|
|
1304
|
-
* <p>
|
|
1305
|
-
* The type of the code review.
|
|
1306
|
-
* </p>
|
|
1064
|
+
* <p>The type of the code review.</p>
|
|
1307
1065
|
*/
|
|
1308
1066
|
Type?: Type | string;
|
|
1309
1067
|
/**
|
|
1310
|
-
* <p>
|
|
1311
|
-
* The pull request ID for the code review.
|
|
1312
|
-
* </p>
|
|
1068
|
+
* <p>The pull request ID for the code review.</p>
|
|
1313
1069
|
*/
|
|
1314
1070
|
PullRequestId?: string;
|
|
1315
1071
|
/**
|
|
1316
|
-
* <p>
|
|
1317
|
-
* The statistics from the code review.
|
|
1318
|
-
* </p>
|
|
1072
|
+
* <p>The statistics from the code review.</p>
|
|
1319
1073
|
*/
|
|
1320
1074
|
MetricsSummary?: MetricsSummary;
|
|
1321
1075
|
/**
|
|
1322
|
-
* <p>
|
|
1323
|
-
* Specifies the source code that is analyzed in a code review.
|
|
1324
|
-
* </p>
|
|
1076
|
+
* <p>Specifies the source code that is analyzed in a code review.</p>
|
|
1325
1077
|
*/
|
|
1326
1078
|
SourceCodeType?: SourceCodeType;
|
|
1327
1079
|
}
|
|
1328
1080
|
export interface ListCodeReviewsResponse {
|
|
1329
1081
|
/**
|
|
1330
|
-
* <p>
|
|
1331
|
-
* A list of code reviews that meet the criteria of the request.
|
|
1332
|
-
* </p>
|
|
1082
|
+
* <p>A list of code reviews that meet the criteria of the request.</p>
|
|
1333
1083
|
*/
|
|
1334
1084
|
CodeReviewSummaries?: CodeReviewSummary[];
|
|
1335
1085
|
/**
|
|
1336
|
-
* <p>
|
|
1337
|
-
* Pagination token.
|
|
1338
|
-
* </p>
|
|
1086
|
+
* <p>Pagination token.</p>
|
|
1339
1087
|
*/
|
|
1340
1088
|
NextToken?: string;
|
|
1341
1089
|
}
|
|
1342
1090
|
export interface ListRecommendationFeedbackRequest {
|
|
1343
1091
|
/**
|
|
1344
|
-
* <p>
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1092
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
1093
|
+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
1094
|
+
* using the returned token to retrieve the next page. Keep all other arguments
|
|
1095
|
+
* unchanged.</p>
|
|
1348
1096
|
*/
|
|
1349
1097
|
NextToken?: string;
|
|
1350
1098
|
/**
|
|
1351
|
-
* <p>
|
|
1352
|
-
* The maximum number of results that are returned per call. The default is 100.
|
|
1353
|
-
* </p>
|
|
1099
|
+
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1354
1100
|
*/
|
|
1355
1101
|
MaxResults?: number;
|
|
1356
1102
|
/**
|
|
1357
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
1358
|
-
* <code>CodeReview</code>
|
|
1359
|
-
* </a> object.
|
|
1103
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
1360
1104
|
* </p>
|
|
1361
1105
|
*/
|
|
1362
1106
|
CodeReviewArn: string | undefined;
|
|
1363
1107
|
/**
|
|
1364
|
-
* <p>
|
|
1365
|
-
*
|
|
1366
|
-
* </p>
|
|
1108
|
+
* <p>An Amazon Web Services user's account ID or Amazon Resource Name (ARN). Use this ID to query the
|
|
1109
|
+
* recommendation feedback for a code review from that user.</p>
|
|
1367
1110
|
* <p>
|
|
1368
1111
|
* The <code>UserId</code> is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For
|
|
1369
1112
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying">
|
|
1370
|
-
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i
|
|
1371
|
-
* </p>
|
|
1113
|
+
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
1372
1114
|
*/
|
|
1373
1115
|
UserIds?: string[];
|
|
1374
1116
|
/**
|
|
1375
|
-
* <p>
|
|
1376
|
-
* Used to query the recommendation feedback for a given recommendation.
|
|
1377
|
-
* </p>
|
|
1117
|
+
* <p>Used to query the recommendation feedback for a given recommendation.</p>
|
|
1378
1118
|
*/
|
|
1379
1119
|
RecommendationIds?: string[];
|
|
1380
1120
|
}
|
|
1381
1121
|
/**
|
|
1382
|
-
* <p>
|
|
1383
|
-
* Information about recommendation feedback summaries.
|
|
1384
|
-
* </p>
|
|
1122
|
+
* <p>Information about recommendation feedback summaries.</p>
|
|
1385
1123
|
*/
|
|
1386
1124
|
export interface RecommendationFeedbackSummary {
|
|
1387
1125
|
/**
|
|
1388
|
-
* <p>
|
|
1389
|
-
*
|
|
1390
|
-
* </p>
|
|
1126
|
+
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
1127
|
+
* it can be used to collect the feedback.</p>
|
|
1391
1128
|
*/
|
|
1392
1129
|
RecommendationId?: string;
|
|
1393
1130
|
/**
|
|
1394
|
-
* <p>
|
|
1395
|
-
* List for storing reactions. Reactions are utf-8 text code for emojis.
|
|
1396
|
-
* </p>
|
|
1131
|
+
* <p>List for storing reactions. Reactions are utf-8 text code for emojis.</p>
|
|
1397
1132
|
*/
|
|
1398
1133
|
Reactions?: (Reaction | string)[];
|
|
1399
1134
|
/**
|
|
1400
|
-
* <p>
|
|
1401
|
-
* The ID of the user that gave the feedback.
|
|
1402
|
-
* </p>
|
|
1135
|
+
* <p>The ID of the user that gave the feedback.</p>
|
|
1403
1136
|
* <p>
|
|
1404
1137
|
* The <code>UserId</code> is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For
|
|
1405
1138
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying">
|
|
1406
|
-
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i
|
|
1407
|
-
* </p>
|
|
1139
|
+
* Specifying a Principal</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
1408
1140
|
*/
|
|
1409
1141
|
UserId?: string;
|
|
1410
1142
|
}
|
|
1411
1143
|
export interface ListRecommendationFeedbackResponse {
|
|
1412
1144
|
/**
|
|
1413
|
-
* <p>
|
|
1145
|
+
* <p>Recommendation feedback summaries corresponding to the code review ARN.</p>
|
|
1414
1146
|
*/
|
|
1415
1147
|
RecommendationFeedbackSummaries?: RecommendationFeedbackSummary[];
|
|
1416
1148
|
/**
|
|
1417
|
-
* <p>
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1149
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
1150
|
+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
1151
|
+
* using the returned token to retrieve the next page. Keep all other arguments
|
|
1152
|
+
* unchanged.</p>
|
|
1421
1153
|
*/
|
|
1422
1154
|
NextToken?: string;
|
|
1423
1155
|
}
|
|
1424
1156
|
export interface ListRecommendationsRequest {
|
|
1425
1157
|
/**
|
|
1426
|
-
* <p>
|
|
1427
|
-
* Pagination token.
|
|
1428
|
-
* </p>
|
|
1158
|
+
* <p>Pagination token.</p>
|
|
1429
1159
|
*/
|
|
1430
1160
|
NextToken?: string;
|
|
1431
1161
|
/**
|
|
1432
|
-
* <p>
|
|
1433
|
-
* The maximum number of results that are returned per call. The default is 100.
|
|
1434
|
-
* </p>
|
|
1162
|
+
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1435
1163
|
*/
|
|
1436
1164
|
MaxResults?: number;
|
|
1437
1165
|
/**
|
|
1438
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
1439
|
-
* <code>CodeReview</code>
|
|
1440
|
-
* </a> object.
|
|
1166
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
1441
1167
|
* </p>
|
|
1442
1168
|
*/
|
|
1443
1169
|
CodeReviewArn: string | undefined;
|
|
@@ -1456,9 +1182,7 @@ export declare enum RecommendationCategory {
|
|
|
1456
1182
|
SECURITY_ISSUES = "SecurityIssues"
|
|
1457
1183
|
}
|
|
1458
1184
|
/**
|
|
1459
|
-
* <p>Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a
|
|
1460
|
-
* short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is
|
|
1461
|
-
* included in analysis results if code is detected that violates the rule.</p>
|
|
1185
|
+
* <p>Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.</p>
|
|
1462
1186
|
*/
|
|
1463
1187
|
export interface RuleMetadata {
|
|
1464
1188
|
/**
|
|
@@ -1490,9 +1214,7 @@ export declare enum Severity {
|
|
|
1490
1214
|
MEDIUM = "Medium"
|
|
1491
1215
|
}
|
|
1492
1216
|
/**
|
|
1493
|
-
* <p>
|
|
1494
|
-
* Information about recommendations.
|
|
1495
|
-
* </p>
|
|
1217
|
+
* <p>Information about recommendations.</p>
|
|
1496
1218
|
*/
|
|
1497
1219
|
export interface RecommendationSummary {
|
|
1498
1220
|
/**
|
|
@@ -1500,27 +1222,23 @@ export interface RecommendationSummary {
|
|
|
1500
1222
|
*/
|
|
1501
1223
|
FilePath?: string;
|
|
1502
1224
|
/**
|
|
1503
|
-
* <p>
|
|
1504
|
-
*
|
|
1505
|
-
* </p>
|
|
1225
|
+
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
1226
|
+
* it can be used to collect the feedback.</p>
|
|
1506
1227
|
*/
|
|
1507
1228
|
RecommendationId?: string;
|
|
1508
1229
|
/**
|
|
1509
|
-
* <p>
|
|
1510
|
-
*
|
|
1511
|
-
* </p>
|
|
1230
|
+
* <p>Start line from where the recommendation is applicable in the source commit or source
|
|
1231
|
+
* branch.</p>
|
|
1512
1232
|
*/
|
|
1513
1233
|
StartLine?: number;
|
|
1514
1234
|
/**
|
|
1515
|
-
* <p>
|
|
1516
|
-
*
|
|
1517
|
-
* </p>
|
|
1235
|
+
* <p>Last line where the recommendation is applicable in the source commit or source branch.
|
|
1236
|
+
* For a single line comment the start line and end line values are the same.</p>
|
|
1518
1237
|
*/
|
|
1519
1238
|
EndLine?: number;
|
|
1520
1239
|
/**
|
|
1521
|
-
* <p>
|
|
1522
|
-
*
|
|
1523
|
-
* </p>
|
|
1240
|
+
* <p>A description of the recommendation generated by CodeGuru Reviewer for the lines of code between
|
|
1241
|
+
* the start line and the end line.</p>
|
|
1524
1242
|
*/
|
|
1525
1243
|
Description?: string;
|
|
1526
1244
|
/**
|
|
@@ -1528,9 +1246,7 @@ export interface RecommendationSummary {
|
|
|
1528
1246
|
*/
|
|
1529
1247
|
RecommendationCategory?: RecommendationCategory | string;
|
|
1530
1248
|
/**
|
|
1531
|
-
* <p>Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a
|
|
1532
|
-
* short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is
|
|
1533
|
-
* included in analysis results if code is detected that violates the rule.</p>
|
|
1249
|
+
* <p>Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.</p>
|
|
1534
1250
|
*/
|
|
1535
1251
|
RuleMetadata?: RuleMetadata;
|
|
1536
1252
|
/**
|
|
@@ -1540,15 +1256,11 @@ export interface RecommendationSummary {
|
|
|
1540
1256
|
}
|
|
1541
1257
|
export interface ListRecommendationsResponse {
|
|
1542
1258
|
/**
|
|
1543
|
-
* <p>
|
|
1544
|
-
* List of recommendations for the requested code review.
|
|
1545
|
-
* </p>
|
|
1259
|
+
* <p>List of recommendations for the requested code review.</p>
|
|
1546
1260
|
*/
|
|
1547
1261
|
RecommendationSummaries?: RecommendationSummary[];
|
|
1548
1262
|
/**
|
|
1549
|
-
* <p>
|
|
1550
|
-
* Pagination token.
|
|
1551
|
-
* </p>
|
|
1263
|
+
* <p>Pagination token.</p>
|
|
1552
1264
|
*/
|
|
1553
1265
|
NextToken?: string;
|
|
1554
1266
|
}
|
|
@@ -1563,54 +1275,35 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1563
1275
|
* <ul>
|
|
1564
1276
|
* <li>
|
|
1565
1277
|
* <p>
|
|
1566
|
-
* <b>Associated</b>: The repository
|
|
1567
|
-
* association is complete.
|
|
1568
|
-
* </p>
|
|
1278
|
+
* <b>Associated</b>: The repository association is complete.</p>
|
|
1569
1279
|
* </li>
|
|
1570
1280
|
* <li>
|
|
1571
1281
|
* <p>
|
|
1572
|
-
* <b>Associating</b>: CodeGuru Reviewer is
|
|
1573
|
-
* </p>
|
|
1282
|
+
* <b>Associating</b>: CodeGuru Reviewer is:</p>
|
|
1574
1283
|
* <ul>
|
|
1575
1284
|
* <li>
|
|
1576
|
-
* <p>
|
|
1577
|
-
*
|
|
1578
|
-
* for pull requests to trigger a CodeGuru Reviewer review.
|
|
1579
|
-
* </p>
|
|
1285
|
+
* <p>Setting up pull request notifications. This is required
|
|
1286
|
+
* for pull requests to trigger a CodeGuru Reviewer review.</p>
|
|
1580
1287
|
* <note>
|
|
1581
|
-
* <p>
|
|
1582
|
-
* If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>,
|
|
1583
|
-
* CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks,
|
|
1584
|
-
* reviews of code in your repository cannot be triggered.
|
|
1585
|
-
* </p>
|
|
1288
|
+
* <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p>
|
|
1586
1289
|
* </note>
|
|
1587
1290
|
* </li>
|
|
1588
1291
|
* <li>
|
|
1589
|
-
* <p>
|
|
1590
|
-
* Setting up source code access. This is required for CodeGuru Reviewer to securely
|
|
1591
|
-
* clone code in your repository.
|
|
1592
|
-
* </p>
|
|
1292
|
+
* <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p>
|
|
1593
1293
|
* </li>
|
|
1594
1294
|
* </ul>
|
|
1595
1295
|
* </li>
|
|
1596
1296
|
* <li>
|
|
1597
1297
|
* <p>
|
|
1598
|
-
* <b>Failed</b>: The repository failed to associate or disassociate
|
|
1599
|
-
* </p>
|
|
1298
|
+
* <b>Failed</b>: The repository failed to associate or disassociate.</p>
|
|
1600
1299
|
* </li>
|
|
1601
1300
|
* <li>
|
|
1602
1301
|
* <p>
|
|
1603
|
-
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and
|
|
1604
|
-
* source code access.
|
|
1605
|
-
* </p>
|
|
1302
|
+
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.</p>
|
|
1606
1303
|
* </li>
|
|
1607
1304
|
* <li>
|
|
1608
1305
|
* <p>
|
|
1609
|
-
* <b>Disassociated</b>: CodeGuru Reviewer successfully disassociated the repository. You can create a new association
|
|
1610
|
-
* with this repository if you want to review source code in it later. You can control access to code reviews created in an
|
|
1611
|
-
* associated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to
|
|
1612
|
-
* associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
|
|
1613
|
-
* </p>
|
|
1306
|
+
* <b>Disassociated</b>: 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 anassociated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p>
|
|
1614
1307
|
* </li>
|
|
1615
1308
|
* </ul>
|
|
1616
1309
|
*/
|
|
@@ -1620,78 +1313,55 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1620
1313
|
*/
|
|
1621
1314
|
Names?: string[];
|
|
1622
1315
|
/**
|
|
1623
|
-
* <p>List of owners to use as a filter.
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1316
|
+
* <p>List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the
|
|
1317
|
+
* CodeCommit account that was used to associate the repository. For other repository source
|
|
1318
|
+
* providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that
|
|
1319
|
+
* was used to associate the repository. </p>
|
|
1627
1320
|
*/
|
|
1628
1321
|
Owners?: string[];
|
|
1629
1322
|
/**
|
|
1630
|
-
* <p>The maximum number of repository association results returned by
|
|
1631
|
-
*
|
|
1632
|
-
* <code>
|
|
1633
|
-
* element. The remaining results of
|
|
1634
|
-
* can be seen by sending another <code>ListRepositoryAssociations</code>
|
|
1635
|
-
* <code>nextToken</code> value.
|
|
1636
|
-
*
|
|
1637
|
-
*
|
|
1323
|
+
* <p>The maximum number of repository association results returned by
|
|
1324
|
+
* <code>ListRepositoryAssociations</code> in paginated output. When this parameter is
|
|
1325
|
+
* used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results
|
|
1326
|
+
* in a single page with a <code>nextToken</code> response element. The remaining results of
|
|
1327
|
+
* the initial request can be seen by sending another <code>ListRepositoryAssociations</code>
|
|
1328
|
+
* request with the returned <code>nextToken</code> value. This value can be between 1 and
|
|
1329
|
+
* 100. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to
|
|
1330
|
+
* 100 results and a <code>nextToken</code> value if applicable. </p>
|
|
1638
1331
|
*/
|
|
1639
1332
|
MaxResults?: number;
|
|
1640
1333
|
/**
|
|
1641
1334
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1642
|
-
*
|
|
1643
|
-
* exceeded the value of that parameter. Pagination continues from the end of
|
|
1644
|
-
* that returned the <code>nextToken</code> value.
|
|
1645
|
-
* </p>
|
|
1335
|
+
* <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used
|
|
1336
|
+
* and the results exceeded the value of that parameter. Pagination continues from the end of
|
|
1337
|
+
* the previous results that returned the <code>nextToken</code> value. </p>
|
|
1646
1338
|
* <note>
|
|
1647
|
-
* <p>Treat this token as an opaque identifier that is only used to retrieve
|
|
1648
|
-
*
|
|
1339
|
+
* <p>Treat this token as an opaque identifier that is only used to retrieve the next items
|
|
1340
|
+
* in a list and not for other programmatic purposes.</p>
|
|
1649
1341
|
* </note>
|
|
1650
1342
|
*/
|
|
1651
1343
|
NextToken?: string;
|
|
1652
1344
|
}
|
|
1653
1345
|
/**
|
|
1654
|
-
* <p>Summary information about a repository association. The
|
|
1655
|
-
*
|
|
1656
|
-
* <code>ListRepositoryAssociations</code>
|
|
1657
|
-
* </a>
|
|
1658
|
-
* operation returns a list of <code>RepositoryAssociationSummary</code> objects.</p>
|
|
1346
|
+
* <p>Summary information about a repository association. The <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a> operation returns a list of
|
|
1347
|
+
* <code>RepositoryAssociationSummary</code> objects.</p>
|
|
1659
1348
|
*/
|
|
1660
1349
|
export interface RepositoryAssociationSummary {
|
|
1661
1350
|
/**
|
|
1662
|
-
* <p>
|
|
1663
|
-
* The Amazon Resource Name (ARN) of the
|
|
1664
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1665
|
-
* <code>RepositoryAssociation</code>
|
|
1666
|
-
* </a> object.
|
|
1667
|
-
* You can retrieve this ARN by calling
|
|
1668
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1669
|
-
* <code>ListRepositoryAssociations</code>
|
|
1670
|
-
* </a>.
|
|
1671
|
-
* </p>
|
|
1351
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1672
1352
|
*/
|
|
1673
1353
|
AssociationArn?: string;
|
|
1674
1354
|
/**
|
|
1675
|
-
* <p>
|
|
1676
|
-
* The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is
|
|
1677
|
-
* <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see
|
|
1678
|
-
* <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">
|
|
1679
|
-
* <code>Connection</code>
|
|
1680
|
-
* </a> in
|
|
1681
|
-
* the <i>Amazon Web Services CodeStar Connections API Reference</i>.
|
|
1682
|
-
* </p>
|
|
1355
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.</p>
|
|
1683
1356
|
*/
|
|
1684
1357
|
ConnectionArn?: string;
|
|
1685
1358
|
/**
|
|
1686
|
-
* <p>The time, in milliseconds since the epoch, since the repository association
|
|
1687
|
-
*
|
|
1688
|
-
* </p>
|
|
1359
|
+
* <p>The time, in milliseconds since the epoch, since the repository association was last
|
|
1360
|
+
* updated.</p>
|
|
1689
1361
|
*/
|
|
1690
1362
|
LastUpdatedTimeStamp?: Date;
|
|
1691
1363
|
/**
|
|
1692
|
-
* <p>
|
|
1693
|
-
* The repository association ID.
|
|
1694
|
-
* </p>
|
|
1364
|
+
* <p>The repository association ID.</p>
|
|
1695
1365
|
*/
|
|
1696
1366
|
AssociationId?: string;
|
|
1697
1367
|
/**
|
|
@@ -1714,54 +1384,35 @@ export interface RepositoryAssociationSummary {
|
|
|
1714
1384
|
* <ul>
|
|
1715
1385
|
* <li>
|
|
1716
1386
|
* <p>
|
|
1717
|
-
* <b>Associated</b>: The repository
|
|
1718
|
-
* association is complete.
|
|
1719
|
-
* </p>
|
|
1387
|
+
* <b>Associated</b>: The repository association is complete.</p>
|
|
1720
1388
|
* </li>
|
|
1721
1389
|
* <li>
|
|
1722
1390
|
* <p>
|
|
1723
|
-
* <b>Associating</b>: CodeGuru Reviewer is
|
|
1724
|
-
* </p>
|
|
1391
|
+
* <b>Associating</b>: CodeGuru Reviewer is:</p>
|
|
1725
1392
|
* <ul>
|
|
1726
1393
|
* <li>
|
|
1727
|
-
* <p>
|
|
1728
|
-
*
|
|
1729
|
-
* for pull requests to trigger a CodeGuru Reviewer review.
|
|
1730
|
-
* </p>
|
|
1394
|
+
* <p>Setting up pull request notifications. This is required
|
|
1395
|
+
* for pull requests to trigger a CodeGuru Reviewer review.</p>
|
|
1731
1396
|
* <note>
|
|
1732
|
-
* <p>
|
|
1733
|
-
* If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>,
|
|
1734
|
-
* CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks,
|
|
1735
|
-
* reviews of code in your repository cannot be triggered.
|
|
1736
|
-
* </p>
|
|
1397
|
+
* <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p>
|
|
1737
1398
|
* </note>
|
|
1738
1399
|
* </li>
|
|
1739
1400
|
* <li>
|
|
1740
|
-
* <p>
|
|
1741
|
-
* Setting up source code access. This is required for CodeGuru Reviewer to securely
|
|
1742
|
-
* clone code in your repository.
|
|
1743
|
-
* </p>
|
|
1401
|
+
* <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p>
|
|
1744
1402
|
* </li>
|
|
1745
1403
|
* </ul>
|
|
1746
1404
|
* </li>
|
|
1747
1405
|
* <li>
|
|
1748
1406
|
* <p>
|
|
1749
|
-
* <b>Failed</b>: The repository failed to associate or disassociate
|
|
1750
|
-
* </p>
|
|
1407
|
+
* <b>Failed</b>: The repository failed to associate or disassociate.</p>
|
|
1751
1408
|
* </li>
|
|
1752
1409
|
* <li>
|
|
1753
1410
|
* <p>
|
|
1754
|
-
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and
|
|
1755
|
-
* source code access.
|
|
1756
|
-
* </p>
|
|
1411
|
+
* <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.</p>
|
|
1757
1412
|
* </li>
|
|
1758
1413
|
* <li>
|
|
1759
1414
|
* <p>
|
|
1760
|
-
* <b>Disassociated</b>: CodeGuru Reviewer successfully disassociated the repository. You can create a new association
|
|
1761
|
-
* with this repository if you want to review source code in it later. You can control access to code reviews created in an
|
|
1762
|
-
* associated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to
|
|
1763
|
-
* associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
|
|
1764
|
-
* </p>
|
|
1415
|
+
* <b>Disassociated</b>: 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 anassociated repository with tags after it has been disassociated. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p>
|
|
1765
1416
|
* </li>
|
|
1766
1417
|
* </ul>
|
|
1767
1418
|
*/
|
|
@@ -1773,33 +1424,22 @@ export interface ListRepositoryAssociationsResponse {
|
|
|
1773
1424
|
*/
|
|
1774
1425
|
RepositoryAssociationSummaries?: RepositoryAssociationSummary[];
|
|
1775
1426
|
/**
|
|
1776
|
-
* <p>The <code>nextToken</code> value to include in a future <code>ListRecommendations</code>
|
|
1777
|
-
* When the results of a <code>ListRecommendations</code> request exceed
|
|
1778
|
-
*
|
|
1779
|
-
* results to return. </p>
|
|
1427
|
+
* <p>The <code>nextToken</code> value to include in a future <code>ListRecommendations</code>
|
|
1428
|
+
* request. When the results of a <code>ListRecommendations</code> request exceed
|
|
1429
|
+
* <code>maxResults</code>, this value can be used to retrieve the next page of results.
|
|
1430
|
+
* This value is <code>null</code> when there are no more results to return. </p>
|
|
1780
1431
|
*/
|
|
1781
1432
|
NextToken?: string;
|
|
1782
1433
|
}
|
|
1783
1434
|
export interface ListTagsForResourceRequest {
|
|
1784
1435
|
/**
|
|
1785
|
-
* <p>
|
|
1786
|
-
* The Amazon Resource Name (ARN) of the
|
|
1787
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1788
|
-
* <code>RepositoryAssociation</code>
|
|
1789
|
-
* </a> object.
|
|
1790
|
-
* You can retrieve this ARN by calling
|
|
1791
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1792
|
-
* <code>ListRepositoryAssociations</code>
|
|
1793
|
-
* </a>.
|
|
1794
|
-
* </p>
|
|
1436
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1795
1437
|
*/
|
|
1796
1438
|
resourceArn: string | undefined;
|
|
1797
1439
|
}
|
|
1798
1440
|
export interface ListTagsForResourceResponse {
|
|
1799
1441
|
/**
|
|
1800
|
-
* <p>
|
|
1801
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
1802
|
-
* </p>
|
|
1442
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1803
1443
|
* <ul>
|
|
1804
1444
|
* <li>
|
|
1805
1445
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -1818,22 +1458,18 @@ export interface ListTagsForResourceResponse {
|
|
|
1818
1458
|
}
|
|
1819
1459
|
export interface PutRecommendationFeedbackRequest {
|
|
1820
1460
|
/**
|
|
1821
|
-
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">
|
|
1822
|
-
* <code>CodeReview</code>
|
|
1823
|
-
* </a> object.
|
|
1461
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object.
|
|
1824
1462
|
* </p>
|
|
1825
1463
|
*/
|
|
1826
1464
|
CodeReviewArn: string | undefined;
|
|
1827
1465
|
/**
|
|
1828
|
-
* <p>
|
|
1829
|
-
*
|
|
1830
|
-
* </p>
|
|
1466
|
+
* <p>The recommendation ID that can be used to track the provided recommendations and then to
|
|
1467
|
+
* collect the feedback.</p>
|
|
1831
1468
|
*/
|
|
1832
1469
|
RecommendationId: string | undefined;
|
|
1833
1470
|
/**
|
|
1834
|
-
* <p>
|
|
1835
|
-
*
|
|
1836
|
-
* </p>
|
|
1471
|
+
* <p>List for storing reactions. Reactions are utf-8 text code for emojis. If you send an
|
|
1472
|
+
* empty list it clears all your feedback.</p>
|
|
1837
1473
|
*/
|
|
1838
1474
|
Reactions: (Reaction | string)[] | undefined;
|
|
1839
1475
|
}
|
|
@@ -1841,22 +1477,11 @@ export interface PutRecommendationFeedbackResponse {
|
|
|
1841
1477
|
}
|
|
1842
1478
|
export interface TagResourceRequest {
|
|
1843
1479
|
/**
|
|
1844
|
-
* <p>
|
|
1845
|
-
* The Amazon Resource Name (ARN) of the
|
|
1846
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1847
|
-
* <code>RepositoryAssociation</code>
|
|
1848
|
-
* </a> object.
|
|
1849
|
-
* You can retrieve this ARN by calling
|
|
1850
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1851
|
-
* <code>ListRepositoryAssociations</code>
|
|
1852
|
-
* </a>.
|
|
1853
|
-
* </p>
|
|
1480
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1854
1481
|
*/
|
|
1855
1482
|
resourceArn: string | undefined;
|
|
1856
1483
|
/**
|
|
1857
|
-
* <p>
|
|
1858
|
-
* An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:
|
|
1859
|
-
* </p>
|
|
1484
|
+
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1860
1485
|
* <ul>
|
|
1861
1486
|
* <li>
|
|
1862
1487
|
* <p>A <i>tag key</i> (for example, <code>CostCenter</code>,
|
|
@@ -1877,16 +1502,7 @@ export interface TagResourceResponse {
|
|
|
1877
1502
|
}
|
|
1878
1503
|
export interface UntagResourceRequest {
|
|
1879
1504
|
/**
|
|
1880
|
-
* <p>
|
|
1881
|
-
* The Amazon Resource Name (ARN) of the
|
|
1882
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
|
|
1883
|
-
* <code>RepositoryAssociation</code>
|
|
1884
|
-
* </a> object.
|
|
1885
|
-
* You can retrieve this ARN by calling
|
|
1886
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">
|
|
1887
|
-
* <code>ListRepositoryAssociations</code>
|
|
1888
|
-
* </a>.
|
|
1889
|
-
* </p>
|
|
1505
|
+
* <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
1890
1506
|
*/
|
|
1891
1507
|
resourceArn: string | undefined;
|
|
1892
1508
|
/**
|