@aws-sdk/client-codeguru-reviewer 3.379.1 → 3.382.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/dist-types/models/models_0.d.ts +175 -0
- package/package.json +5 -5
|
@@ -54,10 +54,12 @@ export type EncryptionOption = (typeof EncryptionOption)[keyof typeof Encryption
|
|
|
54
54
|
*/
|
|
55
55
|
export interface KMSKeyDetails {
|
|
56
56
|
/**
|
|
57
|
+
* @public
|
|
57
58
|
* <p>The ID of the Amazon Web Services KMS key that is associated with a repository association.</p>
|
|
58
59
|
*/
|
|
59
60
|
KMSKeyId?: string;
|
|
60
61
|
/**
|
|
62
|
+
* @public
|
|
61
63
|
* <p>The encryption option for a repository association. It is either owned by Amazon Web Services Key
|
|
62
64
|
* Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed
|
|
63
65
|
* (<code>CUSTOMER_MANAGED_CMK</code>).</p>
|
|
@@ -70,14 +72,17 @@ export interface KMSKeyDetails {
|
|
|
70
72
|
*/
|
|
71
73
|
export interface ThirdPartySourceRepository {
|
|
72
74
|
/**
|
|
75
|
+
* @public
|
|
73
76
|
* <p>The name of the third party source repository.</p>
|
|
74
77
|
*/
|
|
75
78
|
Name: string | undefined;
|
|
76
79
|
/**
|
|
80
|
+
* @public
|
|
77
81
|
* <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>
|
|
78
82
|
*/
|
|
79
83
|
ConnectionArn: string | undefined;
|
|
80
84
|
/**
|
|
85
|
+
* @public
|
|
81
86
|
* <p>The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository,
|
|
82
87
|
* this is the username for the account that owns the repository. For an S3 repository, this
|
|
83
88
|
* can be the username or Amazon Web Services account ID </p>
|
|
@@ -92,6 +97,7 @@ export interface ThirdPartySourceRepository {
|
|
|
92
97
|
*/
|
|
93
98
|
export interface CodeCommitRepository {
|
|
94
99
|
/**
|
|
100
|
+
* @public
|
|
95
101
|
* <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
|
|
96
102
|
* Reference</i>.</p>
|
|
97
103
|
*/
|
|
@@ -103,10 +109,12 @@ export interface CodeCommitRepository {
|
|
|
103
109
|
*/
|
|
104
110
|
export interface S3Repository {
|
|
105
111
|
/**
|
|
112
|
+
* @public
|
|
106
113
|
* <p>The name of the repository in the S3 bucket.</p>
|
|
107
114
|
*/
|
|
108
115
|
Name: string | undefined;
|
|
109
116
|
/**
|
|
117
|
+
* @public
|
|
110
118
|
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with <code>codeguru-reviewer-</code>. </p>
|
|
111
119
|
*/
|
|
112
120
|
BucketName: string | undefined;
|
|
@@ -120,18 +128,22 @@ export interface S3Repository {
|
|
|
120
128
|
*/
|
|
121
129
|
export interface Repository {
|
|
122
130
|
/**
|
|
131
|
+
* @public
|
|
123
132
|
* <p>Information about an Amazon Web Services CodeCommit repository.</p>
|
|
124
133
|
*/
|
|
125
134
|
CodeCommit?: CodeCommitRepository;
|
|
126
135
|
/**
|
|
136
|
+
* @public
|
|
127
137
|
* <p> Information about a Bitbucket repository. </p>
|
|
128
138
|
*/
|
|
129
139
|
Bitbucket?: ThirdPartySourceRepository;
|
|
130
140
|
/**
|
|
141
|
+
* @public
|
|
131
142
|
* <p>Information about a GitHub Enterprise Server repository.</p>
|
|
132
143
|
*/
|
|
133
144
|
GitHubEnterpriseServer?: ThirdPartySourceRepository;
|
|
134
145
|
/**
|
|
146
|
+
* @public
|
|
135
147
|
* <p>Information about a repository in an S3 bucket.</p>
|
|
136
148
|
*/
|
|
137
149
|
S3Bucket?: S3Repository;
|
|
@@ -141,15 +153,18 @@ export interface Repository {
|
|
|
141
153
|
*/
|
|
142
154
|
export interface AssociateRepositoryRequest {
|
|
143
155
|
/**
|
|
156
|
+
* @public
|
|
144
157
|
* <p>The repository to associate.</p>
|
|
145
158
|
*/
|
|
146
159
|
Repository: Repository | undefined;
|
|
147
160
|
/**
|
|
161
|
+
* @public
|
|
148
162
|
* <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository
|
|
149
163
|
* associations if there are failures and retries.</p>
|
|
150
164
|
*/
|
|
151
165
|
ClientRequestToken?: string;
|
|
152
166
|
/**
|
|
167
|
+
* @public
|
|
153
168
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
154
169
|
* <ul>
|
|
155
170
|
* <li>
|
|
@@ -167,6 +182,7 @@ export interface AssociateRepositoryRequest {
|
|
|
167
182
|
*/
|
|
168
183
|
Tags?: Record<string, string>;
|
|
169
184
|
/**
|
|
185
|
+
* @public
|
|
170
186
|
* <p>A <code>KMSKeyDetails</code> object that contains:</p>
|
|
171
187
|
* <ul>
|
|
172
188
|
* <li>
|
|
@@ -214,11 +230,13 @@ export type ProviderType = (typeof ProviderType)[keyof typeof ProviderType];
|
|
|
214
230
|
*/
|
|
215
231
|
export interface CodeArtifacts {
|
|
216
232
|
/**
|
|
233
|
+
* @public
|
|
217
234
|
* <p>The S3 object key for a source code .zip file. This is required for all code
|
|
218
235
|
* reviews.</p>
|
|
219
236
|
*/
|
|
220
237
|
SourceCodeArtifactsObjectKey: string | undefined;
|
|
221
238
|
/**
|
|
239
|
+
* @public
|
|
222
240
|
* <p>The S3 object key for a build artifacts .zip file that contains .jar or .class files.
|
|
223
241
|
* 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/working-with-cicd.html">Create
|
|
224
242
|
* code reviews with GitHub Actions</a> in the <i>Amazon CodeGuru Reviewer User
|
|
@@ -234,10 +252,12 @@ export interface CodeArtifacts {
|
|
|
234
252
|
*/
|
|
235
253
|
export interface S3RepositoryDetails {
|
|
236
254
|
/**
|
|
255
|
+
* @public
|
|
237
256
|
* <p>The name of the S3 bucket used for associating a new S3 repository. It must begin with <code>codeguru-reviewer-</code>. </p>
|
|
238
257
|
*/
|
|
239
258
|
BucketName?: string;
|
|
240
259
|
/**
|
|
260
|
+
* @public
|
|
241
261
|
* <p>A <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> object includes the
|
|
242
262
|
* S3 object key for a source code .zip file and for a build artifacts .zip file that contains
|
|
243
263
|
* .jar or .class files.</p>
|
|
@@ -266,32 +286,39 @@ export type RepositoryAssociationState = (typeof RepositoryAssociationState)[key
|
|
|
266
286
|
*/
|
|
267
287
|
export interface RepositoryAssociation {
|
|
268
288
|
/**
|
|
289
|
+
* @public
|
|
269
290
|
* <p>The ID of the repository association.</p>
|
|
270
291
|
*/
|
|
271
292
|
AssociationId?: string;
|
|
272
293
|
/**
|
|
294
|
+
* @public
|
|
273
295
|
* <p>The Amazon Resource Name (ARN) identifying the repository association.</p>
|
|
274
296
|
*/
|
|
275
297
|
AssociationArn?: string;
|
|
276
298
|
/**
|
|
299
|
+
* @public
|
|
277
300
|
* <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>
|
|
278
301
|
*/
|
|
279
302
|
ConnectionArn?: string;
|
|
280
303
|
/**
|
|
304
|
+
* @public
|
|
281
305
|
* <p>The name of the repository.</p>
|
|
282
306
|
*/
|
|
283
307
|
Name?: string;
|
|
284
308
|
/**
|
|
309
|
+
* @public
|
|
285
310
|
* <p>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the
|
|
286
311
|
* account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
|
|
287
312
|
* For an S3 repository, it can be the username or Amazon Web Services account ID.</p>
|
|
288
313
|
*/
|
|
289
314
|
Owner?: string;
|
|
290
315
|
/**
|
|
316
|
+
* @public
|
|
291
317
|
* <p>The provider type of the repository association.</p>
|
|
292
318
|
*/
|
|
293
319
|
ProviderType?: ProviderType | string;
|
|
294
320
|
/**
|
|
321
|
+
* @public
|
|
295
322
|
* <p>The state of the repository association.</p>
|
|
296
323
|
* <p>The valid repository association states are:</p>
|
|
297
324
|
* <ul>
|
|
@@ -331,20 +358,24 @@ export interface RepositoryAssociation {
|
|
|
331
358
|
*/
|
|
332
359
|
State?: RepositoryAssociationState | string;
|
|
333
360
|
/**
|
|
361
|
+
* @public
|
|
334
362
|
* <p>A description of why the repository association is in the current state.</p>
|
|
335
363
|
*/
|
|
336
364
|
StateReason?: string;
|
|
337
365
|
/**
|
|
366
|
+
* @public
|
|
338
367
|
* <p>The time, in milliseconds since the epoch, when the repository association was last
|
|
339
368
|
* updated.</p>
|
|
340
369
|
*/
|
|
341
370
|
LastUpdatedTimeStamp?: Date;
|
|
342
371
|
/**
|
|
372
|
+
* @public
|
|
343
373
|
* <p>The time, in milliseconds since the epoch, when the repository association was
|
|
344
374
|
* created.</p>
|
|
345
375
|
*/
|
|
346
376
|
CreatedTimeStamp?: Date;
|
|
347
377
|
/**
|
|
378
|
+
* @public
|
|
348
379
|
* <p>A <code>KMSKeyDetails</code> object that contains:</p>
|
|
349
380
|
* <ul>
|
|
350
381
|
* <li>
|
|
@@ -360,6 +391,7 @@ export interface RepositoryAssociation {
|
|
|
360
391
|
*/
|
|
361
392
|
KMSKeyDetails?: KMSKeyDetails;
|
|
362
393
|
/**
|
|
394
|
+
* @public
|
|
363
395
|
* <p>Specifies the name of an S3 bucket and a <code>CodeArtifacts</code> object that contains
|
|
364
396
|
* the S3 object keys for a source code .zip file and for a build artifacts .zip file that
|
|
365
397
|
* contains .jar or .class files.</p>
|
|
@@ -371,10 +403,12 @@ export interface RepositoryAssociation {
|
|
|
371
403
|
*/
|
|
372
404
|
export interface AssociateRepositoryResponse {
|
|
373
405
|
/**
|
|
406
|
+
* @public
|
|
374
407
|
* <p>Information about the repository association.</p>
|
|
375
408
|
*/
|
|
376
409
|
RepositoryAssociation?: RepositoryAssociation;
|
|
377
410
|
/**
|
|
411
|
+
* @public
|
|
378
412
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
379
413
|
* <ul>
|
|
380
414
|
* <li>
|
|
@@ -453,6 +487,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
453
487
|
*/
|
|
454
488
|
export interface RepositoryHeadSourceCodeType {
|
|
455
489
|
/**
|
|
490
|
+
* @public
|
|
456
491
|
* <p>The name of the branch in an associated repository. The
|
|
457
492
|
* <code>RepositoryHeadSourceCodeType</code> specifies the tip of this branch.</p>
|
|
458
493
|
*/
|
|
@@ -466,10 +501,12 @@ export interface RepositoryHeadSourceCodeType {
|
|
|
466
501
|
*/
|
|
467
502
|
export interface BranchDiffSourceCodeType {
|
|
468
503
|
/**
|
|
504
|
+
* @public
|
|
469
505
|
* <p>The source branch for a diff in an associated repository.</p>
|
|
470
506
|
*/
|
|
471
507
|
SourceBranchName: string | undefined;
|
|
472
508
|
/**
|
|
509
|
+
* @public
|
|
473
510
|
* <p>The destination branch for a diff in an associated repository.</p>
|
|
474
511
|
*/
|
|
475
512
|
DestinationBranchName: string | undefined;
|
|
@@ -483,16 +520,19 @@ export interface BranchDiffSourceCodeType {
|
|
|
483
520
|
*/
|
|
484
521
|
export interface CommitDiffSourceCodeType {
|
|
485
522
|
/**
|
|
523
|
+
* @public
|
|
486
524
|
* <p>The SHA of the source commit used to generate a commit diff. This field is required for
|
|
487
525
|
* a pull request code review.</p>
|
|
488
526
|
*/
|
|
489
527
|
SourceCommit?: string;
|
|
490
528
|
/**
|
|
529
|
+
* @public
|
|
491
530
|
* <p>The SHA of the destination commit used to generate a commit diff. This field is required
|
|
492
531
|
* for a pull request code review.</p>
|
|
493
532
|
*/
|
|
494
533
|
DestinationCommit?: string;
|
|
495
534
|
/**
|
|
535
|
+
* @public
|
|
496
536
|
* <p>The SHA of the merge base of a commit.</p>
|
|
497
537
|
*/
|
|
498
538
|
MergeBaseCommit?: string;
|
|
@@ -504,12 +544,14 @@ export interface CommitDiffSourceCodeType {
|
|
|
504
544
|
*/
|
|
505
545
|
export interface EventInfo {
|
|
506
546
|
/**
|
|
547
|
+
* @public
|
|
507
548
|
* <p>The name of the event. The possible names are <code>pull_request</code>,
|
|
508
549
|
* <code>workflow_dispatch</code>, <code>schedule</code>, and <code>push</code>
|
|
509
550
|
* </p>
|
|
510
551
|
*/
|
|
511
552
|
Name?: string;
|
|
512
553
|
/**
|
|
554
|
+
* @public
|
|
513
555
|
* <p>The state of an event. The state might be open, closed, or another state.</p>
|
|
514
556
|
*/
|
|
515
557
|
State?: string;
|
|
@@ -534,20 +576,24 @@ export type VendorName = (typeof VendorName)[keyof typeof VendorName];
|
|
|
534
576
|
*/
|
|
535
577
|
export interface RequestMetadata {
|
|
536
578
|
/**
|
|
579
|
+
* @public
|
|
537
580
|
* <p>The ID of the request. This is required for a pull request code review.</p>
|
|
538
581
|
*/
|
|
539
582
|
RequestId?: string;
|
|
540
583
|
/**
|
|
584
|
+
* @public
|
|
541
585
|
* <p>An identifier, such as a name or account ID, that is associated with the requester. The
|
|
542
586
|
* <code>Requester</code> is used to capture the <code>author/actor</code> name of the
|
|
543
587
|
* event request.</p>
|
|
544
588
|
*/
|
|
545
589
|
Requester?: string;
|
|
546
590
|
/**
|
|
591
|
+
* @public
|
|
547
592
|
* <p>Information about the event associated with a code review.</p>
|
|
548
593
|
*/
|
|
549
594
|
EventInfo?: EventInfo;
|
|
550
595
|
/**
|
|
596
|
+
* @public
|
|
551
597
|
* <p>The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code
|
|
552
598
|
* review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code
|
|
553
599
|
* review by GitHub scripts from a GitHub repository, then the repository association's
|
|
@@ -564,11 +610,13 @@ export interface RequestMetadata {
|
|
|
564
610
|
*/
|
|
565
611
|
export interface S3BucketRepository {
|
|
566
612
|
/**
|
|
613
|
+
* @public
|
|
567
614
|
* <p>The name of the repository when the <code>ProviderType</code> is
|
|
568
615
|
* <code>S3Bucket</code>.</p>
|
|
569
616
|
*/
|
|
570
617
|
Name: string | undefined;
|
|
571
618
|
/**
|
|
619
|
+
* @public
|
|
572
620
|
* <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>
|
|
573
621
|
*/
|
|
574
622
|
Details?: S3RepositoryDetails;
|
|
@@ -579,26 +627,31 @@ export interface S3BucketRepository {
|
|
|
579
627
|
*/
|
|
580
628
|
export interface SourceCodeType {
|
|
581
629
|
/**
|
|
630
|
+
* @public
|
|
582
631
|
* <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
|
|
583
632
|
* associated repository.</p>
|
|
584
633
|
*/
|
|
585
634
|
CommitDiff?: CommitDiffSourceCodeType;
|
|
586
635
|
/**
|
|
636
|
+
* @public
|
|
587
637
|
* <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
|
|
588
638
|
* repository.</p>
|
|
589
639
|
*/
|
|
590
640
|
RepositoryHead?: RepositoryHeadSourceCodeType;
|
|
591
641
|
/**
|
|
642
|
+
* @public
|
|
592
643
|
* <p>A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that
|
|
593
644
|
* specifies a source branch name and a destination branch name in an associated
|
|
594
645
|
* repository.</p>
|
|
595
646
|
*/
|
|
596
647
|
BranchDiff?: BranchDiffSourceCodeType;
|
|
597
648
|
/**
|
|
649
|
+
* @public
|
|
598
650
|
* <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>
|
|
599
651
|
*/
|
|
600
652
|
S3BucketRepository?: S3BucketRepository;
|
|
601
653
|
/**
|
|
654
|
+
* @public
|
|
602
655
|
* <p>Metadata that is associated with a code review. This applies to any type of code review
|
|
603
656
|
* supported by CodeGuru Reviewer. The <code>RequestMetadaa</code> field captures any event metadata. For
|
|
604
657
|
* example, it might capture metadata associated with an event trigger, such as a push or a
|
|
@@ -613,11 +666,13 @@ export interface SourceCodeType {
|
|
|
613
666
|
*/
|
|
614
667
|
export interface RepositoryAnalysis {
|
|
615
668
|
/**
|
|
669
|
+
* @public
|
|
616
670
|
* <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
|
|
617
671
|
* repository.</p>
|
|
618
672
|
*/
|
|
619
673
|
RepositoryHead?: RepositoryHeadSourceCodeType;
|
|
620
674
|
/**
|
|
675
|
+
* @public
|
|
621
676
|
* <p>Specifies the source code that is analyzed in a code review.</p>
|
|
622
677
|
*/
|
|
623
678
|
SourceCodeType?: SourceCodeType;
|
|
@@ -641,11 +696,13 @@ export interface RepositoryAnalysis {
|
|
|
641
696
|
*/
|
|
642
697
|
export interface CodeReviewType {
|
|
643
698
|
/**
|
|
699
|
+
* @public
|
|
644
700
|
* <p>A code review that analyzes all code under a specified branch in an associated
|
|
645
701
|
* 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>
|
|
646
702
|
*/
|
|
647
703
|
RepositoryAnalysis: RepositoryAnalysis | undefined;
|
|
648
704
|
/**
|
|
705
|
+
* @public
|
|
649
706
|
* <p>They types of analysis performed during a repository analysis or a pull request review.
|
|
650
707
|
* You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
651
708
|
*/
|
|
@@ -656,22 +713,26 @@ export interface CodeReviewType {
|
|
|
656
713
|
*/
|
|
657
714
|
export interface CreateCodeReviewRequest {
|
|
658
715
|
/**
|
|
716
|
+
* @public
|
|
659
717
|
* <p>The name of the code review. The name of each code review in your Amazon Web Services account must be
|
|
660
718
|
* unique.</p>
|
|
661
719
|
*/
|
|
662
720
|
Name: string | undefined;
|
|
663
721
|
/**
|
|
722
|
+
* @public
|
|
664
723
|
* <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>
|
|
665
724
|
* <p>A code review can only be created on an associated repository. This is the ARN of the
|
|
666
725
|
* associated repository.</p>
|
|
667
726
|
*/
|
|
668
727
|
RepositoryAssociationArn: string | undefined;
|
|
669
728
|
/**
|
|
729
|
+
* @public
|
|
670
730
|
* <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>
|
|
671
731
|
* object. You can create a code review only of type <code>RepositoryAnalysis</code>.</p>
|
|
672
732
|
*/
|
|
673
733
|
Type: CodeReviewType | undefined;
|
|
674
734
|
/**
|
|
735
|
+
* @public
|
|
675
736
|
* <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews
|
|
676
737
|
* if there are failures and retries.</p>
|
|
677
738
|
*/
|
|
@@ -696,6 +757,7 @@ export type ConfigFileState = (typeof ConfigFileState)[keyof typeof ConfigFileSt
|
|
|
696
757
|
*/
|
|
697
758
|
export interface Metrics {
|
|
698
759
|
/**
|
|
760
|
+
* @public
|
|
699
761
|
* <p>
|
|
700
762
|
* <code>MeteredLinesOfCodeCount</code> is the number of lines of code in the repository
|
|
701
763
|
* where the code review happened. This does not include non-code lines such as comments and
|
|
@@ -703,6 +765,7 @@ export interface Metrics {
|
|
|
703
765
|
*/
|
|
704
766
|
MeteredLinesOfCodeCount?: number;
|
|
705
767
|
/**
|
|
768
|
+
* @public
|
|
706
769
|
* <p>
|
|
707
770
|
* <code>SuppressedLinesOfCodeCount</code> is the number of lines of code in the repository
|
|
708
771
|
* where the code review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the
|
|
@@ -712,6 +775,7 @@ export interface Metrics {
|
|
|
712
775
|
*/
|
|
713
776
|
SuppressedLinesOfCodeCount?: number;
|
|
714
777
|
/**
|
|
778
|
+
* @public
|
|
715
779
|
* <p>Total number of recommendations found in the code review.</p>
|
|
716
780
|
*/
|
|
717
781
|
FindingsCount?: number;
|
|
@@ -749,30 +813,36 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
749
813
|
*/
|
|
750
814
|
export interface CodeReview {
|
|
751
815
|
/**
|
|
816
|
+
* @public
|
|
752
817
|
* <p>The name of the code review.</p>
|
|
753
818
|
*/
|
|
754
819
|
Name?: string;
|
|
755
820
|
/**
|
|
821
|
+
* @public
|
|
756
822
|
* <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.
|
|
757
823
|
* </p>
|
|
758
824
|
*/
|
|
759
825
|
CodeReviewArn?: string;
|
|
760
826
|
/**
|
|
827
|
+
* @public
|
|
761
828
|
* <p>The name of the repository.</p>
|
|
762
829
|
*/
|
|
763
830
|
RepositoryName?: string;
|
|
764
831
|
/**
|
|
832
|
+
* @public
|
|
765
833
|
* <p>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the
|
|
766
834
|
* account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
|
|
767
835
|
* For an S3 repository, it can be the username or Amazon Web Services account ID.</p>
|
|
768
836
|
*/
|
|
769
837
|
Owner?: string;
|
|
770
838
|
/**
|
|
839
|
+
* @public
|
|
771
840
|
* <p>The type of repository that contains the reviewed code (for example, GitHub or
|
|
772
841
|
* Bitbucket).</p>
|
|
773
842
|
*/
|
|
774
843
|
ProviderType?: ProviderType | string;
|
|
775
844
|
/**
|
|
845
|
+
* @public
|
|
776
846
|
* <p>The valid code review states are:</p>
|
|
777
847
|
* <ul>
|
|
778
848
|
* <li>
|
|
@@ -795,44 +865,54 @@ export interface CodeReview {
|
|
|
795
865
|
*/
|
|
796
866
|
State?: JobState | string;
|
|
797
867
|
/**
|
|
868
|
+
* @public
|
|
798
869
|
* <p>The reason for the state of the code review.</p>
|
|
799
870
|
*/
|
|
800
871
|
StateReason?: string;
|
|
801
872
|
/**
|
|
873
|
+
* @public
|
|
802
874
|
* <p>The time, in milliseconds since the epoch, when the code review was created.</p>
|
|
803
875
|
*/
|
|
804
876
|
CreatedTimeStamp?: Date;
|
|
805
877
|
/**
|
|
878
|
+
* @public
|
|
806
879
|
* <p>The time, in milliseconds since the epoch, when the code review was last updated.</p>
|
|
807
880
|
*/
|
|
808
881
|
LastUpdatedTimeStamp?: Date;
|
|
809
882
|
/**
|
|
883
|
+
* @public
|
|
810
884
|
* <p>The type of code review.</p>
|
|
811
885
|
*/
|
|
812
886
|
Type?: Type | string;
|
|
813
887
|
/**
|
|
888
|
+
* @public
|
|
814
889
|
* <p>The pull request ID for the code review.</p>
|
|
815
890
|
*/
|
|
816
891
|
PullRequestId?: string;
|
|
817
892
|
/**
|
|
893
|
+
* @public
|
|
818
894
|
* <p>The type of the source code for the code review.</p>
|
|
819
895
|
*/
|
|
820
896
|
SourceCodeType?: SourceCodeType;
|
|
821
897
|
/**
|
|
898
|
+
* @public
|
|
822
899
|
* <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
|
|
823
900
|
* associated repository ARNs by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p>
|
|
824
901
|
*/
|
|
825
902
|
AssociationArn?: string;
|
|
826
903
|
/**
|
|
904
|
+
* @public
|
|
827
905
|
* <p>The statistics from the code review.</p>
|
|
828
906
|
*/
|
|
829
907
|
Metrics?: Metrics;
|
|
830
908
|
/**
|
|
909
|
+
* @public
|
|
831
910
|
* <p>The types of analysis performed during a repository analysis or a pull request review.
|
|
832
911
|
* You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.</p>
|
|
833
912
|
*/
|
|
834
913
|
AnalysisTypes?: (AnalysisType | string)[];
|
|
835
914
|
/**
|
|
915
|
+
* @public
|
|
836
916
|
* <p>The state of the <code>aws-codeguru-reviewer.yml</code> configuration file that allows
|
|
837
917
|
* the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists
|
|
838
918
|
* with errors at the root directory of your repository.</p>
|
|
@@ -844,6 +924,7 @@ export interface CodeReview {
|
|
|
844
924
|
*/
|
|
845
925
|
export interface CreateCodeReviewResponse {
|
|
846
926
|
/**
|
|
927
|
+
* @public
|
|
847
928
|
* <p>Information about a code review. A code review belongs to the associated repository that
|
|
848
929
|
* contains the reviewed code.</p>
|
|
849
930
|
*/
|
|
@@ -867,6 +948,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
867
948
|
*/
|
|
868
949
|
export interface DescribeCodeReviewRequest {
|
|
869
950
|
/**
|
|
951
|
+
* @public
|
|
870
952
|
* <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.
|
|
871
953
|
* </p>
|
|
872
954
|
*/
|
|
@@ -877,6 +959,7 @@ export interface DescribeCodeReviewRequest {
|
|
|
877
959
|
*/
|
|
878
960
|
export interface DescribeCodeReviewResponse {
|
|
879
961
|
/**
|
|
962
|
+
* @public
|
|
880
963
|
* <p>Information about the code review.</p>
|
|
881
964
|
*/
|
|
882
965
|
CodeReview?: CodeReview;
|
|
@@ -886,16 +969,19 @@ export interface DescribeCodeReviewResponse {
|
|
|
886
969
|
*/
|
|
887
970
|
export interface DescribeRecommendationFeedbackRequest {
|
|
888
971
|
/**
|
|
972
|
+
* @public
|
|
889
973
|
* <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.
|
|
890
974
|
* </p>
|
|
891
975
|
*/
|
|
892
976
|
CodeReviewArn: string | undefined;
|
|
893
977
|
/**
|
|
978
|
+
* @public
|
|
894
979
|
* <p>The recommendation ID that can be used to track the provided recommendations and then to
|
|
895
980
|
* collect the feedback.</p>
|
|
896
981
|
*/
|
|
897
982
|
RecommendationId: string | undefined;
|
|
898
983
|
/**
|
|
984
|
+
* @public
|
|
899
985
|
* <p>Optional parameter to describe the feedback for a given user. If this is not supplied,
|
|
900
986
|
* it defaults to the user making the request.</p>
|
|
901
987
|
* <p>
|
|
@@ -923,21 +1009,25 @@ export type Reaction = (typeof Reaction)[keyof typeof Reaction];
|
|
|
923
1009
|
*/
|
|
924
1010
|
export interface RecommendationFeedback {
|
|
925
1011
|
/**
|
|
1012
|
+
* @public
|
|
926
1013
|
* <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.
|
|
927
1014
|
* </p>
|
|
928
1015
|
*/
|
|
929
1016
|
CodeReviewArn?: string;
|
|
930
1017
|
/**
|
|
1018
|
+
* @public
|
|
931
1019
|
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
932
1020
|
* it can be used to collect the feedback.</p>
|
|
933
1021
|
*/
|
|
934
1022
|
RecommendationId?: string;
|
|
935
1023
|
/**
|
|
1024
|
+
* @public
|
|
936
1025
|
* <p>List for storing reactions. Reactions are utf-8 text code for emojis. You can send an
|
|
937
1026
|
* empty list to clear off all your feedback.</p>
|
|
938
1027
|
*/
|
|
939
1028
|
Reactions?: (Reaction | string)[];
|
|
940
1029
|
/**
|
|
1030
|
+
* @public
|
|
941
1031
|
* <p>The ID of the user that made the API call.</p>
|
|
942
1032
|
* <p>
|
|
943
1033
|
* 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
|
|
@@ -946,10 +1036,12 @@ export interface RecommendationFeedback {
|
|
|
946
1036
|
*/
|
|
947
1037
|
UserId?: string;
|
|
948
1038
|
/**
|
|
1039
|
+
* @public
|
|
949
1040
|
* <p>The time at which the feedback was created.</p>
|
|
950
1041
|
*/
|
|
951
1042
|
CreatedTimeStamp?: Date;
|
|
952
1043
|
/**
|
|
1044
|
+
* @public
|
|
953
1045
|
* <p>The time at which the feedback was last updated.</p>
|
|
954
1046
|
*/
|
|
955
1047
|
LastUpdatedTimeStamp?: Date;
|
|
@@ -959,6 +1051,7 @@ export interface RecommendationFeedback {
|
|
|
959
1051
|
*/
|
|
960
1052
|
export interface DescribeRecommendationFeedbackResponse {
|
|
961
1053
|
/**
|
|
1054
|
+
* @public
|
|
962
1055
|
* <p>The recommendation feedback given by the user.</p>
|
|
963
1056
|
*/
|
|
964
1057
|
RecommendationFeedback?: RecommendationFeedback;
|
|
@@ -968,6 +1061,7 @@ export interface DescribeRecommendationFeedbackResponse {
|
|
|
968
1061
|
*/
|
|
969
1062
|
export interface DescribeRepositoryAssociationRequest {
|
|
970
1063
|
/**
|
|
1064
|
+
* @public
|
|
971
1065
|
* <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>
|
|
972
1066
|
*/
|
|
973
1067
|
AssociationArn: string | undefined;
|
|
@@ -977,10 +1071,12 @@ export interface DescribeRepositoryAssociationRequest {
|
|
|
977
1071
|
*/
|
|
978
1072
|
export interface DescribeRepositoryAssociationResponse {
|
|
979
1073
|
/**
|
|
1074
|
+
* @public
|
|
980
1075
|
* <p>Information about the repository association.</p>
|
|
981
1076
|
*/
|
|
982
1077
|
RepositoryAssociation?: RepositoryAssociation;
|
|
983
1078
|
/**
|
|
1079
|
+
* @public
|
|
984
1080
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
985
1081
|
* <ul>
|
|
986
1082
|
* <li>
|
|
@@ -1016,6 +1112,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1016
1112
|
*/
|
|
1017
1113
|
export interface DisassociateRepositoryRequest {
|
|
1018
1114
|
/**
|
|
1115
|
+
* @public
|
|
1019
1116
|
* <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>
|
|
1020
1117
|
*/
|
|
1021
1118
|
AssociationArn: string | undefined;
|
|
@@ -1025,10 +1122,12 @@ export interface DisassociateRepositoryRequest {
|
|
|
1025
1122
|
*/
|
|
1026
1123
|
export interface DisassociateRepositoryResponse {
|
|
1027
1124
|
/**
|
|
1125
|
+
* @public
|
|
1028
1126
|
* <p>Information about the disassociated repository.</p>
|
|
1029
1127
|
*/
|
|
1030
1128
|
RepositoryAssociation?: RepositoryAssociation;
|
|
1031
1129
|
/**
|
|
1130
|
+
* @public
|
|
1032
1131
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1033
1132
|
* <ul>
|
|
1034
1133
|
* <li>
|
|
@@ -1051,12 +1150,14 @@ export interface DisassociateRepositoryResponse {
|
|
|
1051
1150
|
*/
|
|
1052
1151
|
export interface ListCodeReviewsRequest {
|
|
1053
1152
|
/**
|
|
1153
|
+
* @public
|
|
1054
1154
|
* <p>List of provider types for filtering that needs to be applied before displaying the
|
|
1055
1155
|
* result. For example, <code>providerTypes=[GitHub]</code> lists code reviews from
|
|
1056
1156
|
* GitHub.</p>
|
|
1057
1157
|
*/
|
|
1058
1158
|
ProviderTypes?: (ProviderType | string)[];
|
|
1059
1159
|
/**
|
|
1160
|
+
* @public
|
|
1060
1161
|
* <p>List of states for filtering that needs to be applied before displaying the result. For
|
|
1061
1162
|
* example, <code>states=[Pending]</code> lists code reviews in the Pending state.</p>
|
|
1062
1163
|
* <p>The valid code review states are:</p>
|
|
@@ -1081,19 +1182,23 @@ export interface ListCodeReviewsRequest {
|
|
|
1081
1182
|
*/
|
|
1082
1183
|
States?: (JobState | string)[];
|
|
1083
1184
|
/**
|
|
1185
|
+
* @public
|
|
1084
1186
|
* <p>List of repository names for filtering that needs to be applied before displaying the
|
|
1085
1187
|
* result.</p>
|
|
1086
1188
|
*/
|
|
1087
1189
|
RepositoryNames?: string[];
|
|
1088
1190
|
/**
|
|
1191
|
+
* @public
|
|
1089
1192
|
* <p>The type of code reviews to list in the response.</p>
|
|
1090
1193
|
*/
|
|
1091
1194
|
Type: Type | string | undefined;
|
|
1092
1195
|
/**
|
|
1196
|
+
* @public
|
|
1093
1197
|
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1094
1198
|
*/
|
|
1095
1199
|
MaxResults?: number;
|
|
1096
1200
|
/**
|
|
1201
|
+
* @public
|
|
1097
1202
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
1098
1203
|
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
1099
1204
|
* using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1107,6 +1212,7 @@ export interface ListCodeReviewsRequest {
|
|
|
1107
1212
|
*/
|
|
1108
1213
|
export interface MetricsSummary {
|
|
1109
1214
|
/**
|
|
1215
|
+
* @public
|
|
1110
1216
|
* <p>Lines of code metered in the code review. For the initial code review pull request and
|
|
1111
1217
|
* all subsequent revisions, this includes all lines of code in the files added to the pull
|
|
1112
1218
|
* request. In subsequent revisions, for files that already existed in the pull request, this
|
|
@@ -1120,6 +1226,7 @@ export interface MetricsSummary {
|
|
|
1120
1226
|
*/
|
|
1121
1227
|
MeteredLinesOfCodeCount?: number;
|
|
1122
1228
|
/**
|
|
1229
|
+
* @public
|
|
1123
1230
|
* <p>Lines of code suppressed in the code review based on the <code>excludeFiles</code>
|
|
1124
1231
|
* element in the <code>aws-codeguru-reviewer.yml</code> file. For full repository analyses,
|
|
1125
1232
|
* this number includes all lines of code in the files that are suppressed. For pull requests,
|
|
@@ -1137,6 +1244,7 @@ export interface MetricsSummary {
|
|
|
1137
1244
|
*/
|
|
1138
1245
|
SuppressedLinesOfCodeCount?: number;
|
|
1139
1246
|
/**
|
|
1247
|
+
* @public
|
|
1140
1248
|
* <p>Total number of recommendations found in the code review.</p>
|
|
1141
1249
|
*/
|
|
1142
1250
|
FindingsCount?: number;
|
|
@@ -1147,29 +1255,35 @@ export interface MetricsSummary {
|
|
|
1147
1255
|
*/
|
|
1148
1256
|
export interface CodeReviewSummary {
|
|
1149
1257
|
/**
|
|
1258
|
+
* @public
|
|
1150
1259
|
* <p>The name of the code review.</p>
|
|
1151
1260
|
*/
|
|
1152
1261
|
Name?: string;
|
|
1153
1262
|
/**
|
|
1263
|
+
* @public
|
|
1154
1264
|
* <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.
|
|
1155
1265
|
* </p>
|
|
1156
1266
|
*/
|
|
1157
1267
|
CodeReviewArn?: string;
|
|
1158
1268
|
/**
|
|
1269
|
+
* @public
|
|
1159
1270
|
* <p>The name of the repository.</p>
|
|
1160
1271
|
*/
|
|
1161
1272
|
RepositoryName?: string;
|
|
1162
1273
|
/**
|
|
1274
|
+
* @public
|
|
1163
1275
|
* <p>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the
|
|
1164
1276
|
* account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
|
|
1165
1277
|
* For an S3 repository, it can be the username or Amazon Web Services account ID.</p>
|
|
1166
1278
|
*/
|
|
1167
1279
|
Owner?: string;
|
|
1168
1280
|
/**
|
|
1281
|
+
* @public
|
|
1169
1282
|
* <p>The provider type of the repository association.</p>
|
|
1170
1283
|
*/
|
|
1171
1284
|
ProviderType?: ProviderType | string;
|
|
1172
1285
|
/**
|
|
1286
|
+
* @public
|
|
1173
1287
|
* <p>The state of the code review.</p>
|
|
1174
1288
|
* <p>The valid code review states are:</p>
|
|
1175
1289
|
* <ul>
|
|
@@ -1193,26 +1307,32 @@ export interface CodeReviewSummary {
|
|
|
1193
1307
|
*/
|
|
1194
1308
|
State?: JobState | string;
|
|
1195
1309
|
/**
|
|
1310
|
+
* @public
|
|
1196
1311
|
* <p>The time, in milliseconds since the epoch, when the code review was created.</p>
|
|
1197
1312
|
*/
|
|
1198
1313
|
CreatedTimeStamp?: Date;
|
|
1199
1314
|
/**
|
|
1315
|
+
* @public
|
|
1200
1316
|
* <p>The time, in milliseconds since the epoch, when the code review was last updated.</p>
|
|
1201
1317
|
*/
|
|
1202
1318
|
LastUpdatedTimeStamp?: Date;
|
|
1203
1319
|
/**
|
|
1320
|
+
* @public
|
|
1204
1321
|
* <p>The type of the code review.</p>
|
|
1205
1322
|
*/
|
|
1206
1323
|
Type?: Type | string;
|
|
1207
1324
|
/**
|
|
1325
|
+
* @public
|
|
1208
1326
|
* <p>The pull request ID for the code review.</p>
|
|
1209
1327
|
*/
|
|
1210
1328
|
PullRequestId?: string;
|
|
1211
1329
|
/**
|
|
1330
|
+
* @public
|
|
1212
1331
|
* <p>The statistics from the code review.</p>
|
|
1213
1332
|
*/
|
|
1214
1333
|
MetricsSummary?: MetricsSummary;
|
|
1215
1334
|
/**
|
|
1335
|
+
* @public
|
|
1216
1336
|
* <p>Specifies the source code that is analyzed in a code review.</p>
|
|
1217
1337
|
*/
|
|
1218
1338
|
SourceCodeType?: SourceCodeType;
|
|
@@ -1222,10 +1342,12 @@ export interface CodeReviewSummary {
|
|
|
1222
1342
|
*/
|
|
1223
1343
|
export interface ListCodeReviewsResponse {
|
|
1224
1344
|
/**
|
|
1345
|
+
* @public
|
|
1225
1346
|
* <p>A list of code reviews that meet the criteria of the request.</p>
|
|
1226
1347
|
*/
|
|
1227
1348
|
CodeReviewSummaries?: CodeReviewSummary[];
|
|
1228
1349
|
/**
|
|
1350
|
+
* @public
|
|
1229
1351
|
* <p>Pagination token.</p>
|
|
1230
1352
|
*/
|
|
1231
1353
|
NextToken?: string;
|
|
@@ -1235,6 +1357,7 @@ export interface ListCodeReviewsResponse {
|
|
|
1235
1357
|
*/
|
|
1236
1358
|
export interface ListRecommendationFeedbackRequest {
|
|
1237
1359
|
/**
|
|
1360
|
+
* @public
|
|
1238
1361
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
1239
1362
|
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
1240
1363
|
* using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1242,15 +1365,18 @@ export interface ListRecommendationFeedbackRequest {
|
|
|
1242
1365
|
*/
|
|
1243
1366
|
NextToken?: string;
|
|
1244
1367
|
/**
|
|
1368
|
+
* @public
|
|
1245
1369
|
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1246
1370
|
*/
|
|
1247
1371
|
MaxResults?: number;
|
|
1248
1372
|
/**
|
|
1373
|
+
* @public
|
|
1249
1374
|
* <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.
|
|
1250
1375
|
* </p>
|
|
1251
1376
|
*/
|
|
1252
1377
|
CodeReviewArn: string | undefined;
|
|
1253
1378
|
/**
|
|
1379
|
+
* @public
|
|
1254
1380
|
* <p>An Amazon Web Services user's account ID or Amazon Resource Name (ARN). Use this ID to query the
|
|
1255
1381
|
* recommendation feedback for a code review from that user.</p>
|
|
1256
1382
|
* <p>
|
|
@@ -1260,6 +1386,7 @@ export interface ListRecommendationFeedbackRequest {
|
|
|
1260
1386
|
*/
|
|
1261
1387
|
UserIds?: string[];
|
|
1262
1388
|
/**
|
|
1389
|
+
* @public
|
|
1263
1390
|
* <p>Used to query the recommendation feedback for a given recommendation.</p>
|
|
1264
1391
|
*/
|
|
1265
1392
|
RecommendationIds?: string[];
|
|
@@ -1270,15 +1397,18 @@ export interface ListRecommendationFeedbackRequest {
|
|
|
1270
1397
|
*/
|
|
1271
1398
|
export interface RecommendationFeedbackSummary {
|
|
1272
1399
|
/**
|
|
1400
|
+
* @public
|
|
1273
1401
|
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
1274
1402
|
* it can be used to collect the feedback.</p>
|
|
1275
1403
|
*/
|
|
1276
1404
|
RecommendationId?: string;
|
|
1277
1405
|
/**
|
|
1406
|
+
* @public
|
|
1278
1407
|
* <p>List for storing reactions. Reactions are utf-8 text code for emojis.</p>
|
|
1279
1408
|
*/
|
|
1280
1409
|
Reactions?: (Reaction | string)[];
|
|
1281
1410
|
/**
|
|
1411
|
+
* @public
|
|
1282
1412
|
* <p>The ID of the user that gave the feedback.</p>
|
|
1283
1413
|
* <p>
|
|
1284
1414
|
* 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
|
|
@@ -1292,10 +1422,12 @@ export interface RecommendationFeedbackSummary {
|
|
|
1292
1422
|
*/
|
|
1293
1423
|
export interface ListRecommendationFeedbackResponse {
|
|
1294
1424
|
/**
|
|
1425
|
+
* @public
|
|
1295
1426
|
* <p>Recommendation feedback summaries corresponding to the code review ARN.</p>
|
|
1296
1427
|
*/
|
|
1297
1428
|
RecommendationFeedbackSummaries?: RecommendationFeedbackSummary[];
|
|
1298
1429
|
/**
|
|
1430
|
+
* @public
|
|
1299
1431
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
1300
1432
|
* <code>nextToken</code> is a unique pagination token for each page. Make the call again
|
|
1301
1433
|
* using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1308,14 +1440,17 @@ export interface ListRecommendationFeedbackResponse {
|
|
|
1308
1440
|
*/
|
|
1309
1441
|
export interface ListRecommendationsRequest {
|
|
1310
1442
|
/**
|
|
1443
|
+
* @public
|
|
1311
1444
|
* <p>Pagination token.</p>
|
|
1312
1445
|
*/
|
|
1313
1446
|
NextToken?: string;
|
|
1314
1447
|
/**
|
|
1448
|
+
* @public
|
|
1315
1449
|
* <p>The maximum number of results that are returned per call. The default is 100.</p>
|
|
1316
1450
|
*/
|
|
1317
1451
|
MaxResults?: number;
|
|
1318
1452
|
/**
|
|
1453
|
+
* @public
|
|
1319
1454
|
* <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.
|
|
1320
1455
|
* </p>
|
|
1321
1456
|
*/
|
|
@@ -1348,22 +1483,27 @@ export type RecommendationCategory = (typeof RecommendationCategory)[keyof typeo
|
|
|
1348
1483
|
*/
|
|
1349
1484
|
export interface RuleMetadata {
|
|
1350
1485
|
/**
|
|
1486
|
+
* @public
|
|
1351
1487
|
* <p>The ID of the rule.</p>
|
|
1352
1488
|
*/
|
|
1353
1489
|
RuleId?: string;
|
|
1354
1490
|
/**
|
|
1491
|
+
* @public
|
|
1355
1492
|
* <p>The name of the rule.</p>
|
|
1356
1493
|
*/
|
|
1357
1494
|
RuleName?: string;
|
|
1358
1495
|
/**
|
|
1496
|
+
* @public
|
|
1359
1497
|
* <p>A short description of the rule.</p>
|
|
1360
1498
|
*/
|
|
1361
1499
|
ShortDescription?: string;
|
|
1362
1500
|
/**
|
|
1501
|
+
* @public
|
|
1363
1502
|
* <p>A long description of the rule.</p>
|
|
1364
1503
|
*/
|
|
1365
1504
|
LongDescription?: string;
|
|
1366
1505
|
/**
|
|
1506
|
+
* @public
|
|
1367
1507
|
* <p>Tags that are associated with the rule.</p>
|
|
1368
1508
|
*/
|
|
1369
1509
|
RuleTags?: string[];
|
|
@@ -1389,38 +1529,46 @@ export type Severity = (typeof Severity)[keyof typeof Severity];
|
|
|
1389
1529
|
*/
|
|
1390
1530
|
export interface RecommendationSummary {
|
|
1391
1531
|
/**
|
|
1532
|
+
* @public
|
|
1392
1533
|
* <p>Name of the file on which a recommendation is provided.</p>
|
|
1393
1534
|
*/
|
|
1394
1535
|
FilePath?: string;
|
|
1395
1536
|
/**
|
|
1537
|
+
* @public
|
|
1396
1538
|
* <p>The recommendation ID that can be used to track the provided recommendations. Later on
|
|
1397
1539
|
* it can be used to collect the feedback.</p>
|
|
1398
1540
|
*/
|
|
1399
1541
|
RecommendationId?: string;
|
|
1400
1542
|
/**
|
|
1543
|
+
* @public
|
|
1401
1544
|
* <p>Start line from where the recommendation is applicable in the source commit or source
|
|
1402
1545
|
* branch.</p>
|
|
1403
1546
|
*/
|
|
1404
1547
|
StartLine?: number;
|
|
1405
1548
|
/**
|
|
1549
|
+
* @public
|
|
1406
1550
|
* <p>Last line where the recommendation is applicable in the source commit or source branch.
|
|
1407
1551
|
* For a single line comment the start line and end line values are the same.</p>
|
|
1408
1552
|
*/
|
|
1409
1553
|
EndLine?: number;
|
|
1410
1554
|
/**
|
|
1555
|
+
* @public
|
|
1411
1556
|
* <p>A description of the recommendation generated by CodeGuru Reviewer for the lines of code between
|
|
1412
1557
|
* the start line and the end line.</p>
|
|
1413
1558
|
*/
|
|
1414
1559
|
Description?: string;
|
|
1415
1560
|
/**
|
|
1561
|
+
* @public
|
|
1416
1562
|
* <p>The type of a recommendation.</p>
|
|
1417
1563
|
*/
|
|
1418
1564
|
RecommendationCategory?: RecommendationCategory | string;
|
|
1419
1565
|
/**
|
|
1566
|
+
* @public
|
|
1420
1567
|
* <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>
|
|
1421
1568
|
*/
|
|
1422
1569
|
RuleMetadata?: RuleMetadata;
|
|
1423
1570
|
/**
|
|
1571
|
+
* @public
|
|
1424
1572
|
* <p>The severity of the issue in the code that generated this recommendation.</p>
|
|
1425
1573
|
*/
|
|
1426
1574
|
Severity?: Severity | string;
|
|
@@ -1430,10 +1578,12 @@ export interface RecommendationSummary {
|
|
|
1430
1578
|
*/
|
|
1431
1579
|
export interface ListRecommendationsResponse {
|
|
1432
1580
|
/**
|
|
1581
|
+
* @public
|
|
1433
1582
|
* <p>List of recommendations for the requested code review.</p>
|
|
1434
1583
|
*/
|
|
1435
1584
|
RecommendationSummaries?: RecommendationSummary[];
|
|
1436
1585
|
/**
|
|
1586
|
+
* @public
|
|
1437
1587
|
* <p>Pagination token.</p>
|
|
1438
1588
|
*/
|
|
1439
1589
|
NextToken?: string;
|
|
@@ -1443,10 +1593,12 @@ export interface ListRecommendationsResponse {
|
|
|
1443
1593
|
*/
|
|
1444
1594
|
export interface ListRepositoryAssociationsRequest {
|
|
1445
1595
|
/**
|
|
1596
|
+
* @public
|
|
1446
1597
|
* <p>List of provider types to use as a filter.</p>
|
|
1447
1598
|
*/
|
|
1448
1599
|
ProviderTypes?: (ProviderType | string)[];
|
|
1449
1600
|
/**
|
|
1601
|
+
* @public
|
|
1450
1602
|
* <p>List of repository association states to use as a filter.</p>
|
|
1451
1603
|
* <p>The valid repository association states are:</p>
|
|
1452
1604
|
* <ul>
|
|
@@ -1486,10 +1638,12 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1486
1638
|
*/
|
|
1487
1639
|
States?: (RepositoryAssociationState | string)[];
|
|
1488
1640
|
/**
|
|
1641
|
+
* @public
|
|
1489
1642
|
* <p>List of repository names to use as a filter.</p>
|
|
1490
1643
|
*/
|
|
1491
1644
|
Names?: string[];
|
|
1492
1645
|
/**
|
|
1646
|
+
* @public
|
|
1493
1647
|
* <p>List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the
|
|
1494
1648
|
* CodeCommit account that was used to associate the repository. For other repository source
|
|
1495
1649
|
* providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that
|
|
@@ -1497,6 +1651,7 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1497
1651
|
*/
|
|
1498
1652
|
Owners?: string[];
|
|
1499
1653
|
/**
|
|
1654
|
+
* @public
|
|
1500
1655
|
* <p>The maximum number of repository association results returned by
|
|
1501
1656
|
* <code>ListRepositoryAssociations</code> in paginated output. When this parameter is
|
|
1502
1657
|
* used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results
|
|
@@ -1508,6 +1663,7 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1508
1663
|
*/
|
|
1509
1664
|
MaxResults?: number;
|
|
1510
1665
|
/**
|
|
1666
|
+
* @public
|
|
1511
1667
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1512
1668
|
* <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used
|
|
1513
1669
|
* and the results exceeded the value of that parameter. Pagination continues from the end of
|
|
@@ -1526,37 +1682,45 @@ export interface ListRepositoryAssociationsRequest {
|
|
|
1526
1682
|
*/
|
|
1527
1683
|
export interface RepositoryAssociationSummary {
|
|
1528
1684
|
/**
|
|
1685
|
+
* @public
|
|
1529
1686
|
* <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>
|
|
1530
1687
|
*/
|
|
1531
1688
|
AssociationArn?: string;
|
|
1532
1689
|
/**
|
|
1690
|
+
* @public
|
|
1533
1691
|
* <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>
|
|
1534
1692
|
*/
|
|
1535
1693
|
ConnectionArn?: string;
|
|
1536
1694
|
/**
|
|
1695
|
+
* @public
|
|
1537
1696
|
* <p>The time, in milliseconds since the epoch, since the repository association was last
|
|
1538
1697
|
* updated.</p>
|
|
1539
1698
|
*/
|
|
1540
1699
|
LastUpdatedTimeStamp?: Date;
|
|
1541
1700
|
/**
|
|
1701
|
+
* @public
|
|
1542
1702
|
* <p>The repository association ID.</p>
|
|
1543
1703
|
*/
|
|
1544
1704
|
AssociationId?: string;
|
|
1545
1705
|
/**
|
|
1706
|
+
* @public
|
|
1546
1707
|
* <p>The name of the repository association.</p>
|
|
1547
1708
|
*/
|
|
1548
1709
|
Name?: string;
|
|
1549
1710
|
/**
|
|
1711
|
+
* @public
|
|
1550
1712
|
* <p>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the
|
|
1551
1713
|
* account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
|
|
1552
1714
|
* For an S3 repository, it can be the username or Amazon Web Services account ID.</p>
|
|
1553
1715
|
*/
|
|
1554
1716
|
Owner?: string;
|
|
1555
1717
|
/**
|
|
1718
|
+
* @public
|
|
1556
1719
|
* <p>The provider type of the repository association.</p>
|
|
1557
1720
|
*/
|
|
1558
1721
|
ProviderType?: ProviderType | string;
|
|
1559
1722
|
/**
|
|
1723
|
+
* @public
|
|
1560
1724
|
* <p>The state of the repository association.</p>
|
|
1561
1725
|
* <p>The valid repository association states are:</p>
|
|
1562
1726
|
* <ul>
|
|
@@ -1601,10 +1765,12 @@ export interface RepositoryAssociationSummary {
|
|
|
1601
1765
|
*/
|
|
1602
1766
|
export interface ListRepositoryAssociationsResponse {
|
|
1603
1767
|
/**
|
|
1768
|
+
* @public
|
|
1604
1769
|
* <p>A list of repository associations that meet the criteria of the request.</p>
|
|
1605
1770
|
*/
|
|
1606
1771
|
RepositoryAssociationSummaries?: RepositoryAssociationSummary[];
|
|
1607
1772
|
/**
|
|
1773
|
+
* @public
|
|
1608
1774
|
* <p>The <code>nextToken</code> value to include in a future <code>ListRecommendations</code>
|
|
1609
1775
|
* request. When the results of a <code>ListRecommendations</code> request exceed
|
|
1610
1776
|
* <code>maxResults</code>, this value can be used to retrieve the next page of results.
|
|
@@ -1617,6 +1783,7 @@ export interface ListRepositoryAssociationsResponse {
|
|
|
1617
1783
|
*/
|
|
1618
1784
|
export interface ListTagsForResourceRequest {
|
|
1619
1785
|
/**
|
|
1786
|
+
* @public
|
|
1620
1787
|
* <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>
|
|
1621
1788
|
*/
|
|
1622
1789
|
resourceArn: string | undefined;
|
|
@@ -1626,6 +1793,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1626
1793
|
*/
|
|
1627
1794
|
export interface ListTagsForResourceResponse {
|
|
1628
1795
|
/**
|
|
1796
|
+
* @public
|
|
1629
1797
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1630
1798
|
* <ul>
|
|
1631
1799
|
* <li>
|
|
@@ -1648,16 +1816,19 @@ export interface ListTagsForResourceResponse {
|
|
|
1648
1816
|
*/
|
|
1649
1817
|
export interface PutRecommendationFeedbackRequest {
|
|
1650
1818
|
/**
|
|
1819
|
+
* @public
|
|
1651
1820
|
* <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.
|
|
1652
1821
|
* </p>
|
|
1653
1822
|
*/
|
|
1654
1823
|
CodeReviewArn: string | undefined;
|
|
1655
1824
|
/**
|
|
1825
|
+
* @public
|
|
1656
1826
|
* <p>The recommendation ID that can be used to track the provided recommendations and then to
|
|
1657
1827
|
* collect the feedback.</p>
|
|
1658
1828
|
*/
|
|
1659
1829
|
RecommendationId: string | undefined;
|
|
1660
1830
|
/**
|
|
1831
|
+
* @public
|
|
1661
1832
|
* <p>List for storing reactions. Reactions are utf-8 text code for emojis. If you send an
|
|
1662
1833
|
* empty list it clears all your feedback.</p>
|
|
1663
1834
|
*/
|
|
@@ -1673,10 +1844,12 @@ export interface PutRecommendationFeedbackResponse {
|
|
|
1673
1844
|
*/
|
|
1674
1845
|
export interface TagResourceRequest {
|
|
1675
1846
|
/**
|
|
1847
|
+
* @public
|
|
1676
1848
|
* <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>
|
|
1677
1849
|
*/
|
|
1678
1850
|
resourceArn: string | undefined;
|
|
1679
1851
|
/**
|
|
1852
|
+
* @public
|
|
1680
1853
|
* <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p>
|
|
1681
1854
|
* <ul>
|
|
1682
1855
|
* <li>
|
|
@@ -1704,10 +1877,12 @@ export interface TagResourceResponse {
|
|
|
1704
1877
|
*/
|
|
1705
1878
|
export interface UntagResourceRequest {
|
|
1706
1879
|
/**
|
|
1880
|
+
* @public
|
|
1707
1881
|
* <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>
|
|
1708
1882
|
*/
|
|
1709
1883
|
resourceArn: string | undefined;
|
|
1710
1884
|
/**
|
|
1885
|
+
* @public
|
|
1711
1886
|
* <p>A list of the keys for each tag you want to remove from an associated repository.</p>
|
|
1712
1887
|
*/
|
|
1713
1888
|
TagKeys: string[] | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-codeguru-reviewer",
|
|
3
3
|
"description": "AWS SDK for JavaScript Codeguru Reviewer Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|