@aws-sdk/client-codepipeline 3.379.1 → 3.385.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.
@@ -6,11 +6,13 @@ import { CodePipelineServiceException as __BaseException } from "./CodePipelineS
6
6
  */
7
7
  export interface AcknowledgeJobInput {
8
8
  /**
9
+ * @public
9
10
  * <p>The unique system-generated ID of the job for which you want to confirm
10
11
  * receipt.</p>
11
12
  */
12
13
  jobId: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p>A system-generated random number that CodePipeline uses to ensure that the
15
17
  * job is being worked on by only one job worker. Get this number from the response of the
16
18
  * <a>PollForJobs</a> request that returned this job.</p>
@@ -40,6 +42,7 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
40
42
  */
41
43
  export interface AcknowledgeJobOutput {
42
44
  /**
45
+ * @public
43
46
  * <p>Whether the job worker has received the specified job.</p>
44
47
  */
45
48
  status?: JobStatus | string;
@@ -86,16 +89,19 @@ export declare class ValidationException extends __BaseException {
86
89
  */
87
90
  export interface AcknowledgeThirdPartyJobInput {
88
91
  /**
92
+ * @public
89
93
  * <p>The unique system-generated ID of the job.</p>
90
94
  */
91
95
  jobId: string | undefined;
92
96
  /**
97
+ * @public
93
98
  * <p>A system-generated random number that CodePipeline uses to ensure that the
94
99
  * job is being worked on by only one job worker. Get this number from the response to a
95
100
  * <a>GetThirdPartyJobDetails</a> request.</p>
96
101
  */
97
102
  nonce: string | undefined;
98
103
  /**
104
+ * @public
99
105
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
100
106
  * the calling entity is allowed access to the job and its details.</p>
101
107
  */
@@ -107,6 +113,7 @@ export interface AcknowledgeThirdPartyJobInput {
107
113
  */
108
114
  export interface AcknowledgeThirdPartyJobOutput {
109
115
  /**
116
+ * @public
110
117
  * <p>The status information for the third party job, if any.</p>
111
118
  */
112
119
  status?: JobStatus | string;
@@ -145,6 +152,7 @@ export type ActionCategory = (typeof ActionCategory)[keyof typeof ActionCategory
145
152
  */
146
153
  export interface ActionConfiguration {
147
154
  /**
155
+ * @public
148
156
  * <p>The configuration data for the action.</p>
149
157
  */
150
158
  configuration?: Record<string, string>;
@@ -168,18 +176,22 @@ export type ActionConfigurationPropertyType = (typeof ActionConfigurationPropert
168
176
  */
169
177
  export interface ActionConfigurationProperty {
170
178
  /**
179
+ * @public
171
180
  * <p>The name of the action configuration property.</p>
172
181
  */
173
182
  name: string | undefined;
174
183
  /**
184
+ * @public
175
185
  * <p>Whether the configuration property is a required value.</p>
176
186
  */
177
187
  required: boolean | undefined;
178
188
  /**
189
+ * @public
179
190
  * <p>Whether the configuration property is a key.</p>
180
191
  */
181
192
  key: boolean | undefined;
182
193
  /**
194
+ * @public
183
195
  * <p>Whether the configuration property is secret. Secrets are hidden from all calls
184
196
  * except for <code>GetJobDetails</code>, <code>GetThirdPartyJobDetails</code>,
185
197
  * <code>PollForJobs</code>, and <code>PollForThirdPartyJobs</code>.</p>
@@ -188,6 +200,7 @@ export interface ActionConfigurationProperty {
188
200
  */
189
201
  secret: boolean | undefined;
190
202
  /**
203
+ * @public
191
204
  * <p>Indicates that the property is used with <code>PollForJobs</code>. When creating a
192
205
  * custom action, an action can have up to one queryable property. If it has one, that
193
206
  * property must be both required and not secret.</p>
@@ -198,11 +211,13 @@ export interface ActionConfigurationProperty {
198
211
  */
199
212
  queryable?: boolean;
200
213
  /**
214
+ * @public
201
215
  * <p>The description of the action configuration property that is displayed to
202
216
  * users.</p>
203
217
  */
204
218
  description?: string;
205
219
  /**
220
+ * @public
206
221
  * <p>The type of the configuration property.</p>
207
222
  */
208
223
  type?: ActionConfigurationPropertyType | string;
@@ -214,10 +229,12 @@ export interface ActionConfigurationProperty {
214
229
  */
215
230
  export interface ActionContext {
216
231
  /**
232
+ * @public
217
233
  * <p>The name of the action in the context of a job.</p>
218
234
  */
219
235
  name?: string;
220
236
  /**
237
+ * @public
221
238
  * <p>The system-generated unique ID that corresponds to an action's execution.</p>
222
239
  */
223
240
  actionExecutionId?: string;
@@ -241,6 +258,7 @@ export type ActionOwner = (typeof ActionOwner)[keyof typeof ActionOwner];
241
258
  */
242
259
  export interface ActionTypeId {
243
260
  /**
261
+ * @public
244
262
  * <p>A category defines what kind of action can be taken in the stage, and constrains
245
263
  * the provider type for the action. Valid categories are limited to one of the following
246
264
  * values. </p>
@@ -267,6 +285,7 @@ export interface ActionTypeId {
267
285
  */
268
286
  category: ActionCategory | string | undefined;
269
287
  /**
288
+ * @public
270
289
  * <p>The creator of the action being called. There are three valid values for the
271
290
  * <code>Owner</code> field in the action category section within your pipeline
272
291
  * structure: <code>AWS</code>, <code>ThirdParty</code>, and <code>Custom</code>. For more
@@ -274,6 +293,7 @@ export interface ActionTypeId {
274
293
  */
275
294
  owner: ActionOwner | string | undefined;
276
295
  /**
296
+ * @public
277
297
  * <p>The provider of the service being called by the action. Valid providers are
278
298
  * determined by the action category. For example, an action in the Deploy category type
279
299
  * might have a provider of CodeDeploy, which would be specified as
@@ -281,6 +301,7 @@ export interface ActionTypeId {
281
301
  */
282
302
  provider: string | undefined;
283
303
  /**
304
+ * @public
284
305
  * <p>A string that describes the action version.</p>
285
306
  */
286
307
  version: string | undefined;
@@ -292,6 +313,7 @@ export interface ActionTypeId {
292
313
  */
293
314
  export interface InputArtifact {
294
315
  /**
316
+ * @public
295
317
  * <p>The name of the artifact to be worked on (for example, "My App").</p>
296
318
  * <p>Artifacts are the files that are worked on by actions in the pipeline. See the
297
319
  * action configuration for each action for details about artifact parameters. For example,
@@ -311,6 +333,7 @@ export interface InputArtifact {
311
333
  */
312
334
  export interface OutputArtifact {
313
335
  /**
336
+ * @public
314
337
  * <p>The name of the output of an artifact, such as "My App".</p>
315
338
  * <p>The input artifact of an action must exactly match the output artifact declared in
316
339
  * a preceding action, but the input artifact does not have to be the next action in strict
@@ -327,18 +350,22 @@ export interface OutputArtifact {
327
350
  */
328
351
  export interface ActionDeclaration {
329
352
  /**
353
+ * @public
330
354
  * <p>The action declaration's name.</p>
331
355
  */
332
356
  name: string | undefined;
333
357
  /**
358
+ * @public
334
359
  * <p>Specifies the action type and the provider of the action.</p>
335
360
  */
336
361
  actionTypeId: ActionTypeId | undefined;
337
362
  /**
363
+ * @public
338
364
  * <p>The order in which actions are run.</p>
339
365
  */
340
366
  runOrder?: number;
341
367
  /**
368
+ * @public
342
369
  * <p>The action's configuration. These are key-value pairs that specify input values for
343
370
  * an action. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements">Action Structure Requirements in CodePipeline</a>. For the list of
344
371
  * configuration properties for the CloudFormation action type in CodePipeline, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html">Configuration Properties Reference</a> in the <i>CloudFormation
@@ -355,25 +382,30 @@ export interface ActionDeclaration {
355
382
  */
356
383
  configuration?: Record<string, string>;
357
384
  /**
385
+ * @public
358
386
  * <p>The name or ID of the result of the action declaration, such as a test or build
359
387
  * artifact.</p>
360
388
  */
361
389
  outputArtifacts?: OutputArtifact[];
362
390
  /**
391
+ * @public
363
392
  * <p>The name or ID of the artifact consumed by the action, such as a test or build
364
393
  * artifact.</p>
365
394
  */
366
395
  inputArtifacts?: InputArtifact[];
367
396
  /**
397
+ * @public
368
398
  * <p>The ARN of the IAM service role that performs the declared action. This is assumed
369
399
  * through the roleArn for the pipeline.</p>
370
400
  */
371
401
  roleArn?: string;
372
402
  /**
403
+ * @public
373
404
  * <p>The action declaration's Amazon Web Services Region, such as us-east-1.</p>
374
405
  */
375
406
  region?: string;
376
407
  /**
408
+ * @public
377
409
  * <p>The variable namespace associated with the action. All variables produced as output by
378
410
  * this action fall under this namespace.</p>
379
411
  */
@@ -385,10 +417,12 @@ export interface ActionDeclaration {
385
417
  */
386
418
  export interface ErrorDetails {
387
419
  /**
420
+ * @public
388
421
  * <p>The system ID or number code of the error.</p>
389
422
  */
390
423
  code?: string;
391
424
  /**
425
+ * @public
392
426
  * <p>The text of the error message.</p>
393
427
  */
394
428
  message?: string;
@@ -413,6 +447,7 @@ export type ActionExecutionStatus = (typeof ActionExecutionStatus)[keyof typeof
413
447
  */
414
448
  export interface ActionExecution {
415
449
  /**
450
+ * @public
416
451
  * <p>ID of the workflow action execution in the current stage. Use the <a>GetPipelineState</a> action to retrieve the current action execution details
417
452
  * of the current stage.</p>
418
453
  * <note>
@@ -422,19 +457,23 @@ export interface ActionExecution {
422
457
  */
423
458
  actionExecutionId?: string;
424
459
  /**
460
+ * @public
425
461
  * <p>The status of the action, or for a completed action, the last status of the
426
462
  * action.</p>
427
463
  */
428
464
  status?: ActionExecutionStatus | string;
429
465
  /**
466
+ * @public
430
467
  * <p>A summary of the run of the action.</p>
431
468
  */
432
469
  summary?: string;
433
470
  /**
471
+ * @public
434
472
  * <p>The last status change of the action.</p>
435
473
  */
436
474
  lastStatusChange?: Date;
437
475
  /**
476
+ * @public
438
477
  * <p>The system-generated token used to identify a unique approval request. The token
439
478
  * for each open approval request can be obtained using the <code>GetPipelineState</code>
440
479
  * command. It is used to validate that the approval request corresponding to this token is
@@ -442,23 +481,28 @@ export interface ActionExecution {
442
481
  */
443
482
  token?: string;
444
483
  /**
484
+ * @public
445
485
  * <p>The ARN of the user who last changed the pipeline.</p>
446
486
  */
447
487
  lastUpdatedBy?: string;
448
488
  /**
489
+ * @public
449
490
  * <p>The external ID of the run of the action.</p>
450
491
  */
451
492
  externalExecutionId?: string;
452
493
  /**
494
+ * @public
453
495
  * <p>The URL of a resource external to Amazon Web Services that is used when running the
454
496
  * action (for example, an external repository URL).</p>
455
497
  */
456
498
  externalExecutionUrl?: string;
457
499
  /**
500
+ * @public
458
501
  * <p>A percentage of completeness of the action as it runs.</p>
459
502
  */
460
503
  percentComplete?: number;
461
504
  /**
505
+ * @public
462
506
  * <p>The details of an error returned by a URL external to Amazon Web Services.</p>
463
507
  */
464
508
  errorDetails?: ErrorDetails;
@@ -469,10 +513,12 @@ export interface ActionExecution {
469
513
  */
470
514
  export interface S3Location {
471
515
  /**
516
+ * @public
472
517
  * <p>The Amazon S3 artifact bucket for an action's artifacts.</p>
473
518
  */
474
519
  bucket?: string;
475
520
  /**
521
+ * @public
476
522
  * <p>The artifact name.</p>
477
523
  */
478
524
  key?: string;
@@ -483,10 +529,12 @@ export interface S3Location {
483
529
  */
484
530
  export interface ArtifactDetail {
485
531
  /**
532
+ * @public
486
533
  * <p>The artifact object name for the action execution.</p>
487
534
  */
488
535
  name?: string;
489
536
  /**
537
+ * @public
490
538
  * <p>The Amazon S3 artifact location for the action execution.</p>
491
539
  */
492
540
  s3location?: S3Location;
@@ -497,33 +545,40 @@ export interface ArtifactDetail {
497
545
  */
498
546
  export interface ActionExecutionInput {
499
547
  /**
548
+ * @public
500
549
  * <p>Represents information about an action type.</p>
501
550
  */
502
551
  actionTypeId?: ActionTypeId;
503
552
  /**
553
+ * @public
504
554
  * <p>Configuration data for an action execution.</p>
505
555
  */
506
556
  configuration?: Record<string, string>;
507
557
  /**
558
+ * @public
508
559
  * <p>Configuration data for an action execution with all variable references replaced with
509
560
  * their real values for the execution.</p>
510
561
  */
511
562
  resolvedConfiguration?: Record<string, string>;
512
563
  /**
564
+ * @public
513
565
  * <p>The ARN of the IAM service role that performs the declared action. This is assumed
514
566
  * through the roleArn for the pipeline. </p>
515
567
  */
516
568
  roleArn?: string;
517
569
  /**
570
+ * @public
518
571
  * <p>The Amazon Web Services Region for the action, such as us-east-1.</p>
519
572
  */
520
573
  region?: string;
521
574
  /**
575
+ * @public
522
576
  * <p>Details of input artifacts of the action that correspond to the action
523
577
  * execution.</p>
524
578
  */
525
579
  inputArtifacts?: ArtifactDetail[];
526
580
  /**
581
+ * @public
527
582
  * <p>The variable namespace associated with the action. All variables produced as output by
528
583
  * this action fall under this namespace.</p>
529
584
  */
@@ -535,14 +590,17 @@ export interface ActionExecutionInput {
535
590
  */
536
591
  export interface ActionExecutionResult {
537
592
  /**
593
+ * @public
538
594
  * <p>The action provider's external ID for the action execution.</p>
539
595
  */
540
596
  externalExecutionId?: string;
541
597
  /**
598
+ * @public
542
599
  * <p>The action provider's summary for the action execution.</p>
543
600
  */
544
601
  externalExecutionSummary?: string;
545
602
  /**
603
+ * @public
546
604
  * <p>The deepest external link to the external resource (for example, a repository URL or
547
605
  * deployment endpoint) that is used when running the action.</p>
548
606
  */
@@ -555,16 +613,19 @@ export interface ActionExecutionResult {
555
613
  */
556
614
  export interface ActionExecutionOutput {
557
615
  /**
616
+ * @public
558
617
  * <p>Details of output artifacts of the action that correspond to the action
559
618
  * execution.</p>
560
619
  */
561
620
  outputArtifacts?: ArtifactDetail[];
562
621
  /**
622
+ * @public
563
623
  * <p>Execution result information listed in the output details for an action
564
624
  * execution.</p>
565
625
  */
566
626
  executionResult?: ActionExecutionResult;
567
627
  /**
628
+ * @public
568
629
  * <p>The outputVariables field shows the key-value pairs that were output as part of that
569
630
  * execution.</p>
570
631
  */
@@ -577,44 +638,54 @@ export interface ActionExecutionOutput {
577
638
  */
578
639
  export interface ActionExecutionDetail {
579
640
  /**
641
+ * @public
580
642
  * <p>The pipeline execution ID for the action execution.</p>
581
643
  */
582
644
  pipelineExecutionId?: string;
583
645
  /**
646
+ * @public
584
647
  * <p>The action execution ID.</p>
585
648
  */
586
649
  actionExecutionId?: string;
587
650
  /**
651
+ * @public
588
652
  * <p>The version of the pipeline where the action was run.</p>
589
653
  */
590
654
  pipelineVersion?: number;
591
655
  /**
656
+ * @public
592
657
  * <p>The name of the stage that contains the action.</p>
593
658
  */
594
659
  stageName?: string;
595
660
  /**
661
+ * @public
596
662
  * <p>The name of the action.</p>
597
663
  */
598
664
  actionName?: string;
599
665
  /**
666
+ * @public
600
667
  * <p>The start time of the action execution.</p>
601
668
  */
602
669
  startTime?: Date;
603
670
  /**
671
+ * @public
604
672
  * <p>The last update time of the action execution.</p>
605
673
  */
606
674
  lastUpdateTime?: Date;
607
675
  /**
676
+ * @public
608
677
  * <p> The status of the action execution. Status categories are <code>InProgress</code>,
609
678
  * <code>Succeeded</code>, and <code>Failed</code>.</p>
610
679
  */
611
680
  status?: ActionExecutionStatus | string;
612
681
  /**
682
+ * @public
613
683
  * <p>Input details for the action execution, such as role ARN, Region, and input
614
684
  * artifacts.</p>
615
685
  */
616
686
  input?: ActionExecutionInput;
617
687
  /**
688
+ * @public
618
689
  * <p>Output details for the action execution, such as the action execution result.</p>
619
690
  */
620
691
  output?: ActionExecutionOutput;
@@ -625,6 +696,7 @@ export interface ActionExecutionDetail {
625
696
  */
626
697
  export interface ActionExecutionFilter {
627
698
  /**
699
+ * @public
628
700
  * <p>The pipeline execution ID used to filter action execution history.</p>
629
701
  */
630
702
  pipelineExecutionId?: string;
@@ -647,16 +719,19 @@ export declare class ActionNotFoundException extends __BaseException {
647
719
  */
648
720
  export interface ActionRevision {
649
721
  /**
722
+ * @public
650
723
  * <p>The system-generated unique ID that identifies the revision number of the
651
724
  * action.</p>
652
725
  */
653
726
  revisionId: string | undefined;
654
727
  /**
728
+ * @public
655
729
  * <p>The unique identifier of the change that set the state to this revision (for
656
730
  * example, a deployment ID or timestamp).</p>
657
731
  */
658
732
  revisionChangeId: string | undefined;
659
733
  /**
734
+ * @public
660
735
  * <p>The date and time when the most recent version of the action was created, in
661
736
  * timestamp format.</p>
662
737
  */
@@ -668,23 +743,28 @@ export interface ActionRevision {
668
743
  */
669
744
  export interface ActionState {
670
745
  /**
746
+ * @public
671
747
  * <p>The name of the action.</p>
672
748
  */
673
749
  actionName?: string;
674
750
  /**
751
+ * @public
675
752
  * <p>Represents information about the version (or revision) of an action.</p>
676
753
  */
677
754
  currentRevision?: ActionRevision;
678
755
  /**
756
+ * @public
679
757
  * <p>Represents information about the run of an action.</p>
680
758
  */
681
759
  latestExecution?: ActionExecution;
682
760
  /**
761
+ * @public
683
762
  * <p>A URL link for more information about the state of the action, such as a deployment
684
763
  * group details page.</p>
685
764
  */
686
765
  entityUrl?: string;
687
766
  /**
767
+ * @public
688
768
  * <p>A URL link for more information about the revision, such as a commit details
689
769
  * page.</p>
690
770
  */
@@ -696,10 +776,12 @@ export interface ActionState {
696
776
  */
697
777
  export interface ArtifactDetails {
698
778
  /**
779
+ * @public
699
780
  * <p>The minimum number of artifacts allowed for the action type.</p>
700
781
  */
701
782
  minimumCount: number | undefined;
702
783
  /**
784
+ * @public
703
785
  * <p>The maximum number of artifacts allowed for the action type.</p>
704
786
  */
705
787
  maximumCount: number | undefined;
@@ -710,11 +792,13 @@ export interface ArtifactDetails {
710
792
  */
711
793
  export interface ActionTypeSettings {
712
794
  /**
795
+ * @public
713
796
  * <p>The URL of a sign-up page where users can sign up for an external service and
714
797
  * perform initial configuration of the action provided by that service.</p>
715
798
  */
716
799
  thirdPartyConfigurationUrl?: string;
717
800
  /**
801
+ * @public
718
802
  * <p>The URL returned to the CodePipeline console that provides a deep link to the
719
803
  * resources of the external system, such as the configuration page for a CodeDeploy
720
804
  * deployment group. This link is provided as part of the action display in the
@@ -722,6 +806,7 @@ export interface ActionTypeSettings {
722
806
  */
723
807
  entityUrlTemplate?: string;
724
808
  /**
809
+ * @public
725
810
  * <p>The URL returned to the CodePipeline console that contains a link to the
726
811
  * top-level landing page for the external system, such as the console page for CodeDeploy.
727
812
  * This link is shown on the pipeline view page in the CodePipeline console and
@@ -729,6 +814,7 @@ export interface ActionTypeSettings {
729
814
  */
730
815
  executionUrlTemplate?: string;
731
816
  /**
817
+ * @public
732
818
  * <p>The URL returned to the CodePipeline console that contains a link to the page
733
819
  * where customers can update or change the configuration of the external action.</p>
734
820
  */
@@ -740,22 +826,27 @@ export interface ActionTypeSettings {
740
826
  */
741
827
  export interface ActionType {
742
828
  /**
829
+ * @public
743
830
  * <p>Represents information about an action type.</p>
744
831
  */
745
832
  id: ActionTypeId | undefined;
746
833
  /**
834
+ * @public
747
835
  * <p>The settings for the action type.</p>
748
836
  */
749
837
  settings?: ActionTypeSettings;
750
838
  /**
839
+ * @public
751
840
  * <p>The configuration properties for the action type.</p>
752
841
  */
753
842
  actionConfigurationProperties?: ActionConfigurationProperty[];
754
843
  /**
844
+ * @public
755
845
  * <p>The details of the input artifact for the action, such as its commit ID.</p>
756
846
  */
757
847
  inputArtifactDetails: ArtifactDetails | undefined;
758
848
  /**
849
+ * @public
759
850
  * <p>The details of the output artifact of the action, such as its commit ID.</p>
760
851
  */
761
852
  outputArtifactDetails: ArtifactDetails | undefined;
@@ -767,12 +858,14 @@ export interface ActionType {
767
858
  */
768
859
  export interface ActionTypeArtifactDetails {
769
860
  /**
861
+ * @public
770
862
  * <p>The minimum number of artifacts that can be used with the action type. For example,
771
863
  * you should specify a minimum and maximum of zero input artifacts for an action type with
772
864
  * a category of <code>source</code>.</p>
773
865
  */
774
866
  minimumCount: number | undefined;
775
867
  /**
868
+ * @public
776
869
  * <p>The maximum number of artifacts that can be used with the actiontype. For example, you
777
870
  * should specify a minimum and maximum of zero input artifacts for an action type with a
778
871
  * category of <code>source</code>.</p>
@@ -786,11 +879,13 @@ export interface ActionTypeArtifactDetails {
786
879
  */
787
880
  export interface JobWorkerExecutorConfiguration {
788
881
  /**
882
+ * @public
789
883
  * <p>The accounts in which the job worker is configured and might poll for jobs as part of
790
884
  * the action execution.</p>
791
885
  */
792
886
  pollingAccounts?: string[];
793
887
  /**
888
+ * @public
794
889
  * <p>The service Principals in which the job worker is configured and might poll for jobs
795
890
  * as part of the action execution.</p>
796
891
  */
@@ -803,6 +898,7 @@ export interface JobWorkerExecutorConfiguration {
803
898
  */
804
899
  export interface LambdaExecutorConfiguration {
805
900
  /**
901
+ * @public
806
902
  * <p>The ARN of the Lambda function used by the action engine.</p>
807
903
  */
808
904
  lambdaFunctionArn: string | undefined;
@@ -815,10 +911,12 @@ export interface LambdaExecutorConfiguration {
815
911
  */
816
912
  export interface ExecutorConfiguration {
817
913
  /**
914
+ * @public
818
915
  * <p>Details about the <code>Lambda</code> executor of the action type.</p>
819
916
  */
820
917
  lambdaExecutorConfiguration?: LambdaExecutorConfiguration;
821
918
  /**
919
+ * @public
822
920
  * <p>Details about the <code>JobWorker</code> executor of the action type.</p>
823
921
  */
824
922
  jobWorkerExecutorConfiguration?: JobWorkerExecutorConfiguration;
@@ -844,16 +942,19 @@ export type ExecutorType = (typeof ExecutorType)[keyof typeof ExecutorType];
844
942
  */
845
943
  export interface ActionTypeExecutor {
846
944
  /**
945
+ * @public
847
946
  * <p>The action configuration properties for the action type. These properties are
848
947
  * specified in the action definition when the action type is created.</p>
849
948
  */
850
949
  configuration: ExecutorConfiguration | undefined;
851
950
  /**
951
+ * @public
852
952
  * <p>The integration model used to create and update the action type, <code>Lambda</code>
853
953
  * or <code>JobWorker</code>. </p>
854
954
  */
855
955
  type: ExecutorType | string | undefined;
856
956
  /**
957
+ * @public
857
958
  * <p>The policy statement that specifies the permissions in the CodePipeline customer
858
959
  * account that are needed to successfully run an action.</p>
859
960
  * <p>To grant permission to another account, specify the account ID as the Principal, a
@@ -865,6 +966,7 @@ export interface ActionTypeExecutor {
865
966
  */
866
967
  policyStatementsTemplate?: string;
867
968
  /**
969
+ * @public
868
970
  * <p>The timeout in seconds for the job. An action execution can have multiple jobs. This
869
971
  * is the timeout for a single job, not the entire action execution.</p>
870
972
  */
@@ -876,6 +978,7 @@ export interface ActionTypeExecutor {
876
978
  */
877
979
  export interface ActionTypeIdentifier {
878
980
  /**
981
+ * @public
879
982
  * <p>Defines what kind of action can be taken in the stage, one of the following:</p>
880
983
  * <ul>
881
984
  * <li>
@@ -912,16 +1015,19 @@ export interface ActionTypeIdentifier {
912
1015
  */
913
1016
  category: ActionCategory | string | undefined;
914
1017
  /**
1018
+ * @public
915
1019
  * <p>The creator of the action type being called: <code>AWS</code> or
916
1020
  * <code>ThirdParty</code>.</p>
917
1021
  */
918
1022
  owner: string | undefined;
919
1023
  /**
1024
+ * @public
920
1025
  * <p>The provider of the action type being called. The provider name is supplied when the
921
1026
  * action type is created.</p>
922
1027
  */
923
1028
  provider: string | undefined;
924
1029
  /**
1030
+ * @public
925
1031
  * <p>A string that describes the action type version.</p>
926
1032
  */
927
1033
  version: string | undefined;
@@ -932,6 +1038,7 @@ export interface ActionTypeIdentifier {
932
1038
  */
933
1039
  export interface ActionTypePermissions {
934
1040
  /**
1041
+ * @public
935
1042
  * <p>A list of Amazon Web Services account IDs with access to use the action type in their
936
1043
  * pipelines.</p>
937
1044
  */
@@ -945,30 +1052,36 @@ export interface ActionTypePermissions {
945
1052
  */
946
1053
  export interface ActionTypeProperty {
947
1054
  /**
1055
+ * @public
948
1056
  * <p>The property name that is displayed to users.</p>
949
1057
  */
950
1058
  name: string | undefined;
951
1059
  /**
1060
+ * @public
952
1061
  * <p>Whether the configuration property is an optional value.</p>
953
1062
  */
954
1063
  optional: boolean | undefined;
955
1064
  /**
1065
+ * @public
956
1066
  * <p>Whether the configuration property is a key.</p>
957
1067
  */
958
1068
  key: boolean | undefined;
959
1069
  /**
1070
+ * @public
960
1071
  * <p>Whether to omit the field value entered by the customer in the log. If
961
1072
  * <code>true</code>, the value is not saved in CloudTrail logs for the action
962
1073
  * execution.</p>
963
1074
  */
964
1075
  noEcho: boolean | undefined;
965
1076
  /**
1077
+ * @public
966
1078
  * <p>Indicates that the property is used with polling. An action type can have up to one
967
1079
  * queryable property. If it has one, that property must be both required and not
968
1080
  * secret.</p>
969
1081
  */
970
1082
  queryable?: boolean;
971
1083
  /**
1084
+ * @public
972
1085
  * <p>The description of the property that is displayed to users.</p>
973
1086
  */
974
1087
  description?: string;
@@ -980,22 +1093,26 @@ export interface ActionTypeProperty {
980
1093
  */
981
1094
  export interface ActionTypeUrls {
982
1095
  /**
1096
+ * @public
983
1097
  * <p>The URL returned to the CodePipeline console that contains a link to the page
984
1098
  * where customers can configure the external action.</p>
985
1099
  */
986
1100
  configurationUrl?: string;
987
1101
  /**
1102
+ * @public
988
1103
  * <p>The URL returned to the CodePipeline console that provides a deep link to the
989
1104
  * resources of the external system, such as a status page. This link is provided as part
990
1105
  * of the action display in the pipeline.</p>
991
1106
  */
992
1107
  entityUrlTemplate?: string;
993
1108
  /**
1109
+ * @public
994
1110
  * <p>The link to an execution page for the action type in progress. For example, for a
995
1111
  * CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.</p>
996
1112
  */
997
1113
  executionUrlTemplate?: string;
998
1114
  /**
1115
+ * @public
999
1116
  * <p>The URL returned to the CodePipeline console that contains a link to the page
1000
1117
  * where customers can update or change the configuration of the external action.</p>
1001
1118
  */
@@ -1008,39 +1125,47 @@ export interface ActionTypeUrls {
1008
1125
  */
1009
1126
  export interface ActionTypeDeclaration {
1010
1127
  /**
1128
+ * @public
1011
1129
  * <p>The description for the action type to be updated.</p>
1012
1130
  */
1013
1131
  description?: string;
1014
1132
  /**
1133
+ * @public
1015
1134
  * <p>Information about the executor for an action type that was created with any supported
1016
1135
  * integration model.</p>
1017
1136
  */
1018
1137
  executor: ActionTypeExecutor | undefined;
1019
1138
  /**
1139
+ * @public
1020
1140
  * <p>The action category, owner, provider, and version of the action type to be
1021
1141
  * updated.</p>
1022
1142
  */
1023
1143
  id: ActionTypeIdentifier | undefined;
1024
1144
  /**
1145
+ * @public
1025
1146
  * <p>Details for the artifacts, such as application files, to be worked on by the action.
1026
1147
  * For example, the minimum and maximum number of input artifacts allowed.</p>
1027
1148
  */
1028
1149
  inputArtifactDetails: ActionTypeArtifactDetails | undefined;
1029
1150
  /**
1151
+ * @public
1030
1152
  * <p>Details for the output artifacts, such as a built application, that are the result of
1031
1153
  * the action. For example, the minimum and maximum number of output artifacts
1032
1154
  * allowed.</p>
1033
1155
  */
1034
1156
  outputArtifactDetails: ActionTypeArtifactDetails | undefined;
1035
1157
  /**
1158
+ * @public
1036
1159
  * <p>Details identifying the accounts with permissions to use the action type.</p>
1037
1160
  */
1038
1161
  permissions?: ActionTypePermissions;
1039
1162
  /**
1163
+ * @public
1040
1164
  * <p>The properties of the action type to be updated.</p>
1041
1165
  */
1042
1166
  properties?: ActionTypeProperty[];
1043
1167
  /**
1168
+ * @public
1044
1169
  * <p>The links associated with the action type to be updated.</p>
1045
1170
  */
1046
1171
  urls?: ActionTypeUrls;
@@ -1087,10 +1212,12 @@ export type ApprovalStatus = (typeof ApprovalStatus)[keyof typeof ApprovalStatus
1087
1212
  */
1088
1213
  export interface ApprovalResult {
1089
1214
  /**
1215
+ * @public
1090
1216
  * <p>The summary of the current status of the approval request.</p>
1091
1217
  */
1092
1218
  summary: string | undefined;
1093
1219
  /**
1220
+ * @public
1094
1221
  * <p>The response submitted by a reviewer assigned to an approval action
1095
1222
  * request.</p>
1096
1223
  */
@@ -1102,10 +1229,12 @@ export interface ApprovalResult {
1102
1229
  */
1103
1230
  export interface S3ArtifactLocation {
1104
1231
  /**
1232
+ * @public
1105
1233
  * <p>The name of the S3 bucket.</p>
1106
1234
  */
1107
1235
  bucketName: string | undefined;
1108
1236
  /**
1237
+ * @public
1109
1238
  * <p>The key of the object in the S3 bucket, which uniquely identifies the object in the
1110
1239
  * bucket.</p>
1111
1240
  */
@@ -1128,10 +1257,12 @@ export type ArtifactLocationType = (typeof ArtifactLocationType)[keyof typeof Ar
1128
1257
  */
1129
1258
  export interface ArtifactLocation {
1130
1259
  /**
1260
+ * @public
1131
1261
  * <p>The type of artifact in the location.</p>
1132
1262
  */
1133
1263
  type?: ArtifactLocationType | string;
1134
1264
  /**
1265
+ * @public
1135
1266
  * <p>The S3 bucket that contains the artifact.</p>
1136
1267
  */
1137
1268
  s3Location?: S3ArtifactLocation;
@@ -1145,15 +1276,18 @@ export interface ArtifactLocation {
1145
1276
  */
1146
1277
  export interface Artifact {
1147
1278
  /**
1279
+ * @public
1148
1280
  * <p>The artifact's name.</p>
1149
1281
  */
1150
1282
  name?: string;
1151
1283
  /**
1284
+ * @public
1152
1285
  * <p>The artifact's revision ID. Depending on the type of object, this could be a commit
1153
1286
  * ID (GitHub) or a revision ID (Amazon S3).</p>
1154
1287
  */
1155
1288
  revision?: string;
1156
1289
  /**
1290
+ * @public
1157
1291
  * <p>The location of an artifact.</p>
1158
1292
  */
1159
1293
  location?: ArtifactLocation;
@@ -1164,20 +1298,24 @@ export interface Artifact {
1164
1298
  */
1165
1299
  export interface ArtifactRevision {
1166
1300
  /**
1301
+ * @public
1167
1302
  * <p>The name of an artifact. This name might be system-generated, such as "MyApp", or
1168
1303
  * defined by the user when an action is created.</p>
1169
1304
  */
1170
1305
  name?: string;
1171
1306
  /**
1307
+ * @public
1172
1308
  * <p>The revision ID of the artifact.</p>
1173
1309
  */
1174
1310
  revisionId?: string;
1175
1311
  /**
1312
+ * @public
1176
1313
  * <p>An additional identifier for a revision, such as a commit date or, for artifacts
1177
1314
  * stored in Amazon S3 buckets, the ETag value.</p>
1178
1315
  */
1179
1316
  revisionChangeIdentifier?: string;
1180
1317
  /**
1318
+ * @public
1181
1319
  * <p>Summary information about the most recent revision of the artifact. For GitHub and
1182
1320
  * CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the
1183
1321
  * user-provided content of a <code>codepipeline-artifact-revision-summary</code> key
@@ -1185,11 +1323,13 @@ export interface ArtifactRevision {
1185
1323
  */
1186
1324
  revisionSummary?: string;
1187
1325
  /**
1326
+ * @public
1188
1327
  * <p>The date and time when the most recent revision of the artifact was created, in
1189
1328
  * timestamp format.</p>
1190
1329
  */
1191
1330
  created?: Date;
1192
1331
  /**
1332
+ * @public
1193
1333
  * <p>The commit ID for the artifact revision. For artifacts stored in GitHub or
1194
1334
  * CodeCommit repositories, the commit ID is linked to a commit details page.</p>
1195
1335
  */
@@ -1214,6 +1354,7 @@ export type EncryptionKeyType = (typeof EncryptionKeyType)[keyof typeof Encrypti
1214
1354
  */
1215
1355
  export interface EncryptionKey {
1216
1356
  /**
1357
+ * @public
1217
1358
  * <p>The ID used to identify the key. For an Amazon Web Services KMS key, you can use the
1218
1359
  * key ID, the key ARN, or the alias ARN.</p>
1219
1360
  * <note>
@@ -1226,6 +1367,7 @@ export interface EncryptionKey {
1226
1367
  */
1227
1368
  id: string | undefined;
1228
1369
  /**
1370
+ * @public
1229
1371
  * <p>The type of encryption key, such as an Amazon Web Services KMS key. When creating or
1230
1372
  * updating a pipeline, the value must be set to 'KMS'.</p>
1231
1373
  */
@@ -1254,10 +1396,12 @@ export type ArtifactStoreType = (typeof ArtifactStoreType)[keyof typeof Artifact
1254
1396
  */
1255
1397
  export interface ArtifactStore {
1256
1398
  /**
1399
+ * @public
1257
1400
  * <p>The type of the artifact store, such as S3.</p>
1258
1401
  */
1259
1402
  type: ArtifactStoreType | string | undefined;
1260
1403
  /**
1404
+ * @public
1261
1405
  * <p>The S3 bucket used for storing the artifacts for a pipeline. You can specify the
1262
1406
  * name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline
1263
1407
  * artifacts is created for you based on the name of the pipeline. You can use any S3
@@ -1266,6 +1410,7 @@ export interface ArtifactStore {
1266
1410
  */
1267
1411
  location: string | undefined;
1268
1412
  /**
1413
+ * @public
1269
1414
  * <p>The encryption key used to encrypt the data in the artifact store, such as an
1270
1415
  * Amazon Web Services Key Management Service key. If this is undefined, the default key
1271
1416
  * for Amazon S3 is used.</p>
@@ -1281,14 +1426,17 @@ export interface ArtifactStore {
1281
1426
  */
1282
1427
  export interface AWSSessionCredentials {
1283
1428
  /**
1429
+ * @public
1284
1430
  * <p>The access key for the session.</p>
1285
1431
  */
1286
1432
  accessKeyId: string | undefined;
1287
1433
  /**
1434
+ * @public
1288
1435
  * <p>The secret access key for the session.</p>
1289
1436
  */
1290
1437
  secretAccessKey: string | undefined;
1291
1438
  /**
1439
+ * @public
1292
1440
  * <p>The token for the session.</p>
1293
1441
  */
1294
1442
  sessionToken: string | undefined;
@@ -1310,10 +1458,12 @@ export type BlockerType = (typeof BlockerType)[keyof typeof BlockerType];
1310
1458
  */
1311
1459
  export interface BlockerDeclaration {
1312
1460
  /**
1461
+ * @public
1313
1462
  * <p>Reserved for future use.</p>
1314
1463
  */
1315
1464
  name: string | undefined;
1316
1465
  /**
1466
+ * @public
1317
1467
  * <p>Reserved for future use.</p>
1318
1468
  */
1319
1469
  type: BlockerType | string | undefined;
@@ -1336,10 +1486,12 @@ export declare class ConcurrentModificationException extends __BaseException {
1336
1486
  */
1337
1487
  export interface Tag {
1338
1488
  /**
1489
+ * @public
1339
1490
  * <p>The tag's key.</p>
1340
1491
  */
1341
1492
  key: string | undefined;
1342
1493
  /**
1494
+ * @public
1343
1495
  * <p>The tag's value.</p>
1344
1496
  */
1345
1497
  value: string | undefined;
@@ -1350,24 +1502,29 @@ export interface Tag {
1350
1502
  */
1351
1503
  export interface CreateCustomActionTypeInput {
1352
1504
  /**
1505
+ * @public
1353
1506
  * <p>The category of the custom action, such as a build action or a test
1354
1507
  * action.</p>
1355
1508
  */
1356
1509
  category: ActionCategory | string | undefined;
1357
1510
  /**
1511
+ * @public
1358
1512
  * <p>The provider of the service used in the custom action, such as
1359
1513
  * CodeDeploy.</p>
1360
1514
  */
1361
1515
  provider: string | undefined;
1362
1516
  /**
1517
+ * @public
1363
1518
  * <p>The version identifier of the custom action.</p>
1364
1519
  */
1365
1520
  version: string | undefined;
1366
1521
  /**
1522
+ * @public
1367
1523
  * <p>URLs that provide users information about this custom action.</p>
1368
1524
  */
1369
1525
  settings?: ActionTypeSettings;
1370
1526
  /**
1527
+ * @public
1371
1528
  * <p>The configuration properties for the custom action.</p>
1372
1529
  * <note>
1373
1530
  * <p>You can refer to a name in the configuration properties of the custom action
@@ -1379,14 +1536,17 @@ export interface CreateCustomActionTypeInput {
1379
1536
  */
1380
1537
  configurationProperties?: ActionConfigurationProperty[];
1381
1538
  /**
1539
+ * @public
1382
1540
  * <p>The details of the input artifact for the action, such as its commit ID.</p>
1383
1541
  */
1384
1542
  inputArtifactDetails: ArtifactDetails | undefined;
1385
1543
  /**
1544
+ * @public
1386
1545
  * <p>The details of the output artifact of the action, such as its commit ID.</p>
1387
1546
  */
1388
1547
  outputArtifactDetails: ArtifactDetails | undefined;
1389
1548
  /**
1549
+ * @public
1390
1550
  * <p>The tags for the custom action.</p>
1391
1551
  */
1392
1552
  tags?: Tag[];
@@ -1397,10 +1557,12 @@ export interface CreateCustomActionTypeInput {
1397
1557
  */
1398
1558
  export interface CreateCustomActionTypeOutput {
1399
1559
  /**
1560
+ * @public
1400
1561
  * <p>Returns information about the details of an action type.</p>
1401
1562
  */
1402
1563
  actionType: ActionType | undefined;
1403
1564
  /**
1565
+ * @public
1404
1566
  * <p>Specifies the tags applied to the custom action.</p>
1405
1567
  */
1406
1568
  tags?: Tag[];
@@ -1448,14 +1610,17 @@ export declare class TooManyTagsException extends __BaseException {
1448
1610
  */
1449
1611
  export interface StageDeclaration {
1450
1612
  /**
1613
+ * @public
1451
1614
  * <p>The name of the stage.</p>
1452
1615
  */
1453
1616
  name: string | undefined;
1454
1617
  /**
1618
+ * @public
1455
1619
  * <p>Reserved for future use.</p>
1456
1620
  */
1457
1621
  blockers?: BlockerDeclaration[];
1458
1622
  /**
1623
+ * @public
1459
1624
  * <p>The actions included in a stage.</p>
1460
1625
  */
1461
1626
  actions: ActionDeclaration[] | undefined;
@@ -1467,16 +1632,19 @@ export interface StageDeclaration {
1467
1632
  */
1468
1633
  export interface PipelineDeclaration {
1469
1634
  /**
1635
+ * @public
1470
1636
  * <p>The name of the pipeline.</p>
1471
1637
  */
1472
1638
  name: string | undefined;
1473
1639
  /**
1640
+ * @public
1474
1641
  * <p>The Amazon Resource Name (ARN) for CodePipeline to use to either perform
1475
1642
  * actions with no <code>actionRoleArn</code>, or to use to assume roles for actions with
1476
1643
  * an <code>actionRoleArn</code>.</p>
1477
1644
  */
1478
1645
  roleArn: string | undefined;
1479
1646
  /**
1647
+ * @public
1480
1648
  * <p>Represents information about the S3 bucket where artifacts are stored for the
1481
1649
  * pipeline.</p>
1482
1650
  * <note>
@@ -1488,6 +1656,7 @@ export interface PipelineDeclaration {
1488
1656
  */
1489
1657
  artifactStore?: ArtifactStore;
1490
1658
  /**
1659
+ * @public
1491
1660
  * <p>A mapping of <code>artifactStore</code> objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for
1492
1661
  * each cross-region action in the pipeline.</p>
1493
1662
  * <note>
@@ -1499,10 +1668,12 @@ export interface PipelineDeclaration {
1499
1668
  */
1500
1669
  artifactStores?: Record<string, ArtifactStore>;
1501
1670
  /**
1671
+ * @public
1502
1672
  * <p>The stage in which to perform the action.</p>
1503
1673
  */
1504
1674
  stages: StageDeclaration[] | undefined;
1505
1675
  /**
1676
+ * @public
1506
1677
  * <p>The version number of the pipeline. A new pipeline always has a version number of
1507
1678
  * 1. This number is incremented when a pipeline is updated.</p>
1508
1679
  */
@@ -1514,11 +1685,13 @@ export interface PipelineDeclaration {
1514
1685
  */
1515
1686
  export interface CreatePipelineInput {
1516
1687
  /**
1688
+ * @public
1517
1689
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
1518
1690
  * </p>
1519
1691
  */
1520
1692
  pipeline: PipelineDeclaration | undefined;
1521
1693
  /**
1694
+ * @public
1522
1695
  * <p>The tags for the pipeline.</p>
1523
1696
  */
1524
1697
  tags?: Tag[];
@@ -1529,11 +1702,13 @@ export interface CreatePipelineInput {
1529
1702
  */
1530
1703
  export interface CreatePipelineOutput {
1531
1704
  /**
1705
+ * @public
1532
1706
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
1533
1707
  * </p>
1534
1708
  */
1535
1709
  pipeline?: PipelineDeclaration;
1536
1710
  /**
1711
+ * @public
1537
1712
  * <p>Specifies the tags applied to the pipeline.</p>
1538
1713
  */
1539
1714
  tags?: Tag[];
@@ -1605,16 +1780,19 @@ export declare class PipelineNameInUseException extends __BaseException {
1605
1780
  */
1606
1781
  export interface DeleteCustomActionTypeInput {
1607
1782
  /**
1783
+ * @public
1608
1784
  * <p>The category of the custom action that you want to delete, such as source or
1609
1785
  * deploy.</p>
1610
1786
  */
1611
1787
  category: ActionCategory | string | undefined;
1612
1788
  /**
1789
+ * @public
1613
1790
  * <p>The provider of the service used in the custom action, such as
1614
1791
  * CodeDeploy.</p>
1615
1792
  */
1616
1793
  provider: string | undefined;
1617
1794
  /**
1795
+ * @public
1618
1796
  * <p>The version of the custom action to delete.</p>
1619
1797
  */
1620
1798
  version: string | undefined;
@@ -1625,6 +1803,7 @@ export interface DeleteCustomActionTypeInput {
1625
1803
  */
1626
1804
  export interface DeletePipelineInput {
1627
1805
  /**
1806
+ * @public
1628
1807
  * <p>The name of the pipeline to be deleted.</p>
1629
1808
  */
1630
1809
  name: string | undefined;
@@ -1634,6 +1813,7 @@ export interface DeletePipelineInput {
1634
1813
  */
1635
1814
  export interface DeleteWebhookInput {
1636
1815
  /**
1816
+ * @public
1637
1817
  * <p>The name of the webhook you want to delete.</p>
1638
1818
  */
1639
1819
  name: string | undefined;
@@ -1648,6 +1828,7 @@ export interface DeleteWebhookOutput {
1648
1828
  */
1649
1829
  export interface DeregisterWebhookWithThirdPartyInput {
1650
1830
  /**
1831
+ * @public
1651
1832
  * <p>The name of the webhook you want to deregister.</p>
1652
1833
  */
1653
1834
  webhookName?: string;
@@ -1688,16 +1869,19 @@ export type StageTransitionType = (typeof StageTransitionType)[keyof typeof Stag
1688
1869
  */
1689
1870
  export interface DisableStageTransitionInput {
1690
1871
  /**
1872
+ * @public
1691
1873
  * <p>The name of the pipeline in which you want to disable the flow of artifacts from
1692
1874
  * one stage to another.</p>
1693
1875
  */
1694
1876
  pipelineName: string | undefined;
1695
1877
  /**
1878
+ * @public
1696
1879
  * <p>The name of the stage where you want to disable the inbound or outbound transition
1697
1880
  * of artifacts.</p>
1698
1881
  */
1699
1882
  stageName: string | undefined;
1700
1883
  /**
1884
+ * @public
1701
1885
  * <p>Specifies whether artifacts are prevented from transitioning into the stage and
1702
1886
  * being processed by the actions in that stage (inbound), or prevented from transitioning
1703
1887
  * from the stage after they have been processed by the actions in that stage
@@ -1705,6 +1889,7 @@ export interface DisableStageTransitionInput {
1705
1889
  */
1706
1890
  transitionType: StageTransitionType | string | undefined;
1707
1891
  /**
1892
+ * @public
1708
1893
  * <p>The reason given to the user that a stage is disabled, such as waiting for manual
1709
1894
  * approval or manual tests. This message is displayed in the pipeline console
1710
1895
  * UI.</p>
@@ -1741,16 +1926,19 @@ export declare class StageNotFoundException extends __BaseException {
1741
1926
  */
1742
1927
  export interface EnableStageTransitionInput {
1743
1928
  /**
1929
+ * @public
1744
1930
  * <p>The name of the pipeline in which you want to enable the flow of artifacts from one
1745
1931
  * stage to another.</p>
1746
1932
  */
1747
1933
  pipelineName: string | undefined;
1748
1934
  /**
1935
+ * @public
1749
1936
  * <p>The name of the stage where you want to enable the transition of artifacts, either
1750
1937
  * into the stage (inbound) or from that stage to the next stage (outbound).</p>
1751
1938
  */
1752
1939
  stageName: string | undefined;
1753
1940
  /**
1941
+ * @public
1754
1942
  * <p>Specifies whether artifacts are allowed to enter the stage and be processed by the
1755
1943
  * actions in that stage (inbound) or whether already processed artifacts are allowed to
1756
1944
  * transition to the next stage (outbound).</p>
@@ -1762,6 +1950,7 @@ export interface EnableStageTransitionInput {
1762
1950
  */
1763
1951
  export interface GetActionTypeInput {
1764
1952
  /**
1953
+ * @public
1765
1954
  * <p>Defines what kind of action can be taken in the stage. The following are the valid
1766
1955
  * values:</p>
1767
1956
  * <ul>
@@ -1799,16 +1988,19 @@ export interface GetActionTypeInput {
1799
1988
  */
1800
1989
  category: ActionCategory | string | undefined;
1801
1990
  /**
1991
+ * @public
1802
1992
  * <p>The creator of an action type that was created with any supported integration model.
1803
1993
  * There are two valid values: <code>AWS</code> and <code>ThirdParty</code>.</p>
1804
1994
  */
1805
1995
  owner: string | undefined;
1806
1996
  /**
1997
+ * @public
1807
1998
  * <p>The provider of the action type being called. The provider name is specified when the
1808
1999
  * action type is created.</p>
1809
2000
  */
1810
2001
  provider: string | undefined;
1811
2002
  /**
2003
+ * @public
1812
2004
  * <p>A string that describes the action type version.</p>
1813
2005
  */
1814
2006
  version: string | undefined;
@@ -1818,6 +2010,7 @@ export interface GetActionTypeInput {
1818
2010
  */
1819
2011
  export interface GetActionTypeOutput {
1820
2012
  /**
2013
+ * @public
1821
2014
  * <p>The action type information for the requested action type, such as the action type
1822
2015
  * ID.</p>
1823
2016
  */
@@ -1829,6 +2022,7 @@ export interface GetActionTypeOutput {
1829
2022
  */
1830
2023
  export interface GetJobDetailsInput {
1831
2024
  /**
2025
+ * @public
1832
2026
  * <p>The unique system-generated ID for the job.</p>
1833
2027
  */
1834
2028
  jobId: string | undefined;
@@ -1839,6 +2033,7 @@ export interface GetJobDetailsInput {
1839
2033
  */
1840
2034
  export interface StageContext {
1841
2035
  /**
2036
+ * @public
1842
2037
  * <p>The name of the stage.</p>
1843
2038
  */
1844
2039
  name?: string;
@@ -1855,23 +2050,28 @@ export interface StageContext {
1855
2050
  */
1856
2051
  export interface PipelineContext {
1857
2052
  /**
2053
+ * @public
1858
2054
  * <p>The name of the pipeline. This is a user-specified value. Pipeline names must be
1859
2055
  * unique across all pipeline names under an Amazon Web Services account.</p>
1860
2056
  */
1861
2057
  pipelineName?: string;
1862
2058
  /**
2059
+ * @public
1863
2060
  * <p>The stage of the pipeline.</p>
1864
2061
  */
1865
2062
  stage?: StageContext;
1866
2063
  /**
2064
+ * @public
1867
2065
  * <p>The context of an action to a job worker in the stage of a pipeline.</p>
1868
2066
  */
1869
2067
  action?: ActionContext;
1870
2068
  /**
2069
+ * @public
1871
2070
  * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
1872
2071
  */
1873
2072
  pipelineArn?: string;
1874
2073
  /**
2074
+ * @public
1875
2075
  * <p>The execution ID of the pipeline.</p>
1876
2076
  */
1877
2077
  pipelineExecutionId?: string;
@@ -1883,14 +2083,17 @@ export interface PipelineContext {
1883
2083
  */
1884
2084
  export interface JobData {
1885
2085
  /**
2086
+ * @public
1886
2087
  * <p>Represents information about an action type.</p>
1887
2088
  */
1888
2089
  actionTypeId?: ActionTypeId;
1889
2090
  /**
2091
+ * @public
1890
2092
  * <p>Represents information about an action configuration.</p>
1891
2093
  */
1892
2094
  actionConfiguration?: ActionConfiguration;
1893
2095
  /**
2096
+ * @public
1894
2097
  * <p>Represents information about a pipeline to a job worker.</p>
1895
2098
  * <note>
1896
2099
  * <p>Includes <code>pipelineArn</code> and <code>pipelineExecutionId</code> for
@@ -1899,14 +2102,17 @@ export interface JobData {
1899
2102
  */
1900
2103
  pipelineContext?: PipelineContext;
1901
2104
  /**
2105
+ * @public
1902
2106
  * <p>The artifact supplied to the job.</p>
1903
2107
  */
1904
2108
  inputArtifacts?: Artifact[];
1905
2109
  /**
2110
+ * @public
1906
2111
  * <p>The output of the job.</p>
1907
2112
  */
1908
2113
  outputArtifacts?: Artifact[];
1909
2114
  /**
2115
+ * @public
1910
2116
  * <p>Represents an Amazon Web Services session credentials object. These credentials are
1911
2117
  * temporary credentials that are issued by Amazon Web Services Secure Token Service (STS).
1912
2118
  * They can be used to access input and output artifacts in the S3 bucket used to store
@@ -1914,11 +2120,13 @@ export interface JobData {
1914
2120
  */
1915
2121
  artifactCredentials?: AWSSessionCredentials;
1916
2122
  /**
2123
+ * @public
1917
2124
  * <p>A system-generated token, such as a deployment ID, required by a job to continue
1918
2125
  * the job asynchronously.</p>
1919
2126
  */
1920
2127
  continuationToken?: string;
1921
2128
  /**
2129
+ * @public
1922
2130
  * <p>Represents information about the key used to encrypt data in the artifact store,
1923
2131
  * such as an KMS key. </p>
1924
2132
  */
@@ -1930,15 +2138,18 @@ export interface JobData {
1930
2138
  */
1931
2139
  export interface JobDetails {
1932
2140
  /**
2141
+ * @public
1933
2142
  * <p>The unique system-generated ID of the job.</p>
1934
2143
  */
1935
2144
  id?: string;
1936
2145
  /**
2146
+ * @public
1937
2147
  * <p>Represents other information about a job required for a job worker to complete the
1938
2148
  * job. </p>
1939
2149
  */
1940
2150
  data?: JobData;
1941
2151
  /**
2152
+ * @public
1942
2153
  * <p>The Amazon Web Services account ID associated with the job.</p>
1943
2154
  */
1944
2155
  accountId?: string;
@@ -1949,6 +2160,7 @@ export interface JobDetails {
1949
2160
  */
1950
2161
  export interface GetJobDetailsOutput {
1951
2162
  /**
2163
+ * @public
1952
2164
  * <p>The details of the job.</p>
1953
2165
  * <note>
1954
2166
  * <p>If AWSSessionCredentials is used, a long-running job can call
@@ -1963,11 +2175,13 @@ export interface GetJobDetailsOutput {
1963
2175
  */
1964
2176
  export interface GetPipelineInput {
1965
2177
  /**
2178
+ * @public
1966
2179
  * <p>The name of the pipeline for which you want to get information. Pipeline names must
1967
2180
  * be unique in an Amazon Web Services account.</p>
1968
2181
  */
1969
2182
  name: string | undefined;
1970
2183
  /**
2184
+ * @public
1971
2185
  * <p>The version number of the pipeline. If you do not specify a version, defaults to
1972
2186
  * the current version.</p>
1973
2187
  */
@@ -1979,18 +2193,22 @@ export interface GetPipelineInput {
1979
2193
  */
1980
2194
  export interface PipelineMetadata {
1981
2195
  /**
2196
+ * @public
1982
2197
  * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
1983
2198
  */
1984
2199
  pipelineArn?: string;
1985
2200
  /**
2201
+ * @public
1986
2202
  * <p>The date and time the pipeline was created, in timestamp format.</p>
1987
2203
  */
1988
2204
  created?: Date;
1989
2205
  /**
2206
+ * @public
1990
2207
  * <p>The date and time the pipeline was last updated, in timestamp format.</p>
1991
2208
  */
1992
2209
  updated?: Date;
1993
2210
  /**
2211
+ * @public
1994
2212
  * <p>The date and time that polling for source changes (periodic checks) was stopped for
1995
2213
  * the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use
1996
2214
  * event-based change detection. For example, for a pipeline with a CodeCommit
@@ -2007,11 +2225,13 @@ export interface PipelineMetadata {
2007
2225
  */
2008
2226
  export interface GetPipelineOutput {
2009
2227
  /**
2228
+ * @public
2010
2229
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
2011
2230
  * </p>
2012
2231
  */
2013
2232
  pipeline?: PipelineDeclaration;
2014
2233
  /**
2234
+ * @public
2015
2235
  * <p>Represents the pipeline metadata information returned as part of the output of a
2016
2236
  * <code>GetPipeline</code> action.</p>
2017
2237
  */
@@ -2036,10 +2256,12 @@ export declare class PipelineVersionNotFoundException extends __BaseException {
2036
2256
  */
2037
2257
  export interface GetPipelineExecutionInput {
2038
2258
  /**
2259
+ * @public
2039
2260
  * <p>The name of the pipeline about which you want to get execution details.</p>
2040
2261
  */
2041
2262
  pipelineName: string | undefined;
2042
2263
  /**
2264
+ * @public
2043
2265
  * <p>The ID of the pipeline execution about which you want to get execution
2044
2266
  * details.</p>
2045
2267
  */
@@ -2068,18 +2290,22 @@ export type PipelineExecutionStatus = (typeof PipelineExecutionStatus)[keyof typ
2068
2290
  */
2069
2291
  export interface PipelineExecution {
2070
2292
  /**
2293
+ * @public
2071
2294
  * <p>The name of the pipeline with the specified pipeline execution.</p>
2072
2295
  */
2073
2296
  pipelineName?: string;
2074
2297
  /**
2298
+ * @public
2075
2299
  * <p>The version number of the pipeline with the specified pipeline execution.</p>
2076
2300
  */
2077
2301
  pipelineVersion?: number;
2078
2302
  /**
2303
+ * @public
2079
2304
  * <p>The ID of the pipeline execution.</p>
2080
2305
  */
2081
2306
  pipelineExecutionId?: string;
2082
2307
  /**
2308
+ * @public
2083
2309
  * <p>The status of the pipeline execution.</p>
2084
2310
  * <ul>
2085
2311
  * <li>
@@ -2113,10 +2339,12 @@ export interface PipelineExecution {
2113
2339
  */
2114
2340
  status?: PipelineExecutionStatus | string;
2115
2341
  /**
2342
+ * @public
2116
2343
  * <p>A summary that contains a description of the pipeline execution status.</p>
2117
2344
  */
2118
2345
  statusSummary?: string;
2119
2346
  /**
2347
+ * @public
2120
2348
  * <p>A list of <code>ArtifactRevision</code> objects included in a pipeline
2121
2349
  * execution.</p>
2122
2350
  */
@@ -2128,6 +2356,7 @@ export interface PipelineExecution {
2128
2356
  */
2129
2357
  export interface GetPipelineExecutionOutput {
2130
2358
  /**
2359
+ * @public
2131
2360
  * <p>Represents information about the execution of a pipeline.</p>
2132
2361
  */
2133
2362
  pipelineExecution?: PipelineExecution;
@@ -2151,6 +2380,7 @@ export declare class PipelineExecutionNotFoundException extends __BaseException
2151
2380
  */
2152
2381
  export interface GetPipelineStateInput {
2153
2382
  /**
2383
+ * @public
2154
2384
  * <p>The name of the pipeline about which you want to get information.</p>
2155
2385
  */
2156
2386
  name: string | undefined;
@@ -2177,10 +2407,12 @@ export type StageExecutionStatus = (typeof StageExecutionStatus)[keyof typeof St
2177
2407
  */
2178
2408
  export interface StageExecution {
2179
2409
  /**
2410
+ * @public
2180
2411
  * <p>The ID of the pipeline execution associated with the stage.</p>
2181
2412
  */
2182
2413
  pipelineExecutionId: string | undefined;
2183
2414
  /**
2415
+ * @public
2184
2416
  * <p>The status of the stage, or for a completed stage, the last status of the
2185
2417
  * stage.</p>
2186
2418
  * <note>
@@ -2197,19 +2429,23 @@ export interface StageExecution {
2197
2429
  */
2198
2430
  export interface TransitionState {
2199
2431
  /**
2432
+ * @public
2200
2433
  * <p>Whether the transition between stages is enabled (true) or disabled
2201
2434
  * (false).</p>
2202
2435
  */
2203
2436
  enabled?: boolean;
2204
2437
  /**
2438
+ * @public
2205
2439
  * <p>The ID of the user who last changed the transition state.</p>
2206
2440
  */
2207
2441
  lastChangedBy?: string;
2208
2442
  /**
2443
+ * @public
2209
2444
  * <p>The timestamp when the transition state was last changed.</p>
2210
2445
  */
2211
2446
  lastChangedAt?: Date;
2212
2447
  /**
2448
+ * @public
2213
2449
  * <p>The user-specified reason why the transition between two stages of a pipeline was
2214
2450
  * disabled.</p>
2215
2451
  */
@@ -2221,22 +2457,27 @@ export interface TransitionState {
2221
2457
  */
2222
2458
  export interface StageState {
2223
2459
  /**
2460
+ * @public
2224
2461
  * <p>The name of the stage.</p>
2225
2462
  */
2226
2463
  stageName?: string;
2227
2464
  /**
2465
+ * @public
2228
2466
  * <p>Represents information about the run of a stage.</p>
2229
2467
  */
2230
2468
  inboundExecution?: StageExecution;
2231
2469
  /**
2470
+ * @public
2232
2471
  * <p>The state of the inbound transition, which is either enabled or disabled.</p>
2233
2472
  */
2234
2473
  inboundTransitionState?: TransitionState;
2235
2474
  /**
2475
+ * @public
2236
2476
  * <p>The state of the stage.</p>
2237
2477
  */
2238
2478
  actionStates?: ActionState[];
2239
2479
  /**
2480
+ * @public
2240
2481
  * <p>Information about the latest execution in the stage, including its ID and
2241
2482
  * status.</p>
2242
2483
  */
@@ -2248,10 +2489,12 @@ export interface StageState {
2248
2489
  */
2249
2490
  export interface GetPipelineStateOutput {
2250
2491
  /**
2492
+ * @public
2251
2493
  * <p>The name of the pipeline for which you want to get the state.</p>
2252
2494
  */
2253
2495
  pipelineName?: string;
2254
2496
  /**
2497
+ * @public
2255
2498
  * <p>The version number of the pipeline.</p>
2256
2499
  * <note>
2257
2500
  * <p>A newly created pipeline is always assigned a version number of
@@ -2260,15 +2503,18 @@ export interface GetPipelineStateOutput {
2260
2503
  */
2261
2504
  pipelineVersion?: number;
2262
2505
  /**
2506
+ * @public
2263
2507
  * <p>A list of the pipeline stage output information, including stage name, state, most
2264
2508
  * recent run details, whether the stage is disabled, and other data.</p>
2265
2509
  */
2266
2510
  stageStates?: StageState[];
2267
2511
  /**
2512
+ * @public
2268
2513
  * <p>The date and time the pipeline was created, in timestamp format.</p>
2269
2514
  */
2270
2515
  created?: Date;
2271
2516
  /**
2517
+ * @public
2272
2518
  * <p>The date and time the pipeline was last updated, in timestamp format.</p>
2273
2519
  */
2274
2520
  updated?: Date;
@@ -2279,10 +2525,12 @@ export interface GetPipelineStateOutput {
2279
2525
  */
2280
2526
  export interface GetThirdPartyJobDetailsInput {
2281
2527
  /**
2528
+ * @public
2282
2529
  * <p>The unique system-generated ID used for identifying the job.</p>
2283
2530
  */
2284
2531
  jobId: string | undefined;
2285
2532
  /**
2533
+ * @public
2286
2534
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
2287
2535
  * the calling entity is allowed access to the job and its details.</p>
2288
2536
  */
@@ -2294,14 +2542,17 @@ export interface GetThirdPartyJobDetailsInput {
2294
2542
  */
2295
2543
  export interface ThirdPartyJobData {
2296
2544
  /**
2545
+ * @public
2297
2546
  * <p>Represents information about an action type.</p>
2298
2547
  */
2299
2548
  actionTypeId?: ActionTypeId;
2300
2549
  /**
2550
+ * @public
2301
2551
  * <p>Represents information about an action configuration.</p>
2302
2552
  */
2303
2553
  actionConfiguration?: ActionConfiguration;
2304
2554
  /**
2555
+ * @public
2305
2556
  * <p>Represents information about a pipeline to a job worker.</p>
2306
2557
  * <note>
2307
2558
  * <p>Does not include <code>pipelineArn</code> and <code>pipelineExecutionId</code>
@@ -2310,6 +2561,7 @@ export interface ThirdPartyJobData {
2310
2561
  */
2311
2562
  pipelineContext?: PipelineContext;
2312
2563
  /**
2564
+ * @public
2313
2565
  * <p>The name of the artifact that is worked on by the action, if any. This name might
2314
2566
  * be system-generated, such as "MyApp", or it might be defined by the user when the action
2315
2567
  * is created. The input artifact name must match the name of an output artifact generated
@@ -2317,12 +2569,14 @@ export interface ThirdPartyJobData {
2317
2569
  */
2318
2570
  inputArtifacts?: Artifact[];
2319
2571
  /**
2572
+ * @public
2320
2573
  * <p>The name of the artifact that is the result of the action, if any. This name might
2321
2574
  * be system-generated, such as "MyBuiltApp", or it might be defined by the user when the
2322
2575
  * action is created.</p>
2323
2576
  */
2324
2577
  outputArtifacts?: Artifact[];
2325
2578
  /**
2579
+ * @public
2326
2580
  * <p>Represents an Amazon Web Services session credentials object. These credentials are
2327
2581
  * temporary credentials that are issued by Amazon Web Services Secure Token Service (STS).
2328
2582
  * They can be used to access input and output artifacts in the S3 bucket used to store
@@ -2330,11 +2584,13 @@ export interface ThirdPartyJobData {
2330
2584
  */
2331
2585
  artifactCredentials?: AWSSessionCredentials;
2332
2586
  /**
2587
+ * @public
2333
2588
  * <p>A system-generated token, such as a CodeDeploy deployment ID, that a job requires
2334
2589
  * to continue the job asynchronously.</p>
2335
2590
  */
2336
2591
  continuationToken?: string;
2337
2592
  /**
2593
+ * @public
2338
2594
  * <p>The encryption key used to encrypt and decrypt data in the artifact store for the
2339
2595
  * pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS)
2340
2596
  * key. This is optional and might not be present.</p>
@@ -2348,14 +2604,17 @@ export interface ThirdPartyJobData {
2348
2604
  */
2349
2605
  export interface ThirdPartyJobDetails {
2350
2606
  /**
2607
+ * @public
2351
2608
  * <p>The identifier used to identify the job details in CodePipeline.</p>
2352
2609
  */
2353
2610
  id?: string;
2354
2611
  /**
2612
+ * @public
2355
2613
  * <p>The data to be returned by the third party job worker.</p>
2356
2614
  */
2357
2615
  data?: ThirdPartyJobData;
2358
2616
  /**
2617
+ * @public
2359
2618
  * <p>A system-generated random number that CodePipeline uses to ensure that the
2360
2619
  * job is being worked on by only one job worker. Use this number in an <a>AcknowledgeThirdPartyJob</a> request.</p>
2361
2620
  */
@@ -2367,6 +2626,7 @@ export interface ThirdPartyJobDetails {
2367
2626
  */
2368
2627
  export interface GetThirdPartyJobDetailsOutput {
2369
2628
  /**
2629
+ * @public
2370
2630
  * <p>The details of the job, including any protected values defined for the
2371
2631
  * job.</p>
2372
2632
  */
@@ -2402,14 +2662,17 @@ export declare class InvalidNextTokenException extends __BaseException {
2402
2662
  */
2403
2663
  export interface ListActionExecutionsInput {
2404
2664
  /**
2665
+ * @public
2405
2666
  * <p> The name of the pipeline for which you want to list action execution history.</p>
2406
2667
  */
2407
2668
  pipelineName: string | undefined;
2408
2669
  /**
2670
+ * @public
2409
2671
  * <p>Input information used to filter action execution history.</p>
2410
2672
  */
2411
2673
  filter?: ActionExecutionFilter;
2412
2674
  /**
2675
+ * @public
2413
2676
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
2414
2677
  * results, make another call with the returned nextToken value. Action execution history
2415
2678
  * is retained for up to 12 months, based on action execution start times. Default value is
@@ -2421,6 +2684,7 @@ export interface ListActionExecutionsInput {
2421
2684
  */
2422
2685
  maxResults?: number;
2423
2686
  /**
2687
+ * @public
2424
2688
  * <p>The token that was returned from the previous <code>ListActionExecutions</code> call,
2425
2689
  * which can be used to return the next set of action executions in the list.</p>
2426
2690
  */
@@ -2431,10 +2695,12 @@ export interface ListActionExecutionsInput {
2431
2695
  */
2432
2696
  export interface ListActionExecutionsOutput {
2433
2697
  /**
2698
+ * @public
2434
2699
  * <p>The details for a list of recent executions, such as action execution ID.</p>
2435
2700
  */
2436
2701
  actionExecutionDetails?: ActionExecutionDetail[];
2437
2702
  /**
2703
+ * @public
2438
2704
  * <p>If the amount of returned information is significantly large, an identifier is also
2439
2705
  * returned and can be used in a subsequent <code>ListActionExecutions</code> call to
2440
2706
  * return the next set of action executions in the list.</p>
@@ -2447,15 +2713,18 @@ export interface ListActionExecutionsOutput {
2447
2713
  */
2448
2714
  export interface ListActionTypesInput {
2449
2715
  /**
2716
+ * @public
2450
2717
  * <p>Filters the list of action types to those created by a specified entity.</p>
2451
2718
  */
2452
2719
  actionOwnerFilter?: ActionOwner | string;
2453
2720
  /**
2721
+ * @public
2454
2722
  * <p>An identifier that was returned from the previous list action types call, which can
2455
2723
  * be used to return the next set of action types in the list.</p>
2456
2724
  */
2457
2725
  nextToken?: string;
2458
2726
  /**
2727
+ * @public
2459
2728
  * <p>The Region to filter on for the list of action types.</p>
2460
2729
  */
2461
2730
  regionFilter?: string;
@@ -2466,10 +2735,12 @@ export interface ListActionTypesInput {
2466
2735
  */
2467
2736
  export interface ListActionTypesOutput {
2468
2737
  /**
2738
+ * @public
2469
2739
  * <p>Provides details of the action types.</p>
2470
2740
  */
2471
2741
  actionTypes: ActionType[] | undefined;
2472
2742
  /**
2743
+ * @public
2473
2744
  * <p>If the amount of returned information is significantly large, an identifier is also
2474
2745
  * returned. It can be used in a subsequent list action types call to return the next set
2475
2746
  * of action types in the list.</p>
@@ -2482,11 +2753,13 @@ export interface ListActionTypesOutput {
2482
2753
  */
2483
2754
  export interface ListPipelineExecutionsInput {
2484
2755
  /**
2756
+ * @public
2485
2757
  * <p>The name of the pipeline for which you want to get execution summary
2486
2758
  * information.</p>
2487
2759
  */
2488
2760
  pipelineName: string | undefined;
2489
2761
  /**
2762
+ * @public
2490
2763
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
2491
2764
  * results, make another call with the returned nextToken value. Pipeline history is
2492
2765
  * limited to the most recent 12 months, based on pipeline execution start times. Default
@@ -2494,6 +2767,7 @@ export interface ListPipelineExecutionsInput {
2494
2767
  */
2495
2768
  maxResults?: number;
2496
2769
  /**
2770
+ * @public
2497
2771
  * <p>The token that was returned from the previous <code>ListPipelineExecutions</code>
2498
2772
  * call, which can be used to return the next set of pipeline executions in the
2499
2773
  * list.</p>
@@ -2507,16 +2781,19 @@ export interface ListPipelineExecutionsInput {
2507
2781
  */
2508
2782
  export interface SourceRevision {
2509
2783
  /**
2784
+ * @public
2510
2785
  * <p>The name of the action that processed the revision to the source
2511
2786
  * artifact.</p>
2512
2787
  */
2513
2788
  actionName: string | undefined;
2514
2789
  /**
2790
+ * @public
2515
2791
  * <p>The system-generated unique ID that identifies the revision number of the
2516
2792
  * artifact.</p>
2517
2793
  */
2518
2794
  revisionId?: string;
2519
2795
  /**
2796
+ * @public
2520
2797
  * <p>Summary information about the most recent revision of the artifact. For GitHub and
2521
2798
  * CodeCommit repositories, the commit message. For Amazon S3 buckets or actions,
2522
2799
  * the user-provided content of a <code>codepipeline-artifact-revision-summary</code> key
@@ -2524,6 +2801,7 @@ export interface SourceRevision {
2524
2801
  */
2525
2802
  revisionSummary?: string;
2526
2803
  /**
2804
+ * @public
2527
2805
  * <p>The commit ID for the artifact revision. For artifacts stored in GitHub or
2528
2806
  * CodeCommit repositories, the commit ID is linked to a commit details page.</p>
2529
2807
  */
@@ -2535,6 +2813,7 @@ export interface SourceRevision {
2535
2813
  */
2536
2814
  export interface StopExecutionTrigger {
2537
2815
  /**
2816
+ * @public
2538
2817
  * <p>The user-specified reason the pipeline was stopped.</p>
2539
2818
  */
2540
2819
  reason?: string;
@@ -2561,11 +2840,13 @@ export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType];
2561
2840
  */
2562
2841
  export interface ExecutionTrigger {
2563
2842
  /**
2843
+ * @public
2564
2844
  * <p>The type of change-detection method, command, or user interaction that started a
2565
2845
  * pipeline execution.</p>
2566
2846
  */
2567
2847
  triggerType?: TriggerType | string;
2568
2848
  /**
2849
+ * @public
2569
2850
  * <p>Detail related to the event that started a pipeline execution, such as the webhook ARN
2570
2851
  * of the webhook that triggered the pipeline execution or the user ARN for a
2571
2852
  * user-initiated <code>start-pipeline-execution</code> CLI command.</p>
@@ -2578,10 +2859,12 @@ export interface ExecutionTrigger {
2578
2859
  */
2579
2860
  export interface PipelineExecutionSummary {
2580
2861
  /**
2862
+ * @public
2581
2863
  * <p>The ID of the pipeline execution.</p>
2582
2864
  */
2583
2865
  pipelineExecutionId?: string;
2584
2866
  /**
2867
+ * @public
2585
2868
  * <p>The status of the pipeline execution.</p>
2586
2869
  * <ul>
2587
2870
  * <li>
@@ -2611,25 +2894,30 @@ export interface PipelineExecutionSummary {
2611
2894
  */
2612
2895
  status?: PipelineExecutionStatus | string;
2613
2896
  /**
2897
+ * @public
2614
2898
  * <p>The date and time when the pipeline execution began, in timestamp format.</p>
2615
2899
  */
2616
2900
  startTime?: Date;
2617
2901
  /**
2902
+ * @public
2618
2903
  * <p>The date and time of the last change to the pipeline execution, in timestamp
2619
2904
  * format.</p>
2620
2905
  */
2621
2906
  lastUpdateTime?: Date;
2622
2907
  /**
2908
+ * @public
2623
2909
  * <p>A list of the source artifact revisions that initiated a pipeline
2624
2910
  * execution.</p>
2625
2911
  */
2626
2912
  sourceRevisions?: SourceRevision[];
2627
2913
  /**
2914
+ * @public
2628
2915
  * <p>The interaction or event that started a pipeline execution, such as automated change
2629
2916
  * detection or a <code>StartPipelineExecution</code> API call.</p>
2630
2917
  */
2631
2918
  trigger?: ExecutionTrigger;
2632
2919
  /**
2920
+ * @public
2633
2921
  * <p>The interaction that stopped a pipeline execution.</p>
2634
2922
  */
2635
2923
  stopTrigger?: StopExecutionTrigger;
@@ -2640,10 +2928,12 @@ export interface PipelineExecutionSummary {
2640
2928
  */
2641
2929
  export interface ListPipelineExecutionsOutput {
2642
2930
  /**
2931
+ * @public
2643
2932
  * <p>A list of executions in the history of a pipeline.</p>
2644
2933
  */
2645
2934
  pipelineExecutionSummaries?: PipelineExecutionSummary[];
2646
2935
  /**
2936
+ * @public
2647
2937
  * <p>A token that can be used in the next <code>ListPipelineExecutions</code> call. To
2648
2938
  * view all items in the list, continue to call this operation with each subsequent token
2649
2939
  * until no more nextToken values are returned.</p>
@@ -2656,11 +2946,13 @@ export interface ListPipelineExecutionsOutput {
2656
2946
  */
2657
2947
  export interface ListPipelinesInput {
2658
2948
  /**
2949
+ * @public
2659
2950
  * <p>An identifier that was returned from the previous list pipelines call. It can be
2660
2951
  * used to return the next set of pipelines in the list.</p>
2661
2952
  */
2662
2953
  nextToken?: string;
2663
2954
  /**
2955
+ * @public
2664
2956
  * <p>The maximum number of pipelines to return in a single call. To retrieve the remaining
2665
2957
  * pipelines, make another call with the returned nextToken value. The minimum value you
2666
2958
  * can specify is 1. The maximum accepted value is 1000.</p>
@@ -2673,18 +2965,22 @@ export interface ListPipelinesInput {
2673
2965
  */
2674
2966
  export interface PipelineSummary {
2675
2967
  /**
2968
+ * @public
2676
2969
  * <p>The name of the pipeline.</p>
2677
2970
  */
2678
2971
  name?: string;
2679
2972
  /**
2973
+ * @public
2680
2974
  * <p>The version number of the pipeline.</p>
2681
2975
  */
2682
2976
  version?: number;
2683
2977
  /**
2978
+ * @public
2684
2979
  * <p>The date and time the pipeline was created, in timestamp format.</p>
2685
2980
  */
2686
2981
  created?: Date;
2687
2982
  /**
2983
+ * @public
2688
2984
  * <p>The date and time of the last update to the pipeline, in timestamp
2689
2985
  * format.</p>
2690
2986
  */
@@ -2696,10 +2992,12 @@ export interface PipelineSummary {
2696
2992
  */
2697
2993
  export interface ListPipelinesOutput {
2698
2994
  /**
2995
+ * @public
2699
2996
  * <p>The list of pipelines.</p>
2700
2997
  */
2701
2998
  pipelines?: PipelineSummary[];
2702
2999
  /**
3000
+ * @public
2703
3001
  * <p>If the amount of returned information is significantly large, an identifier is also
2704
3002
  * returned. It can be used in a subsequent list pipelines call to return the next set of
2705
3003
  * pipelines in the list.</p>
@@ -2723,16 +3021,19 @@ export declare class InvalidArnException extends __BaseException {
2723
3021
  */
2724
3022
  export interface ListTagsForResourceInput {
2725
3023
  /**
3024
+ * @public
2726
3025
  * <p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>
2727
3026
  */
2728
3027
  resourceArn: string | undefined;
2729
3028
  /**
3029
+ * @public
2730
3030
  * <p>The token that was returned from the previous API call, which would be used to return
2731
3031
  * the next page of the list. The ListTagsforResource call lists all available tags in one
2732
3032
  * call and does not use pagination.</p>
2733
3033
  */
2734
3034
  nextToken?: string;
2735
3035
  /**
3036
+ * @public
2736
3037
  * <p>The maximum number of results to return in a single call.</p>
2737
3038
  */
2738
3039
  maxResults?: number;
@@ -2742,10 +3043,12 @@ export interface ListTagsForResourceInput {
2742
3043
  */
2743
3044
  export interface ListTagsForResourceOutput {
2744
3045
  /**
3046
+ * @public
2745
3047
  * <p>The tags for the resource.</p>
2746
3048
  */
2747
3049
  tags?: Tag[];
2748
3050
  /**
3051
+ * @public
2749
3052
  * <p>If the amount of returned information is significantly large, an identifier is also
2750
3053
  * returned and can be used in a subsequent API call to return the next page of the list.
2751
3054
  * The ListTagsforResource call lists all available tags in one call and does not use
@@ -2770,11 +3073,13 @@ export declare class ResourceNotFoundException extends __BaseException {
2770
3073
  */
2771
3074
  export interface ListWebhooksInput {
2772
3075
  /**
3076
+ * @public
2773
3077
  * <p>The token that was returned from the previous ListWebhooks call, which can be used
2774
3078
  * to return the next set of webhooks in the list.</p>
2775
3079
  */
2776
3080
  NextToken?: string;
2777
3081
  /**
3082
+ * @public
2778
3083
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
2779
3084
  * results, make another call with the returned nextToken value.</p>
2780
3085
  */
@@ -2799,12 +3104,14 @@ export type WebhookAuthenticationType = (typeof WebhookAuthenticationType)[keyof
2799
3104
  */
2800
3105
  export interface WebhookAuthConfiguration {
2801
3106
  /**
3107
+ * @public
2802
3108
  * <p>The property used to configure acceptance of webhooks in an IP address range. For
2803
3109
  * IP, only the <code>AllowedIPRange</code> property must be set. This property must be set
2804
3110
  * to a valid CIDR range.</p>
2805
3111
  */
2806
3112
  AllowedIPRange?: string;
2807
3113
  /**
3114
+ * @public
2808
3115
  * <p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the
2809
3116
  * <code>SecretToken</code> property must be set.</p>
2810
3117
  */
@@ -2817,6 +3124,7 @@ export interface WebhookAuthConfiguration {
2817
3124
  */
2818
3125
  export interface WebhookFilterRule {
2819
3126
  /**
3127
+ * @public
2820
3128
  * <p>A JsonPath expression that is applied to the body/payload of the webhook. The value
2821
3129
  * selected by the JsonPath expression must match the value specified in the
2822
3130
  * <code>MatchEquals</code> field. Otherwise, the request is ignored. For more
@@ -2825,6 +3133,7 @@ export interface WebhookFilterRule {
2825
3133
  */
2826
3134
  jsonPath: string | undefined;
2827
3135
  /**
3136
+ * @public
2828
3137
  * <p>The value selected by the <code>JsonPath</code> expression must match what is
2829
3138
  * supplied in the <code>MatchEquals</code> field. Otherwise, the request is ignored.
2830
3139
  * Properties from the target action configuration can be included as placeholders in this
@@ -2842,25 +3151,30 @@ export interface WebhookFilterRule {
2842
3151
  */
2843
3152
  export interface WebhookDefinition {
2844
3153
  /**
3154
+ * @public
2845
3155
  * <p>The name of the webhook.</p>
2846
3156
  */
2847
3157
  name: string | undefined;
2848
3158
  /**
3159
+ * @public
2849
3160
  * <p>The name of the pipeline you want to connect to the webhook.</p>
2850
3161
  */
2851
3162
  targetPipeline: string | undefined;
2852
3163
  /**
3164
+ * @public
2853
3165
  * <p>The name of the action in a pipeline you want to connect to the webhook. The action
2854
3166
  * must be from the source (first) stage of the pipeline.</p>
2855
3167
  */
2856
3168
  targetAction: string | undefined;
2857
3169
  /**
3170
+ * @public
2858
3171
  * <p>A list of rules applied to the body/payload sent in the POST request to a webhook
2859
3172
  * URL. All defined rules must pass for the request to be accepted and the pipeline
2860
3173
  * started.</p>
2861
3174
  */
2862
3175
  filters: WebhookFilterRule[] | undefined;
2863
3176
  /**
3177
+ * @public
2864
3178
  * <p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p>
2865
3179
  * <ul>
2866
3180
  * <li>
@@ -2881,6 +3195,7 @@ export interface WebhookDefinition {
2881
3195
  */
2882
3196
  authentication: WebhookAuthenticationType | string | undefined;
2883
3197
  /**
3198
+ * @public
2884
3199
  * <p>Properties that configure the authentication applied to incoming webhook trigger
2885
3200
  * requests. The required properties depend on the authentication type. For GITHUB_HMAC,
2886
3201
  * only the <code>SecretToken </code>property must be set. For IP, only the
@@ -2896,11 +3211,13 @@ export interface WebhookDefinition {
2896
3211
  */
2897
3212
  export interface ListWebhookItem {
2898
3213
  /**
3214
+ * @public
2899
3215
  * <p>The detail returned for each webhook, such as the webhook authentication type and
2900
3216
  * filter rules.</p>
2901
3217
  */
2902
3218
  definition: WebhookDefinition | undefined;
2903
3219
  /**
3220
+ * @public
2904
3221
  * <p>A unique URL generated by CodePipeline. When a POST request is made to this
2905
3222
  * URL, the defined pipeline is started as long as the body of the post request satisfies
2906
3223
  * the defined authentication and filtering conditions. Deleting and re-creating a webhook
@@ -2908,23 +3225,28 @@ export interface ListWebhookItem {
2908
3225
  */
2909
3226
  url: string | undefined;
2910
3227
  /**
3228
+ * @public
2911
3229
  * <p>The text of the error message about the webhook.</p>
2912
3230
  */
2913
3231
  errorMessage?: string;
2914
3232
  /**
3233
+ * @public
2915
3234
  * <p>The number code of the error.</p>
2916
3235
  */
2917
3236
  errorCode?: string;
2918
3237
  /**
3238
+ * @public
2919
3239
  * <p>The date and time a webhook was last successfully triggered, in timestamp
2920
3240
  * format.</p>
2921
3241
  */
2922
3242
  lastTriggered?: Date;
2923
3243
  /**
3244
+ * @public
2924
3245
  * <p>The Amazon Resource Name (ARN) of the webhook.</p>
2925
3246
  */
2926
3247
  arn?: string;
2927
3248
  /**
3249
+ * @public
2928
3250
  * <p>Specifies the tags applied to the webhook.</p>
2929
3251
  */
2930
3252
  tags?: Tag[];
@@ -2934,11 +3256,13 @@ export interface ListWebhookItem {
2934
3256
  */
2935
3257
  export interface ListWebhooksOutput {
2936
3258
  /**
3259
+ * @public
2937
3260
  * <p>The JSON detail returned for each webhook in the list output for the ListWebhooks
2938
3261
  * call.</p>
2939
3262
  */
2940
3263
  webhooks?: ListWebhookItem[];
2941
3264
  /**
3265
+ * @public
2942
3266
  * <p>If the amount of returned information is significantly large, an identifier is also
2943
3267
  * returned and can be used in a subsequent ListWebhooks call to return the next set of
2944
3268
  * webhooks in the list. </p>
@@ -2951,14 +3275,17 @@ export interface ListWebhooksOutput {
2951
3275
  */
2952
3276
  export interface PollForJobsInput {
2953
3277
  /**
3278
+ * @public
2954
3279
  * <p>Represents information about an action type.</p>
2955
3280
  */
2956
3281
  actionTypeId: ActionTypeId | undefined;
2957
3282
  /**
3283
+ * @public
2958
3284
  * <p>The maximum number of jobs to return in a poll for jobs call.</p>
2959
3285
  */
2960
3286
  maxBatchSize?: number;
2961
3287
  /**
3288
+ * @public
2962
3289
  * <p>A map of property names and values. For an action type with no queryable
2963
3290
  * properties, this value must be null or an empty map. For an action type with a queryable
2964
3291
  * property, you must supply that property as a key in the map. Only jobs whose action
@@ -2972,19 +3299,23 @@ export interface PollForJobsInput {
2972
3299
  */
2973
3300
  export interface Job {
2974
3301
  /**
3302
+ * @public
2975
3303
  * <p>The unique system-generated ID of the job.</p>
2976
3304
  */
2977
3305
  id?: string;
2978
3306
  /**
3307
+ * @public
2979
3308
  * <p>Other data about a job.</p>
2980
3309
  */
2981
3310
  data?: JobData;
2982
3311
  /**
3312
+ * @public
2983
3313
  * <p>A system-generated random number that CodePipeline uses to ensure that the
2984
3314
  * job is being worked on by only one job worker. Use this number in an <a>AcknowledgeJob</a> request.</p>
2985
3315
  */
2986
3316
  nonce?: string;
2987
3317
  /**
3318
+ * @public
2988
3319
  * <p>The ID of the Amazon Web Services account to use when performing the job.</p>
2989
3320
  */
2990
3321
  accountId?: string;
@@ -2995,6 +3326,7 @@ export interface Job {
2995
3326
  */
2996
3327
  export interface PollForJobsOutput {
2997
3328
  /**
3329
+ * @public
2998
3330
  * <p>Information about the jobs to take action on.</p>
2999
3331
  */
3000
3332
  jobs?: Job[];
@@ -3005,10 +3337,12 @@ export interface PollForJobsOutput {
3005
3337
  */
3006
3338
  export interface PollForThirdPartyJobsInput {
3007
3339
  /**
3340
+ * @public
3008
3341
  * <p>Represents information about an action type.</p>
3009
3342
  */
3010
3343
  actionTypeId: ActionTypeId | undefined;
3011
3344
  /**
3345
+ * @public
3012
3346
  * <p>The maximum number of jobs to return in a poll for jobs call.</p>
3013
3347
  */
3014
3348
  maxBatchSize?: number;
@@ -3019,12 +3353,14 @@ export interface PollForThirdPartyJobsInput {
3019
3353
  */
3020
3354
  export interface ThirdPartyJob {
3021
3355
  /**
3356
+ * @public
3022
3357
  * <p>The <code>clientToken</code> portion of the <code>clientId</code> and
3023
3358
  * <code>clientToken</code> pair used to verify that the calling entity is allowed
3024
3359
  * access to the job and its details.</p>
3025
3360
  */
3026
3361
  clientId?: string;
3027
3362
  /**
3363
+ * @public
3028
3364
  * <p>The identifier used to identify the job in CodePipeline.</p>
3029
3365
  */
3030
3366
  jobId?: string;
@@ -3035,6 +3371,7 @@ export interface ThirdPartyJob {
3035
3371
  */
3036
3372
  export interface PollForThirdPartyJobsOutput {
3037
3373
  /**
3374
+ * @public
3038
3375
  * <p>Information about the jobs to take action on.</p>
3039
3376
  */
3040
3377
  jobs?: ThirdPartyJob[];
@@ -3045,19 +3382,23 @@ export interface PollForThirdPartyJobsOutput {
3045
3382
  */
3046
3383
  export interface PutActionRevisionInput {
3047
3384
  /**
3385
+ * @public
3048
3386
  * <p>The name of the pipeline that starts processing the revision to the
3049
3387
  * source.</p>
3050
3388
  */
3051
3389
  pipelineName: string | undefined;
3052
3390
  /**
3391
+ * @public
3053
3392
  * <p>The name of the stage that contains the action that acts on the revision.</p>
3054
3393
  */
3055
3394
  stageName: string | undefined;
3056
3395
  /**
3396
+ * @public
3057
3397
  * <p>The name of the action that processes the revision.</p>
3058
3398
  */
3059
3399
  actionName: string | undefined;
3060
3400
  /**
3401
+ * @public
3061
3402
  * <p>Represents information about the version (or revision) of an action.</p>
3062
3403
  */
3063
3404
  actionRevision: ActionRevision | undefined;
@@ -3068,11 +3409,13 @@ export interface PutActionRevisionInput {
3068
3409
  */
3069
3410
  export interface PutActionRevisionOutput {
3070
3411
  /**
3412
+ * @public
3071
3413
  * <p>Indicates whether the artifact revision was previously used in an execution of the
3072
3414
  * specified pipeline.</p>
3073
3415
  */
3074
3416
  newRevision?: boolean;
3075
3417
  /**
3418
+ * @public
3076
3419
  * <p>The ID of the current workflow state of the pipeline.</p>
3077
3420
  */
3078
3421
  pipelineExecutionId?: string;
@@ -3095,22 +3438,27 @@ export declare class InvalidApprovalTokenException extends __BaseException {
3095
3438
  */
3096
3439
  export interface PutApprovalResultInput {
3097
3440
  /**
3441
+ * @public
3098
3442
  * <p>The name of the pipeline that contains the action. </p>
3099
3443
  */
3100
3444
  pipelineName: string | undefined;
3101
3445
  /**
3446
+ * @public
3102
3447
  * <p>The name of the stage that contains the action.</p>
3103
3448
  */
3104
3449
  stageName: string | undefined;
3105
3450
  /**
3451
+ * @public
3106
3452
  * <p>The name of the action for which approval is requested.</p>
3107
3453
  */
3108
3454
  actionName: string | undefined;
3109
3455
  /**
3456
+ * @public
3110
3457
  * <p>Represents information about the result of the approval request.</p>
3111
3458
  */
3112
3459
  result: ApprovalResult | undefined;
3113
3460
  /**
3461
+ * @public
3114
3462
  * <p>The system-generated token used to identify a unique approval request. The token
3115
3463
  * for each open approval request can be obtained using the <a>GetPipelineState</a> action. It is used to validate that the approval
3116
3464
  * request corresponding to this token is still valid.</p>
@@ -3123,6 +3471,7 @@ export interface PutApprovalResultInput {
3123
3471
  */
3124
3472
  export interface PutApprovalResultOutput {
3125
3473
  /**
3474
+ * @public
3126
3475
  * <p>The timestamp showing when the approval or rejection was submitted.</p>
3127
3476
  */
3128
3477
  approvedAt?: Date;
@@ -3161,14 +3510,17 @@ export type FailureType = (typeof FailureType)[keyof typeof FailureType];
3161
3510
  */
3162
3511
  export interface FailureDetails {
3163
3512
  /**
3513
+ * @public
3164
3514
  * <p>The type of the failure.</p>
3165
3515
  */
3166
3516
  type: FailureType | string | undefined;
3167
3517
  /**
3518
+ * @public
3168
3519
  * <p>The message about the failure.</p>
3169
3520
  */
3170
3521
  message: string | undefined;
3171
3522
  /**
3523
+ * @public
3172
3524
  * <p>The external ID of the run of the action that failed.</p>
3173
3525
  */
3174
3526
  externalExecutionId?: string;
@@ -3179,11 +3531,13 @@ export interface FailureDetails {
3179
3531
  */
3180
3532
  export interface PutJobFailureResultInput {
3181
3533
  /**
3534
+ * @public
3182
3535
  * <p>The unique system-generated ID of the job that failed. This is the same ID returned
3183
3536
  * from <code>PollForJobs</code>.</p>
3184
3537
  */
3185
3538
  jobId: string | undefined;
3186
3539
  /**
3540
+ * @public
3187
3541
  * <p>The details about the failure of a job.</p>
3188
3542
  */
3189
3543
  failureDetails: FailureDetails | undefined;
@@ -3206,19 +3560,23 @@ export declare class OutputVariablesSizeExceededException extends __BaseExceptio
3206
3560
  */
3207
3561
  export interface CurrentRevision {
3208
3562
  /**
3563
+ * @public
3209
3564
  * <p>The revision ID of the current version of an artifact.</p>
3210
3565
  */
3211
3566
  revision: string | undefined;
3212
3567
  /**
3568
+ * @public
3213
3569
  * <p>The change identifier for the current revision.</p>
3214
3570
  */
3215
3571
  changeIdentifier: string | undefined;
3216
3572
  /**
3573
+ * @public
3217
3574
  * <p>The date and time when the most recent revision of the artifact was created, in
3218
3575
  * timestamp format.</p>
3219
3576
  */
3220
3577
  created?: Date;
3221
3578
  /**
3579
+ * @public
3222
3580
  * <p>The summary of the most recent revision of the artifact.</p>
3223
3581
  */
3224
3582
  revisionSummary?: string;
@@ -3230,15 +3588,18 @@ export interface CurrentRevision {
3230
3588
  */
3231
3589
  export interface ExecutionDetails {
3232
3590
  /**
3591
+ * @public
3233
3592
  * <p>The summary of the current status of the actions.</p>
3234
3593
  */
3235
3594
  summary?: string;
3236
3595
  /**
3596
+ * @public
3237
3597
  * <p>The system-generated unique ID of this action used to identify this job worker in
3238
3598
  * any external systems, such as CodeDeploy.</p>
3239
3599
  */
3240
3600
  externalExecutionId?: string;
3241
3601
  /**
3602
+ * @public
3242
3603
  * <p>The percentage of work completed on the action, represented on a scale of 0 to 100
3243
3604
  * percent.</p>
3244
3605
  */
@@ -3250,16 +3611,19 @@ export interface ExecutionDetails {
3250
3611
  */
3251
3612
  export interface PutJobSuccessResultInput {
3252
3613
  /**
3614
+ * @public
3253
3615
  * <p>The unique system-generated ID of the job that succeeded. This is the same ID
3254
3616
  * returned from <code>PollForJobs</code>.</p>
3255
3617
  */
3256
3618
  jobId: string | undefined;
3257
3619
  /**
3620
+ * @public
3258
3621
  * <p>The ID of the current revision of the artifact successfully worked on by the
3259
3622
  * job.</p>
3260
3623
  */
3261
3624
  currentRevision?: CurrentRevision;
3262
3625
  /**
3626
+ * @public
3263
3627
  * <p>A token generated by a job worker, such as a CodeDeploy deployment ID, that a
3264
3628
  * successful job provides to identify a custom action in progress. Future jobs use this
3265
3629
  * token to identify the running instance of the action. It can be reused to return more
@@ -3268,11 +3632,13 @@ export interface PutJobSuccessResultInput {
3268
3632
  */
3269
3633
  continuationToken?: string;
3270
3634
  /**
3635
+ * @public
3271
3636
  * <p>The execution details of the successful job, such as the actions taken by the job
3272
3637
  * worker.</p>
3273
3638
  */
3274
3639
  executionDetails?: ExecutionDetails;
3275
3640
  /**
3641
+ * @public
3276
3642
  * <p>Key-value pairs produced as output by a job worker that can be made available to a
3277
3643
  * downstream action configuration. <code>outputVariables</code> can be included only when
3278
3644
  * there is no continuation token on the request.</p>
@@ -3286,16 +3652,19 @@ export interface PutJobSuccessResultInput {
3286
3652
  */
3287
3653
  export interface PutThirdPartyJobFailureResultInput {
3288
3654
  /**
3655
+ * @public
3289
3656
  * <p>The ID of the job that failed. This is the same ID returned from
3290
3657
  * <code>PollForThirdPartyJobs</code>.</p>
3291
3658
  */
3292
3659
  jobId: string | undefined;
3293
3660
  /**
3661
+ * @public
3294
3662
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
3295
3663
  * the calling entity is allowed access to the job and its details.</p>
3296
3664
  */
3297
3665
  clientToken: string | undefined;
3298
3666
  /**
3667
+ * @public
3299
3668
  * <p>Represents information about failure details.</p>
3300
3669
  */
3301
3670
  failureDetails: FailureDetails | undefined;
@@ -3307,20 +3676,24 @@ export interface PutThirdPartyJobFailureResultInput {
3307
3676
  */
3308
3677
  export interface PutThirdPartyJobSuccessResultInput {
3309
3678
  /**
3679
+ * @public
3310
3680
  * <p>The ID of the job that successfully completed. This is the same ID returned from
3311
3681
  * <code>PollForThirdPartyJobs</code>.</p>
3312
3682
  */
3313
3683
  jobId: string | undefined;
3314
3684
  /**
3685
+ * @public
3315
3686
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
3316
3687
  * the calling entity is allowed access to the job and its details.</p>
3317
3688
  */
3318
3689
  clientToken: string | undefined;
3319
3690
  /**
3691
+ * @public
3320
3692
  * <p>Represents information about a current revision.</p>
3321
3693
  */
3322
3694
  currentRevision?: CurrentRevision;
3323
3695
  /**
3696
+ * @public
3324
3697
  * <p>A token generated by a job worker, such as a CodeDeploy deployment ID, that a
3325
3698
  * successful job provides to identify a partner action in progress. Future jobs use this
3326
3699
  * token to identify the running instance of the action. It can be reused to return more
@@ -3329,6 +3702,7 @@ export interface PutThirdPartyJobSuccessResultInput {
3329
3702
  */
3330
3703
  continuationToken?: string;
3331
3704
  /**
3705
+ * @public
3332
3706
  * <p>The details of the actions taken and results produced on an artifact as it passes
3333
3707
  * through stages in the pipeline. </p>
3334
3708
  */
@@ -3363,6 +3737,7 @@ export declare class InvalidWebhookFilterPatternException extends __BaseExceptio
3363
3737
  */
3364
3738
  export interface PutWebhookInput {
3365
3739
  /**
3740
+ * @public
3366
3741
  * <p>The detail provided in an input file to create the webhook, such as the webhook
3367
3742
  * name, the pipeline name, and the action name. Give the webhook a unique name that helps
3368
3743
  * you identify it. You might name the webhook after the pipeline and action it targets so
@@ -3370,6 +3745,7 @@ export interface PutWebhookInput {
3370
3745
  */
3371
3746
  webhook: WebhookDefinition | undefined;
3372
3747
  /**
3748
+ * @public
3373
3749
  * <p>The tags for the webhook.</p>
3374
3750
  */
3375
3751
  tags?: Tag[];
@@ -3379,6 +3755,7 @@ export interface PutWebhookInput {
3379
3755
  */
3380
3756
  export interface PutWebhookOutput {
3381
3757
  /**
3758
+ * @public
3382
3759
  * <p>The detail returned from creating the webhook, such as the webhook name, webhook
3383
3760
  * URL, and webhook ARN.</p>
3384
3761
  */
@@ -3389,6 +3766,7 @@ export interface PutWebhookOutput {
3389
3766
  */
3390
3767
  export interface RegisterWebhookWithThirdPartyInput {
3391
3768
  /**
3769
+ * @public
3392
3770
  * <p>The name of an existing webhook created with PutWebhook to register with a
3393
3771
  * supported third party. </p>
3394
3772
  */
@@ -3443,19 +3821,23 @@ export type StageRetryMode = (typeof StageRetryMode)[keyof typeof StageRetryMode
3443
3821
  */
3444
3822
  export interface RetryStageExecutionInput {
3445
3823
  /**
3824
+ * @public
3446
3825
  * <p>The name of the pipeline that contains the failed stage.</p>
3447
3826
  */
3448
3827
  pipelineName: string | undefined;
3449
3828
  /**
3829
+ * @public
3450
3830
  * <p>The name of the failed stage to be retried.</p>
3451
3831
  */
3452
3832
  stageName: string | undefined;
3453
3833
  /**
3834
+ * @public
3454
3835
  * <p>The ID of the pipeline execution in the failed stage to be retried. Use the <a>GetPipelineState</a> action to retrieve the current pipelineExecutionId of
3455
3836
  * the failed stage</p>
3456
3837
  */
3457
3838
  pipelineExecutionId: string | undefined;
3458
3839
  /**
3840
+ * @public
3459
3841
  * <p>The scope of the retry attempt. Currently, the only supported value is
3460
3842
  * FAILED_ACTIONS.</p>
3461
3843
  */
@@ -3467,6 +3849,7 @@ export interface RetryStageExecutionInput {
3467
3849
  */
3468
3850
  export interface RetryStageExecutionOutput {
3469
3851
  /**
3852
+ * @public
3470
3853
  * <p>The ID of the current workflow execution in the failed stage.</p>
3471
3854
  */
3472
3855
  pipelineExecutionId?: string;
@@ -3491,10 +3874,12 @@ export declare class StageNotRetryableException extends __BaseException {
3491
3874
  */
3492
3875
  export interface StartPipelineExecutionInput {
3493
3876
  /**
3877
+ * @public
3494
3878
  * <p>The name of the pipeline to start.</p>
3495
3879
  */
3496
3880
  name: string | undefined;
3497
3881
  /**
3882
+ * @public
3498
3883
  * <p>The system-generated unique ID used to identify a unique execution
3499
3884
  * request.</p>
3500
3885
  */
@@ -3506,6 +3891,7 @@ export interface StartPipelineExecutionInput {
3506
3891
  */
3507
3892
  export interface StartPipelineExecutionOutput {
3508
3893
  /**
3894
+ * @public
3509
3895
  * <p>The unique system-generated ID of the pipeline execution that was
3510
3896
  * started.</p>
3511
3897
  */
@@ -3545,16 +3931,19 @@ export declare class PipelineExecutionNotStoppableException extends __BaseExcept
3545
3931
  */
3546
3932
  export interface StopPipelineExecutionInput {
3547
3933
  /**
3934
+ * @public
3548
3935
  * <p>The name of the pipeline to stop.</p>
3549
3936
  */
3550
3937
  pipelineName: string | undefined;
3551
3938
  /**
3939
+ * @public
3552
3940
  * <p>The ID of the pipeline execution to be stopped in the current stage. Use the
3553
3941
  * <code>GetPipelineState</code> action to retrieve the current
3554
3942
  * pipelineExecutionId.</p>
3555
3943
  */
3556
3944
  pipelineExecutionId: string | undefined;
3557
3945
  /**
3946
+ * @public
3558
3947
  * <p>Use this option to stop the pipeline execution by abandoning, rather than finishing,
3559
3948
  * in-progress actions.</p>
3560
3949
  * <note>
@@ -3563,6 +3952,7 @@ export interface StopPipelineExecutionInput {
3563
3952
  */
3564
3953
  abandon?: boolean;
3565
3954
  /**
3955
+ * @public
3566
3956
  * <p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>
3567
3957
  */
3568
3958
  reason?: string;
@@ -3572,6 +3962,7 @@ export interface StopPipelineExecutionInput {
3572
3962
  */
3573
3963
  export interface StopPipelineExecutionOutput {
3574
3964
  /**
3965
+ * @public
3575
3966
  * <p>The unique system-generated ID of the pipeline execution that was stopped.</p>
3576
3967
  */
3577
3968
  pipelineExecutionId?: string;
@@ -3581,10 +3972,12 @@ export interface StopPipelineExecutionOutput {
3581
3972
  */
3582
3973
  export interface TagResourceInput {
3583
3974
  /**
3975
+ * @public
3584
3976
  * <p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>
3585
3977
  */
3586
3978
  resourceArn: string | undefined;
3587
3979
  /**
3980
+ * @public
3588
3981
  * <p>The tags you want to modify or add to the resource.</p>
3589
3982
  */
3590
3983
  tags: Tag[] | undefined;
@@ -3599,10 +3992,12 @@ export interface TagResourceOutput {
3599
3992
  */
3600
3993
  export interface UntagResourceInput {
3601
3994
  /**
3995
+ * @public
3602
3996
  * <p> The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
3603
3997
  */
3604
3998
  resourceArn: string | undefined;
3605
3999
  /**
4000
+ * @public
3606
4001
  * <p>The list of keys for the tags to be removed from the resource.</p>
3607
4002
  */
3608
4003
  tagKeys: string[] | undefined;
@@ -3629,6 +4024,7 @@ export declare class RequestFailedException extends __BaseException {
3629
4024
  */
3630
4025
  export interface UpdateActionTypeInput {
3631
4026
  /**
4027
+ * @public
3632
4028
  * <p>The action type definition for the action type to be updated.</p>
3633
4029
  */
3634
4030
  actionType: ActionTypeDeclaration | undefined;
@@ -3639,6 +4035,7 @@ export interface UpdateActionTypeInput {
3639
4035
  */
3640
4036
  export interface UpdatePipelineInput {
3641
4037
  /**
4038
+ * @public
3642
4039
  * <p>The name of the pipeline to be updated.</p>
3643
4040
  */
3644
4041
  pipeline: PipelineDeclaration | undefined;
@@ -3649,6 +4046,7 @@ export interface UpdatePipelineInput {
3649
4046
  */
3650
4047
  export interface UpdatePipelineOutput {
3651
4048
  /**
4049
+ * @public
3652
4050
  * <p>The structure of the updated pipeline.</p>
3653
4051
  */
3654
4052
  pipeline?: PipelineDeclaration;