@aws-sdk/client-codepipeline 3.533.0 → 3.540.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.
Files changed (89) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/CodePipeline.d.ts +6 -1
  6. package/dist-types/CodePipelineClient.d.ts +1 -1
  7. package/dist-types/commands/AcknowledgeJobCommand.d.ts +2 -1
  8. package/dist-types/commands/AcknowledgeThirdPartyJobCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateCustomActionTypeCommand.d.ts +2 -1
  10. package/dist-types/commands/CreatePipelineCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteCustomActionTypeCommand.d.ts +2 -1
  12. package/dist-types/commands/DeletePipelineCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteWebhookCommand.d.ts +2 -1
  14. package/dist-types/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +2 -1
  15. package/dist-types/commands/DisableStageTransitionCommand.d.ts +2 -1
  16. package/dist-types/commands/EnableStageTransitionCommand.d.ts +2 -1
  17. package/dist-types/commands/GetActionTypeCommand.d.ts +2 -1
  18. package/dist-types/commands/GetJobDetailsCommand.d.ts +2 -1
  19. package/dist-types/commands/GetPipelineCommand.d.ts +2 -1
  20. package/dist-types/commands/GetPipelineExecutionCommand.d.ts +2 -1
  21. package/dist-types/commands/GetPipelineStateCommand.d.ts +2 -1
  22. package/dist-types/commands/GetThirdPartyJobDetailsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListActionExecutionsCommand.d.ts +2 -1
  24. package/dist-types/commands/ListActionTypesCommand.d.ts +2 -1
  25. package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +2 -1
  26. package/dist-types/commands/ListPipelinesCommand.d.ts +2 -1
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  28. package/dist-types/commands/ListWebhooksCommand.d.ts +2 -1
  29. package/dist-types/commands/PollForJobsCommand.d.ts +2 -1
  30. package/dist-types/commands/PollForThirdPartyJobsCommand.d.ts +2 -1
  31. package/dist-types/commands/PutActionRevisionCommand.d.ts +2 -1
  32. package/dist-types/commands/PutApprovalResultCommand.d.ts +2 -1
  33. package/dist-types/commands/PutJobFailureResultCommand.d.ts +2 -1
  34. package/dist-types/commands/PutJobSuccessResultCommand.d.ts +2 -1
  35. package/dist-types/commands/PutThirdPartyJobFailureResultCommand.d.ts +2 -1
  36. package/dist-types/commands/PutThirdPartyJobSuccessResultCommand.d.ts +2 -1
  37. package/dist-types/commands/PutWebhookCommand.d.ts +2 -1
  38. package/dist-types/commands/RegisterWebhookWithThirdPartyCommand.d.ts +2 -1
  39. package/dist-types/commands/RetryStageExecutionCommand.d.ts +2 -1
  40. package/dist-types/commands/StartPipelineExecutionCommand.d.ts +2 -1
  41. package/dist-types/commands/StopPipelineExecutionCommand.d.ts +2 -1
  42. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  43. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  44. package/dist-types/commands/UpdateActionTypeCommand.d.ts +2 -1
  45. package/dist-types/commands/UpdatePipelineCommand.d.ts +2 -1
  46. package/dist-types/index.d.ts +0 -1
  47. package/dist-types/models/models_0.d.ts +607 -607
  48. package/dist-types/ts3.4/CodePipeline.d.ts +5 -0
  49. package/dist-types/ts3.4/commands/AcknowledgeJobCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/AcknowledgeThirdPartyJobCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/CreateCustomActionTypeCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/DeleteCustomActionTypeCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/DeleteWebhookCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/DisableStageTransitionCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/EnableStageTransitionCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/GetActionTypeCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/GetJobDetailsCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/GetPipelineCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/GetPipelineExecutionCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/GetPipelineStateCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/GetThirdPartyJobDetailsCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/ListActionExecutionsCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/ListActionTypesCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/ListPipelineExecutionsCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/ListWebhooksCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/PollForJobsCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/PollForThirdPartyJobsCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/PutActionRevisionCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/PutApprovalResultCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/PutJobFailureResultCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/PutJobSuccessResultCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/PutThirdPartyJobFailureResultCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/PutThirdPartyJobSuccessResultCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/PutWebhookCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/RegisterWebhookWithThirdPartyCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/RetryStageExecutionCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/StartPipelineExecutionCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/StopPipelineExecutionCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  85. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  86. package/dist-types/ts3.4/commands/UpdateActionTypeCommand.d.ts +9 -0
  87. package/dist-types/ts3.4/commands/UpdatePipelineCommand.d.ts +9 -0
  88. package/dist-types/ts3.4/index.d.ts +0 -1
  89. package/package.json +40 -40
@@ -1,21 +1,21 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { CodePipelineServiceException as __BaseException } from "./CodePipelineServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>Represents the input of an AcknowledgeJob action.</p>
5
+ * @public
6
6
  */
7
7
  export interface AcknowledgeJobInput {
8
8
  /**
9
- * @public
10
9
  * <p>The unique system-generated ID of the job for which you want to confirm
11
10
  * receipt.</p>
11
+ * @public
12
12
  */
13
13
  jobId: string | undefined;
14
14
  /**
15
- * @public
16
15
  * <p>A system-generated random number that CodePipeline uses to ensure that the
17
16
  * job is being worked on by only one job worker. Get this number from the response of the
18
17
  * <a>PollForJobs</a> request that returned this job.</p>
18
+ * @public
19
19
  */
20
20
  nonce: string | undefined;
21
21
  }
@@ -37,19 +37,19 @@ export declare const JobStatus: {
37
37
  */
38
38
  export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
39
39
  /**
40
- * @public
41
40
  * <p>Represents the output of an AcknowledgeJob action.</p>
41
+ * @public
42
42
  */
43
43
  export interface AcknowledgeJobOutput {
44
44
  /**
45
- * @public
46
45
  * <p>Whether the job worker has received the specified job.</p>
46
+ * @public
47
47
  */
48
48
  status?: JobStatus;
49
49
  }
50
50
  /**
51
- * @public
52
51
  * <p>The nonce was specified in an invalid format.</p>
52
+ * @public
53
53
  */
54
54
  export declare class InvalidNonceException extends __BaseException {
55
55
  readonly name: "InvalidNonceException";
@@ -60,8 +60,8 @@ export declare class InvalidNonceException extends __BaseException {
60
60
  constructor(opts: __ExceptionOptionType<InvalidNonceException, __BaseException>);
61
61
  }
62
62
  /**
63
- * @public
64
63
  * <p>The job was specified in an invalid format or cannot be found.</p>
64
+ * @public
65
65
  */
66
66
  export declare class JobNotFoundException extends __BaseException {
67
67
  readonly name: "JobNotFoundException";
@@ -72,8 +72,8 @@ export declare class JobNotFoundException extends __BaseException {
72
72
  constructor(opts: __ExceptionOptionType<JobNotFoundException, __BaseException>);
73
73
  }
74
74
  /**
75
- * @public
76
75
  * <p>The validation was specified in an invalid format.</p>
76
+ * @public
77
77
  */
78
78
  export declare class ValidationException extends __BaseException {
79
79
  readonly name: "ValidationException";
@@ -84,43 +84,43 @@ export declare class ValidationException extends __BaseException {
84
84
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
85
85
  }
86
86
  /**
87
- * @public
88
87
  * <p>Represents the input of an AcknowledgeThirdPartyJob action.</p>
88
+ * @public
89
89
  */
90
90
  export interface AcknowledgeThirdPartyJobInput {
91
91
  /**
92
- * @public
93
92
  * <p>The unique system-generated ID of the job.</p>
93
+ * @public
94
94
  */
95
95
  jobId: string | undefined;
96
96
  /**
97
- * @public
98
97
  * <p>A system-generated random number that CodePipeline uses to ensure that the
99
98
  * job is being worked on by only one job worker. Get this number from the response to a
100
99
  * <a>GetThirdPartyJobDetails</a> request.</p>
100
+ * @public
101
101
  */
102
102
  nonce: string | undefined;
103
103
  /**
104
- * @public
105
104
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
106
105
  * the calling entity is allowed access to the job and its details.</p>
106
+ * @public
107
107
  */
108
108
  clientToken: string | undefined;
109
109
  }
110
110
  /**
111
- * @public
112
111
  * <p>Represents the output of an AcknowledgeThirdPartyJob action.</p>
112
+ * @public
113
113
  */
114
114
  export interface AcknowledgeThirdPartyJobOutput {
115
115
  /**
116
- * @public
117
116
  * <p>The status information for the third party job, if any.</p>
117
+ * @public
118
118
  */
119
119
  status?: JobStatus;
120
120
  }
121
121
  /**
122
- * @public
123
122
  * <p>The client token was specified in an invalid format</p>
123
+ * @public
124
124
  */
125
125
  export declare class InvalidClientTokenException extends __BaseException {
126
126
  readonly name: "InvalidClientTokenException";
@@ -147,13 +147,13 @@ export declare const ActionCategory: {
147
147
  */
148
148
  export type ActionCategory = (typeof ActionCategory)[keyof typeof ActionCategory];
149
149
  /**
150
- * @public
151
150
  * <p>Represents information about an action configuration.</p>
151
+ * @public
152
152
  */
153
153
  export interface ActionConfiguration {
154
154
  /**
155
- * @public
156
155
  * <p>The configuration data for the action.</p>
156
+ * @public
157
157
  */
158
158
  configuration?: Record<string, string>;
159
159
  }
@@ -171,36 +171,35 @@ export declare const ActionConfigurationPropertyType: {
171
171
  */
172
172
  export type ActionConfigurationPropertyType = (typeof ActionConfigurationPropertyType)[keyof typeof ActionConfigurationPropertyType];
173
173
  /**
174
- * @public
175
174
  * <p>Represents information about an action configuration property.</p>
175
+ * @public
176
176
  */
177
177
  export interface ActionConfigurationProperty {
178
178
  /**
179
- * @public
180
179
  * <p>The name of the action configuration property.</p>
180
+ * @public
181
181
  */
182
182
  name: string | undefined;
183
183
  /**
184
- * @public
185
184
  * <p>Whether the configuration property is a required value.</p>
185
+ * @public
186
186
  */
187
187
  required: boolean | undefined;
188
188
  /**
189
- * @public
190
189
  * <p>Whether the configuration property is a key.</p>
190
+ * @public
191
191
  */
192
192
  key: boolean | undefined;
193
193
  /**
194
- * @public
195
194
  * <p>Whether the configuration property is secret. Secrets are hidden from all calls
196
195
  * except for <code>GetJobDetails</code>, <code>GetThirdPartyJobDetails</code>,
197
196
  * <code>PollForJobs</code>, and <code>PollForThirdPartyJobs</code>.</p>
198
197
  * <p>When updating a pipeline, passing * * * * * without changing any other values of
199
198
  * the action preserves the previous value of the secret.</p>
199
+ * @public
200
200
  */
201
201
  secret: boolean | undefined;
202
202
  /**
203
- * @public
204
203
  * <p>Indicates that the property is used with <code>PollForJobs</code>. When creating a
205
204
  * custom action, an action can have up to one queryable property. If it has one, that
206
205
  * property must be both required and not secret.</p>
@@ -208,34 +207,35 @@ export interface ActionConfigurationProperty {
208
207
  * a queryable property, the value for that configuration property is subject to other
209
208
  * restrictions. The value must be less than or equal to twenty (20) characters. The value
210
209
  * can contain only alphanumeric characters, underscores, and hyphens.</p>
210
+ * @public
211
211
  */
212
212
  queryable?: boolean;
213
213
  /**
214
- * @public
215
214
  * <p>The description of the action configuration property that is displayed to
216
215
  * users.</p>
216
+ * @public
217
217
  */
218
218
  description?: string;
219
219
  /**
220
- * @public
221
220
  * <p>The type of the configuration property.</p>
221
+ * @public
222
222
  */
223
223
  type?: ActionConfigurationPropertyType;
224
224
  }
225
225
  /**
226
- * @public
227
226
  * <p>Represents the context of an action in the stage of a pipeline to a job
228
227
  * worker.</p>
228
+ * @public
229
229
  */
230
230
  export interface ActionContext {
231
231
  /**
232
- * @public
233
232
  * <p>The name of the action in the context of a job.</p>
233
+ * @public
234
234
  */
235
235
  name?: string;
236
236
  /**
237
- * @public
238
237
  * <p>The system-generated unique ID that corresponds to an action's execution.</p>
238
+ * @public
239
239
  */
240
240
  actionExecutionId?: string;
241
241
  }
@@ -253,12 +253,11 @@ export declare const ActionOwner: {
253
253
  */
254
254
  export type ActionOwner = (typeof ActionOwner)[keyof typeof ActionOwner];
255
255
  /**
256
- * @public
257
256
  * <p>Represents information about an action type.</p>
257
+ * @public
258
258
  */
259
259
  export interface ActionTypeId {
260
260
  /**
261
- * @public
262
261
  * <p>A category defines what kind of action can be taken in the stage, and constrains
263
262
  * the provider type for the action. Valid categories are limited to one of the following
264
263
  * values. </p>
@@ -282,38 +281,38 @@ export interface ActionTypeId {
282
281
  * <p>Approval</p>
283
282
  * </li>
284
283
  * </ul>
284
+ * @public
285
285
  */
286
286
  category: ActionCategory | undefined;
287
287
  /**
288
- * @public
289
288
  * <p>The creator of the action being called. There are three valid values for the
290
289
  * <code>Owner</code> field in the action category section within your pipeline
291
290
  * structure: <code>AWS</code>, <code>ThirdParty</code>, and <code>Custom</code>. For more
292
291
  * information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.</p>
292
+ * @public
293
293
  */
294
294
  owner: ActionOwner | undefined;
295
295
  /**
296
- * @public
297
296
  * <p>The provider of the service being called by the action. Valid providers are
298
297
  * determined by the action category. For example, an action in the Deploy category type
299
298
  * might have a provider of CodeDeploy, which would be specified as
300
299
  * <code>CodeDeploy</code>. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.</p>
300
+ * @public
301
301
  */
302
302
  provider: string | undefined;
303
303
  /**
304
- * @public
305
304
  * <p>A string that describes the action version.</p>
305
+ * @public
306
306
  */
307
307
  version: string | undefined;
308
308
  }
309
309
  /**
310
- * @public
311
310
  * <p>Represents information about an artifact to be worked on, such as a test or build
312
311
  * artifact.</p>
312
+ * @public
313
313
  */
314
314
  export interface InputArtifact {
315
315
  /**
316
- * @public
317
316
  * <p>The name of the artifact to be worked on (for example, "My App").</p>
318
317
  * <p>Artifacts are the files that are worked on by actions in the pipeline. See the
319
318
  * action configuration for each action for details about artifact parameters. For example,
@@ -324,16 +323,16 @@ export interface InputArtifact {
324
323
  * sequence from the action that provided the output artifact. Actions in parallel can
325
324
  * declare different output artifacts, which are in turn consumed by different following
326
325
  * actions.</p>
326
+ * @public
327
327
  */
328
328
  name: string | undefined;
329
329
  }
330
330
  /**
331
- * @public
332
331
  * <p>Represents information about the output of an action.</p>
332
+ * @public
333
333
  */
334
334
  export interface OutputArtifact {
335
335
  /**
336
- * @public
337
336
  * <p>The name of the output of an artifact, such as "My App".</p>
338
337
  * <p>The input artifact of an action must exactly match the output artifact declared in
339
338
  * a preceding action, but the input artifact does not have to be the next action in strict
@@ -341,31 +340,31 @@ export interface OutputArtifact {
341
340
  * declare different output artifacts, which are in turn consumed by different following
342
341
  * actions.</p>
343
342
  * <p>Output artifact names must be unique within a pipeline.</p>
343
+ * @public
344
344
  */
345
345
  name: string | undefined;
346
346
  }
347
347
  /**
348
- * @public
349
348
  * <p>Represents information about an action declaration.</p>
349
+ * @public
350
350
  */
351
351
  export interface ActionDeclaration {
352
352
  /**
353
- * @public
354
353
  * <p>The action declaration's name.</p>
354
+ * @public
355
355
  */
356
356
  name: string | undefined;
357
357
  /**
358
- * @public
359
358
  * <p>Specifies the action type and the provider of the action.</p>
359
+ * @public
360
360
  */
361
361
  actionTypeId: ActionTypeId | undefined;
362
362
  /**
363
- * @public
364
363
  * <p>The order in which actions are run.</p>
364
+ * @public
365
365
  */
366
366
  runOrder?: number;
367
367
  /**
368
- * @public
369
368
  * <p>The action's configuration. These are key-value pairs that specify input values for
370
369
  * 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
371
370
  * 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
@@ -379,58 +378,59 @@ export interface ActionDeclaration {
379
378
  * <p>
380
379
  * <code>"Configuration" : \{ Key : Value \},</code>
381
380
  * </p>
381
+ * @public
382
382
  */
383
383
  configuration?: Record<string, string>;
384
384
  /**
385
- * @public
386
385
  * <p>The name or ID of the result of the action declaration, such as a test or build
387
386
  * artifact.</p>
387
+ * @public
388
388
  */
389
389
  outputArtifacts?: OutputArtifact[];
390
390
  /**
391
- * @public
392
391
  * <p>The name or ID of the artifact consumed by the action, such as a test or build
393
392
  * artifact.</p>
393
+ * @public
394
394
  */
395
395
  inputArtifacts?: InputArtifact[];
396
396
  /**
397
- * @public
398
397
  * <p>The ARN of the IAM service role that performs the declared action. This is assumed
399
398
  * through the roleArn for the pipeline.</p>
399
+ * @public
400
400
  */
401
401
  roleArn?: string;
402
402
  /**
403
- * @public
404
403
  * <p>The action declaration's Amazon Web Services Region, such as us-east-1.</p>
404
+ * @public
405
405
  */
406
406
  region?: string;
407
407
  /**
408
- * @public
409
408
  * <p>The variable namespace associated with the action. All variables produced as output by
410
409
  * this action fall under this namespace.</p>
410
+ * @public
411
411
  */
412
412
  namespace?: string;
413
413
  /**
414
- * @public
415
414
  * <p>A timeout duration in minutes that can be applied against the ActionType’s default
416
415
  * timeout value specified in <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html">Quotas for CodePipeline
417
416
  * </a>. This attribute is available only to the manual approval ActionType.</p>
417
+ * @public
418
418
  */
419
419
  timeoutInMinutes?: number;
420
420
  }
421
421
  /**
422
- * @public
423
422
  * <p>Represents information about an error in CodePipeline.</p>
423
+ * @public
424
424
  */
425
425
  export interface ErrorDetails {
426
426
  /**
427
- * @public
428
427
  * <p>The system ID or number code of the error.</p>
428
+ * @public
429
429
  */
430
430
  code?: string;
431
431
  /**
432
- * @public
433
432
  * <p>The text of the error message.</p>
433
+ * @public
434
434
  */
435
435
  message?: string;
436
436
  }
@@ -449,261 +449,261 @@ export declare const ActionExecutionStatus: {
449
449
  */
450
450
  export type ActionExecutionStatus = (typeof ActionExecutionStatus)[keyof typeof ActionExecutionStatus];
451
451
  /**
452
- * @public
453
452
  * <p>Represents information about the run of an action.</p>
453
+ * @public
454
454
  */
455
455
  export interface ActionExecution {
456
456
  /**
457
- * @public
458
457
  * <p>ID of the workflow action execution in the current stage. Use the <a>GetPipelineState</a> action to retrieve the current action execution details
459
458
  * of the current stage.</p>
460
459
  * <note>
461
460
  * <p>For older executions, this field might be empty. The action execution ID is
462
461
  * available for executions run on or after March 2020.</p>
463
462
  * </note>
463
+ * @public
464
464
  */
465
465
  actionExecutionId?: string;
466
466
  /**
467
- * @public
468
467
  * <p>The status of the action, or for a completed action, the last status of the
469
468
  * action.</p>
469
+ * @public
470
470
  */
471
471
  status?: ActionExecutionStatus;
472
472
  /**
473
- * @public
474
473
  * <p>A summary of the run of the action.</p>
474
+ * @public
475
475
  */
476
476
  summary?: string;
477
477
  /**
478
- * @public
479
478
  * <p>The last status change of the action.</p>
479
+ * @public
480
480
  */
481
481
  lastStatusChange?: Date;
482
482
  /**
483
- * @public
484
483
  * <p>The system-generated token used to identify a unique approval request. The token
485
484
  * for each open approval request can be obtained using the <code>GetPipelineState</code>
486
485
  * command. It is used to validate that the approval request corresponding to this token is
487
486
  * still valid.</p>
487
+ * @public
488
488
  */
489
489
  token?: string;
490
490
  /**
491
- * @public
492
491
  * <p>The ARN of the user who last changed the pipeline.</p>
492
+ * @public
493
493
  */
494
494
  lastUpdatedBy?: string;
495
495
  /**
496
- * @public
497
496
  * <p>The external ID of the run of the action.</p>
497
+ * @public
498
498
  */
499
499
  externalExecutionId?: string;
500
500
  /**
501
- * @public
502
501
  * <p>The URL of a resource external to Amazon Web Services that is used when running the
503
502
  * action (for example, an external repository URL).</p>
503
+ * @public
504
504
  */
505
505
  externalExecutionUrl?: string;
506
506
  /**
507
- * @public
508
507
  * <p>A percentage of completeness of the action as it runs.</p>
508
+ * @public
509
509
  */
510
510
  percentComplete?: number;
511
511
  /**
512
- * @public
513
512
  * <p>The details of an error returned by a URL external to Amazon Web Services.</p>
513
+ * @public
514
514
  */
515
515
  errorDetails?: ErrorDetails;
516
516
  }
517
517
  /**
518
- * @public
519
518
  * <p>The Amazon S3 artifact location for an action's artifacts.</p>
519
+ * @public
520
520
  */
521
521
  export interface S3Location {
522
522
  /**
523
- * @public
524
523
  * <p>The Amazon S3 artifact bucket for an action's artifacts.</p>
524
+ * @public
525
525
  */
526
526
  bucket?: string;
527
527
  /**
528
- * @public
529
528
  * <p>The artifact name.</p>
529
+ * @public
530
530
  */
531
531
  key?: string;
532
532
  }
533
533
  /**
534
- * @public
535
534
  * <p>Artifact details for the action execution, such as the artifact location.</p>
535
+ * @public
536
536
  */
537
537
  export interface ArtifactDetail {
538
538
  /**
539
- * @public
540
539
  * <p>The artifact object name for the action execution.</p>
540
+ * @public
541
541
  */
542
542
  name?: string;
543
543
  /**
544
- * @public
545
544
  * <p>The Amazon S3 artifact location for the action execution.</p>
545
+ * @public
546
546
  */
547
547
  s3location?: S3Location;
548
548
  }
549
549
  /**
550
- * @public
551
550
  * <p>Input information used for an action execution.</p>
551
+ * @public
552
552
  */
553
553
  export interface ActionExecutionInput {
554
554
  /**
555
- * @public
556
555
  * <p>Represents information about an action type.</p>
556
+ * @public
557
557
  */
558
558
  actionTypeId?: ActionTypeId;
559
559
  /**
560
- * @public
561
560
  * <p>Configuration data for an action execution.</p>
561
+ * @public
562
562
  */
563
563
  configuration?: Record<string, string>;
564
564
  /**
565
- * @public
566
565
  * <p>Configuration data for an action execution with all variable references replaced with
567
566
  * their real values for the execution.</p>
567
+ * @public
568
568
  */
569
569
  resolvedConfiguration?: Record<string, string>;
570
570
  /**
571
- * @public
572
571
  * <p>The ARN of the IAM service role that performs the declared action. This is assumed
573
572
  * through the roleArn for the pipeline. </p>
573
+ * @public
574
574
  */
575
575
  roleArn?: string;
576
576
  /**
577
- * @public
578
577
  * <p>The Amazon Web Services Region for the action, such as us-east-1.</p>
578
+ * @public
579
579
  */
580
580
  region?: string;
581
581
  /**
582
- * @public
583
582
  * <p>Details of input artifacts of the action that correspond to the action
584
583
  * execution.</p>
584
+ * @public
585
585
  */
586
586
  inputArtifacts?: ArtifactDetail[];
587
587
  /**
588
- * @public
589
588
  * <p>The variable namespace associated with the action. All variables produced as output by
590
589
  * this action fall under this namespace.</p>
590
+ * @public
591
591
  */
592
592
  namespace?: string;
593
593
  }
594
594
  /**
595
- * @public
596
595
  * <p>Execution result information, such as the external execution ID.</p>
596
+ * @public
597
597
  */
598
598
  export interface ActionExecutionResult {
599
599
  /**
600
- * @public
601
600
  * <p>The action provider's external ID for the action execution.</p>
601
+ * @public
602
602
  */
603
603
  externalExecutionId?: string;
604
604
  /**
605
- * @public
606
605
  * <p>The action provider's summary for the action execution.</p>
606
+ * @public
607
607
  */
608
608
  externalExecutionSummary?: string;
609
609
  /**
610
- * @public
611
610
  * <p>The deepest external link to the external resource (for example, a repository URL or
612
611
  * deployment endpoint) that is used when running the action.</p>
612
+ * @public
613
613
  */
614
614
  externalExecutionUrl?: string;
615
615
  /**
616
- * @public
617
616
  * <p>Represents information about an error in CodePipeline.</p>
617
+ * @public
618
618
  */
619
619
  errorDetails?: ErrorDetails;
620
620
  }
621
621
  /**
622
- * @public
623
622
  * <p>Output details listed for an action execution, such as the action execution
624
623
  * result.</p>
624
+ * @public
625
625
  */
626
626
  export interface ActionExecutionOutput {
627
627
  /**
628
- * @public
629
628
  * <p>Details of output artifacts of the action that correspond to the action
630
629
  * execution.</p>
630
+ * @public
631
631
  */
632
632
  outputArtifacts?: ArtifactDetail[];
633
633
  /**
634
- * @public
635
634
  * <p>Execution result information listed in the output details for an action
636
635
  * execution.</p>
636
+ * @public
637
637
  */
638
638
  executionResult?: ActionExecutionResult;
639
639
  /**
640
- * @public
641
640
  * <p>The outputVariables field shows the key-value pairs that were output as part of that
642
641
  * execution.</p>
642
+ * @public
643
643
  */
644
644
  outputVariables?: Record<string, string>;
645
645
  }
646
646
  /**
647
- * @public
648
647
  * <p>Returns information about an execution of an action, including the action execution
649
648
  * ID, and the name, version, and timing of the action. </p>
649
+ * @public
650
650
  */
651
651
  export interface ActionExecutionDetail {
652
652
  /**
653
- * @public
654
653
  * <p>The pipeline execution ID for the action execution.</p>
654
+ * @public
655
655
  */
656
656
  pipelineExecutionId?: string;
657
657
  /**
658
- * @public
659
658
  * <p>The action execution ID.</p>
659
+ * @public
660
660
  */
661
661
  actionExecutionId?: string;
662
662
  /**
663
- * @public
664
663
  * <p>The version of the pipeline where the action was run.</p>
664
+ * @public
665
665
  */
666
666
  pipelineVersion?: number;
667
667
  /**
668
- * @public
669
668
  * <p>The name of the stage that contains the action.</p>
669
+ * @public
670
670
  */
671
671
  stageName?: string;
672
672
  /**
673
- * @public
674
673
  * <p>The name of the action.</p>
674
+ * @public
675
675
  */
676
676
  actionName?: string;
677
677
  /**
678
- * @public
679
678
  * <p>The start time of the action execution.</p>
679
+ * @public
680
680
  */
681
681
  startTime?: Date;
682
682
  /**
683
- * @public
684
683
  * <p>The last update time of the action execution.</p>
684
+ * @public
685
685
  */
686
686
  lastUpdateTime?: Date;
687
687
  /**
688
- * @public
689
688
  * <p>The ARN of the user who changed the pipeline execution details.</p>
689
+ * @public
690
690
  */
691
691
  updatedBy?: string;
692
692
  /**
693
- * @public
694
693
  * <p> The status of the action execution. Status categories are <code>InProgress</code>,
695
694
  * <code>Succeeded</code>, and <code>Failed</code>.</p>
695
+ * @public
696
696
  */
697
697
  status?: ActionExecutionStatus;
698
698
  /**
699
- * @public
700
699
  * <p>Input details for the action execution, such as role ARN, Region, and input
701
700
  * artifacts.</p>
701
+ * @public
702
702
  */
703
703
  input?: ActionExecutionInput;
704
704
  /**
705
- * @public
706
705
  * <p>Output details for the action execution, such as the action execution result.</p>
706
+ * @public
707
707
  */
708
708
  output?: ActionExecutionOutput;
709
709
  }
@@ -720,22 +720,21 @@ export declare const StartTimeRange: {
720
720
  */
721
721
  export type StartTimeRange = (typeof StartTimeRange)[keyof typeof StartTimeRange];
722
722
  /**
723
- * @public
724
723
  * <p>The field that specifies to filter on the latest execution in the
725
724
  * pipeline.</p>
726
725
  * <note>
727
726
  * <p>Filtering on the latest execution is available for executions run on or after
728
727
  * February 08, 2024.</p>
729
728
  * </note>
729
+ * @public
730
730
  */
731
731
  export interface LatestInPipelineExecutionFilter {
732
732
  /**
733
- * @public
734
733
  * <p>The execution ID for the latest execution in the pipeline.</p>
734
+ * @public
735
735
  */
736
736
  pipelineExecutionId: string | undefined;
737
737
  /**
738
- * @public
739
738
  * <p>The start time to filter on for the latest execution in the pipeline. Valid
740
739
  * options:</p>
741
740
  * <ul>
@@ -746,32 +745,33 @@ export interface LatestInPipelineExecutionFilter {
746
745
  * <p>Latest</p>
747
746
  * </li>
748
747
  * </ul>
748
+ * @public
749
749
  */
750
750
  startTimeRange: StartTimeRange | undefined;
751
751
  }
752
752
  /**
753
- * @public
754
753
  * <p>Filter values for the action execution.</p>
754
+ * @public
755
755
  */
756
756
  export interface ActionExecutionFilter {
757
757
  /**
758
- * @public
759
758
  * <p>The pipeline execution ID used to filter action execution history.</p>
759
+ * @public
760
760
  */
761
761
  pipelineExecutionId?: string;
762
762
  /**
763
- * @public
764
763
  * <p>The latest execution in the pipeline.</p>
765
764
  * <note>
766
765
  * <p>Filtering on the latest execution is available for executions run on or after
767
766
  * February 08, 2024.</p>
768
767
  * </note>
768
+ * @public
769
769
  */
770
770
  latestInPipelineExecution?: LatestInPipelineExecutionFilter;
771
771
  }
772
772
  /**
773
- * @public
774
773
  * <p>The specified action cannot be found.</p>
774
+ * @public
775
775
  */
776
776
  export declare class ActionNotFoundException extends __BaseException {
777
777
  readonly name: "ActionNotFoundException";
@@ -782,210 +782,210 @@ export declare class ActionNotFoundException extends __BaseException {
782
782
  constructor(opts: __ExceptionOptionType<ActionNotFoundException, __BaseException>);
783
783
  }
784
784
  /**
785
- * @public
786
785
  * <p>Represents information about the version (or revision) of an action.</p>
786
+ * @public
787
787
  */
788
788
  export interface ActionRevision {
789
789
  /**
790
- * @public
791
790
  * <p>The system-generated unique ID that identifies the revision number of the
792
791
  * action.</p>
792
+ * @public
793
793
  */
794
794
  revisionId: string | undefined;
795
795
  /**
796
- * @public
797
796
  * <p>The unique identifier of the change that set the state to this revision (for
798
797
  * example, a deployment ID or timestamp).</p>
798
+ * @public
799
799
  */
800
800
  revisionChangeId: string | undefined;
801
801
  /**
802
- * @public
803
802
  * <p>The date and time when the most recent version of the action was created, in
804
803
  * timestamp format.</p>
804
+ * @public
805
805
  */
806
806
  created: Date | undefined;
807
807
  }
808
808
  /**
809
- * @public
810
809
  * <p>Represents information about the state of an action.</p>
810
+ * @public
811
811
  */
812
812
  export interface ActionState {
813
813
  /**
814
- * @public
815
814
  * <p>The name of the action.</p>
815
+ * @public
816
816
  */
817
817
  actionName?: string;
818
818
  /**
819
- * @public
820
819
  * <p>Represents information about the version (or revision) of an action.</p>
820
+ * @public
821
821
  */
822
822
  currentRevision?: ActionRevision;
823
823
  /**
824
- * @public
825
824
  * <p>Represents information about the run of an action.</p>
825
+ * @public
826
826
  */
827
827
  latestExecution?: ActionExecution;
828
828
  /**
829
- * @public
830
829
  * <p>A URL link for more information about the state of the action, such as a deployment
831
830
  * group details page.</p>
831
+ * @public
832
832
  */
833
833
  entityUrl?: string;
834
834
  /**
835
- * @public
836
835
  * <p>A URL link for more information about the revision, such as a commit details
837
836
  * page.</p>
837
+ * @public
838
838
  */
839
839
  revisionUrl?: string;
840
840
  }
841
841
  /**
842
- * @public
843
842
  * <p>Returns information about the details of an artifact.</p>
843
+ * @public
844
844
  */
845
845
  export interface ArtifactDetails {
846
846
  /**
847
- * @public
848
847
  * <p>The minimum number of artifacts allowed for the action type.</p>
848
+ * @public
849
849
  */
850
850
  minimumCount: number | undefined;
851
851
  /**
852
- * @public
853
852
  * <p>The maximum number of artifacts allowed for the action type.</p>
853
+ * @public
854
854
  */
855
855
  maximumCount: number | undefined;
856
856
  }
857
857
  /**
858
- * @public
859
858
  * <p>Returns information about the settings for an action type.</p>
859
+ * @public
860
860
  */
861
861
  export interface ActionTypeSettings {
862
862
  /**
863
- * @public
864
863
  * <p>The URL of a sign-up page where users can sign up for an external service and
865
864
  * perform initial configuration of the action provided by that service.</p>
865
+ * @public
866
866
  */
867
867
  thirdPartyConfigurationUrl?: string;
868
868
  /**
869
- * @public
870
869
  * <p>The URL returned to the CodePipeline console that provides a deep link to the
871
870
  * resources of the external system, such as the configuration page for a CodeDeploy
872
871
  * deployment group. This link is provided as part of the action display in the
873
872
  * pipeline.</p>
873
+ * @public
874
874
  */
875
875
  entityUrlTemplate?: string;
876
876
  /**
877
- * @public
878
877
  * <p>The URL returned to the CodePipeline console that contains a link to the
879
878
  * top-level landing page for the external system, such as the console page for CodeDeploy.
880
879
  * This link is shown on the pipeline view page in the CodePipeline console and
881
880
  * provides a link to the execution entity of the external action.</p>
881
+ * @public
882
882
  */
883
883
  executionUrlTemplate?: string;
884
884
  /**
885
- * @public
886
885
  * <p>The URL returned to the CodePipeline console that contains a link to the page
887
886
  * where customers can update or change the configuration of the external action.</p>
887
+ * @public
888
888
  */
889
889
  revisionUrlTemplate?: string;
890
890
  }
891
891
  /**
892
- * @public
893
892
  * <p>Returns information about the details of an action type.</p>
893
+ * @public
894
894
  */
895
895
  export interface ActionType {
896
896
  /**
897
- * @public
898
897
  * <p>Represents information about an action type.</p>
898
+ * @public
899
899
  */
900
900
  id: ActionTypeId | undefined;
901
901
  /**
902
- * @public
903
902
  * <p>The settings for the action type.</p>
903
+ * @public
904
904
  */
905
905
  settings?: ActionTypeSettings;
906
906
  /**
907
- * @public
908
907
  * <p>The configuration properties for the action type.</p>
908
+ * @public
909
909
  */
910
910
  actionConfigurationProperties?: ActionConfigurationProperty[];
911
911
  /**
912
- * @public
913
912
  * <p>The details of the input artifact for the action, such as its commit ID.</p>
913
+ * @public
914
914
  */
915
915
  inputArtifactDetails: ArtifactDetails | undefined;
916
916
  /**
917
- * @public
918
917
  * <p>The details of the output artifact of the action, such as its commit ID.</p>
918
+ * @public
919
919
  */
920
920
  outputArtifactDetails: ArtifactDetails | undefined;
921
921
  }
922
922
  /**
923
- * @public
924
923
  * <p>Information about parameters for artifacts associated with the action type, such as
925
924
  * the minimum and maximum artifacts allowed.</p>
925
+ * @public
926
926
  */
927
927
  export interface ActionTypeArtifactDetails {
928
928
  /**
929
- * @public
930
929
  * <p>The minimum number of artifacts that can be used with the action type. For example,
931
930
  * you should specify a minimum and maximum of zero input artifacts for an action type with
932
931
  * a category of <code>source</code>.</p>
932
+ * @public
933
933
  */
934
934
  minimumCount: number | undefined;
935
935
  /**
936
- * @public
937
936
  * <p>The maximum number of artifacts that can be used with the actiontype. For example, you
938
937
  * should specify a minimum and maximum of zero input artifacts for an action type with a
939
938
  * category of <code>source</code>.</p>
939
+ * @public
940
940
  */
941
941
  maximumCount: number | undefined;
942
942
  }
943
943
  /**
944
- * @public
945
944
  * <p>Details about the polling configuration for the <code>JobWorker</code> action engine,
946
945
  * or executor.</p>
946
+ * @public
947
947
  */
948
948
  export interface JobWorkerExecutorConfiguration {
949
949
  /**
950
- * @public
951
950
  * <p>The accounts in which the job worker is configured and might poll for jobs as part of
952
951
  * the action execution.</p>
952
+ * @public
953
953
  */
954
954
  pollingAccounts?: string[];
955
955
  /**
956
- * @public
957
956
  * <p>The service Principals in which the job worker is configured and might poll for jobs
958
957
  * as part of the action execution.</p>
958
+ * @public
959
959
  */
960
960
  pollingServicePrincipals?: string[];
961
961
  }
962
962
  /**
963
- * @public
964
963
  * <p>Details about the configuration for the <code>Lambda</code> action engine, or
965
964
  * executor.</p>
965
+ * @public
966
966
  */
967
967
  export interface LambdaExecutorConfiguration {
968
968
  /**
969
- * @public
970
969
  * <p>The ARN of the Lambda function used by the action engine.</p>
970
+ * @public
971
971
  */
972
972
  lambdaFunctionArn: string | undefined;
973
973
  }
974
974
  /**
975
- * @public
976
975
  * <p>The action engine, or executor, related to the supported integration model used to
977
976
  * create and update the action type. The available executor types are <code>Lambda</code>
978
977
  * and <code>JobWorker</code>.</p>
978
+ * @public
979
979
  */
980
980
  export interface ExecutorConfiguration {
981
981
  /**
982
- * @public
983
982
  * <p>Details about the <code>Lambda</code> executor of the action type.</p>
983
+ * @public
984
984
  */
985
985
  lambdaExecutorConfiguration?: LambdaExecutorConfiguration;
986
986
  /**
987
- * @public
988
987
  * <p>Details about the <code>JobWorker</code> executor of the action type.</p>
988
+ * @public
989
989
  */
990
990
  jobWorkerExecutorConfiguration?: JobWorkerExecutorConfiguration;
991
991
  }
@@ -1002,27 +1002,26 @@ export declare const ExecutorType: {
1002
1002
  */
1003
1003
  export type ExecutorType = (typeof ExecutorType)[keyof typeof ExecutorType];
1004
1004
  /**
1005
- * @public
1006
1005
  * <p>The action engine, or executor, for an action type created for a provider, where the
1007
1006
  * action is to be used by customers of the provider. The action engine is associated with
1008
1007
  * the model used to create and update the action, such as the Lambda integration
1009
1008
  * model.</p>
1009
+ * @public
1010
1010
  */
1011
1011
  export interface ActionTypeExecutor {
1012
1012
  /**
1013
- * @public
1014
1013
  * <p>The action configuration properties for the action type. These properties are
1015
1014
  * specified in the action definition when the action type is created.</p>
1015
+ * @public
1016
1016
  */
1017
1017
  configuration: ExecutorConfiguration | undefined;
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>The integration model used to create and update the action type, <code>Lambda</code>
1021
1020
  * or <code>JobWorker</code>. </p>
1021
+ * @public
1022
1022
  */
1023
1023
  type: ExecutorType | undefined;
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>The policy statement that specifies the permissions in the CodePipeline customer
1027
1026
  * account that are needed to successfully run an action.</p>
1028
1027
  * <p>To grant permission to another account, specify the account ID as the Principal, a
@@ -1031,22 +1030,22 @@ export interface ActionTypeExecutor {
1031
1030
  * <note>
1032
1031
  * <p>The size of the passed JSON policy document cannot exceed 2048 characters.</p>
1033
1032
  * </note>
1033
+ * @public
1034
1034
  */
1035
1035
  policyStatementsTemplate?: string;
1036
1036
  /**
1037
- * @public
1038
1037
  * <p>The timeout in seconds for the job. An action execution can have multiple jobs. This
1039
1038
  * is the timeout for a single job, not the entire action execution.</p>
1039
+ * @public
1040
1040
  */
1041
1041
  jobTimeout?: number;
1042
1042
  }
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>Specifies the category, owner, provider, and version of the action type.</p>
1045
+ * @public
1046
1046
  */
1047
1047
  export interface ActionTypeIdentifier {
1048
1048
  /**
1049
- * @public
1050
1049
  * <p>Defines what kind of action can be taken in the stage, one of the following:</p>
1051
1050
  * <ul>
1052
1051
  * <li>
@@ -1080,167 +1079,168 @@ export interface ActionTypeIdentifier {
1080
1079
  * </p>
1081
1080
  * </li>
1082
1081
  * </ul>
1082
+ * @public
1083
1083
  */
1084
1084
  category: ActionCategory | undefined;
1085
1085
  /**
1086
- * @public
1087
1086
  * <p>The creator of the action type being called: <code>AWS</code> or
1088
1087
  * <code>ThirdParty</code>.</p>
1088
+ * @public
1089
1089
  */
1090
1090
  owner: string | undefined;
1091
1091
  /**
1092
- * @public
1093
1092
  * <p>The provider of the action type being called. The provider name is supplied when the
1094
1093
  * action type is created.</p>
1094
+ * @public
1095
1095
  */
1096
1096
  provider: string | undefined;
1097
1097
  /**
1098
- * @public
1099
1098
  * <p>A string that describes the action type version.</p>
1099
+ * @public
1100
1100
  */
1101
1101
  version: string | undefined;
1102
1102
  }
1103
1103
  /**
1104
- * @public
1105
1104
  * <p>Details identifying the users with permissions to use the action type.</p>
1105
+ * @public
1106
1106
  */
1107
1107
  export interface ActionTypePermissions {
1108
1108
  /**
1109
- * @public
1110
1109
  * <p>A list of Amazon Web Services account IDs with access to use the action type in their
1111
1110
  * pipelines.</p>
1111
+ * @public
1112
1112
  */
1113
1113
  allowedAccounts: string[] | undefined;
1114
1114
  }
1115
1115
  /**
1116
- * @public
1117
1116
  * <p>Represents information about each property specified in the action configuration, such
1118
1117
  * as the description and key name that display for the customer using the action
1119
1118
  * type.</p>
1119
+ * @public
1120
1120
  */
1121
1121
  export interface ActionTypeProperty {
1122
1122
  /**
1123
- * @public
1124
1123
  * <p>The property name that is displayed to users.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  name: string | undefined;
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>Whether the configuration property is an optional value.</p>
1129
+ * @public
1130
1130
  */
1131
1131
  optional: boolean | undefined;
1132
1132
  /**
1133
- * @public
1134
1133
  * <p>Whether the configuration property is a key.</p>
1134
+ * @public
1135
1135
  */
1136
1136
  key: boolean | undefined;
1137
1137
  /**
1138
- * @public
1139
1138
  * <p>Whether to omit the field value entered by the customer in the log. If
1140
1139
  * <code>true</code>, the value is not saved in CloudTrail logs for the action
1141
1140
  * execution.</p>
1141
+ * @public
1142
1142
  */
1143
1143
  noEcho: boolean | undefined;
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>Indicates that the property is used with polling. An action type can have up to one
1147
1146
  * queryable property. If it has one, that property must be both required and not
1148
1147
  * secret.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  queryable?: boolean;
1151
1151
  /**
1152
- * @public
1153
1152
  * <p>The description of the property that is displayed to users.</p>
1153
+ * @public
1154
1154
  */
1155
1155
  description?: string;
1156
1156
  }
1157
1157
  /**
1158
- * @public
1159
1158
  * <p>Returns information about URLs for web pages that display to customers as links on the
1160
1159
  * pipeline view, such as an external configuration page for the action type.</p>
1160
+ * @public
1161
1161
  */
1162
1162
  export interface ActionTypeUrls {
1163
1163
  /**
1164
- * @public
1165
1164
  * <p>The URL returned to the CodePipeline console that contains a link to the page
1166
1165
  * where customers can configure the external action.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  configurationUrl?: string;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The URL returned to the CodePipeline console that provides a deep link to the
1172
1171
  * resources of the external system, such as a status page. This link is provided as part
1173
1172
  * of the action display in the pipeline.</p>
1173
+ * @public
1174
1174
  */
1175
1175
  entityUrlTemplate?: string;
1176
1176
  /**
1177
- * @public
1178
1177
  * <p>The link to an execution page for the action type in progress. For example, for a
1179
1178
  * CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.</p>
1179
+ * @public
1180
1180
  */
1181
1181
  executionUrlTemplate?: string;
1182
1182
  /**
1183
- * @public
1184
1183
  * <p>The URL returned to the CodePipeline console that contains a link to the page
1185
1184
  * where customers can update or change the configuration of the external action.</p>
1185
+ * @public
1186
1186
  */
1187
1187
  revisionUrlTemplate?: string;
1188
1188
  }
1189
1189
  /**
1190
- * @public
1191
1190
  * <p>The parameters for the action type definition that are provided when the action type
1192
1191
  * is created or updated.</p>
1192
+ * @public
1193
1193
  */
1194
1194
  export interface ActionTypeDeclaration {
1195
1195
  /**
1196
- * @public
1197
1196
  * <p>The description for the action type to be updated.</p>
1197
+ * @public
1198
1198
  */
1199
1199
  description?: string;
1200
1200
  /**
1201
- * @public
1202
1201
  * <p>Information about the executor for an action type that was created with any supported
1203
1202
  * integration model.</p>
1203
+ * @public
1204
1204
  */
1205
1205
  executor: ActionTypeExecutor | undefined;
1206
1206
  /**
1207
- * @public
1208
1207
  * <p>The action category, owner, provider, and version of the action type to be
1209
1208
  * updated.</p>
1209
+ * @public
1210
1210
  */
1211
1211
  id: ActionTypeIdentifier | undefined;
1212
1212
  /**
1213
- * @public
1214
1213
  * <p>Details for the artifacts, such as application files, to be worked on by the action.
1215
1214
  * For example, the minimum and maximum number of input artifacts allowed.</p>
1215
+ * @public
1216
1216
  */
1217
1217
  inputArtifactDetails: ActionTypeArtifactDetails | undefined;
1218
1218
  /**
1219
- * @public
1220
1219
  * <p>Details for the output artifacts, such as a built application, that are the result of
1221
1220
  * the action. For example, the minimum and maximum number of output artifacts
1222
1221
  * allowed.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  outputArtifactDetails: ActionTypeArtifactDetails | undefined;
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>Details identifying the accounts with permissions to use the action type.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  permissions?: ActionTypePermissions;
1230
1230
  /**
1231
- * @public
1232
1231
  * <p>The properties of the action type to be updated.</p>
1232
+ * @public
1233
1233
  */
1234
1234
  properties?: ActionTypeProperty[];
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>The links associated with the action type to be updated.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  urls?: ActionTypeUrls;
1240
1240
  }
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The specified action type cannot be found.</p>
1243
+ * @public
1244
1244
  */
1245
1245
  export declare class ActionTypeNotFoundException extends __BaseException {
1246
1246
  readonly name: "ActionTypeNotFoundException";
@@ -1251,8 +1251,8 @@ export declare class ActionTypeNotFoundException extends __BaseException {
1251
1251
  constructor(opts: __ExceptionOptionType<ActionTypeNotFoundException, __BaseException>);
1252
1252
  }
1253
1253
  /**
1254
- * @public
1255
1254
  * <p>The approval action has already been approved or rejected.</p>
1255
+ * @public
1256
1256
  */
1257
1257
  export declare class ApprovalAlreadyCompletedException extends __BaseException {
1258
1258
  readonly name: "ApprovalAlreadyCompletedException";
@@ -1275,36 +1275,36 @@ export declare const ApprovalStatus: {
1275
1275
  */
1276
1276
  export type ApprovalStatus = (typeof ApprovalStatus)[keyof typeof ApprovalStatus];
1277
1277
  /**
1278
- * @public
1279
1278
  * <p>Represents information about the result of an approval request.</p>
1279
+ * @public
1280
1280
  */
1281
1281
  export interface ApprovalResult {
1282
1282
  /**
1283
- * @public
1284
1283
  * <p>The summary of the current status of the approval request.</p>
1284
+ * @public
1285
1285
  */
1286
1286
  summary: string | undefined;
1287
1287
  /**
1288
- * @public
1289
1288
  * <p>The response submitted by a reviewer assigned to an approval action
1290
1289
  * request.</p>
1290
+ * @public
1291
1291
  */
1292
1292
  status: ApprovalStatus | undefined;
1293
1293
  }
1294
1294
  /**
1295
- * @public
1296
1295
  * <p>The location of the S3 bucket that contains a revision.</p>
1296
+ * @public
1297
1297
  */
1298
1298
  export interface S3ArtifactLocation {
1299
1299
  /**
1300
- * @public
1301
1300
  * <p>The name of the S3 bucket.</p>
1301
+ * @public
1302
1302
  */
1303
1303
  bucketName: string | undefined;
1304
1304
  /**
1305
- * @public
1306
1305
  * <p>The key of the object in the S3 bucket, which uniquely identifies the object in the
1307
1306
  * bucket.</p>
1307
+ * @public
1308
1308
  */
1309
1309
  objectKey: string | undefined;
1310
1310
  }
@@ -1320,86 +1320,86 @@ export declare const ArtifactLocationType: {
1320
1320
  */
1321
1321
  export type ArtifactLocationType = (typeof ArtifactLocationType)[keyof typeof ArtifactLocationType];
1322
1322
  /**
1323
- * @public
1324
1323
  * <p>Represents information about the location of an artifact.</p>
1324
+ * @public
1325
1325
  */
1326
1326
  export interface ArtifactLocation {
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>The type of artifact in the location.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  type?: ArtifactLocationType;
1332
1332
  /**
1333
- * @public
1334
1333
  * <p>The S3 bucket that contains the artifact.</p>
1334
+ * @public
1335
1335
  */
1336
1336
  s3Location?: S3ArtifactLocation;
1337
1337
  }
1338
1338
  /**
1339
- * @public
1340
1339
  * <p>Artifacts are the files that are worked on by actions in the pipeline. See the
1341
1340
  * action configuration for each action for details about artifact parameters. For example,
1342
1341
  * the S3 source action artifact is a file name (or file path), and the files are generally
1343
1342
  * provided as a ZIP file. Example artifact name: SampleApp_Windows.zip</p>
1343
+ * @public
1344
1344
  */
1345
1345
  export interface Artifact {
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>The artifact's name.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  name?: string;
1351
1351
  /**
1352
- * @public
1353
1352
  * <p>The artifact's revision ID. Depending on the type of object, this could be a commit
1354
1353
  * ID (GitHub) or a revision ID (Amazon S3).</p>
1354
+ * @public
1355
1355
  */
1356
1356
  revision?: string;
1357
1357
  /**
1358
- * @public
1359
1358
  * <p>The location of an artifact.</p>
1359
+ * @public
1360
1360
  */
1361
1361
  location?: ArtifactLocation;
1362
1362
  }
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>Represents revision details of an artifact. </p>
1365
+ * @public
1366
1366
  */
1367
1367
  export interface ArtifactRevision {
1368
1368
  /**
1369
- * @public
1370
1369
  * <p>The name of an artifact. This name might be system-generated, such as "MyApp", or
1371
1370
  * defined by the user when an action is created.</p>
1371
+ * @public
1372
1372
  */
1373
1373
  name?: string;
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>The revision ID of the artifact.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  revisionId?: string;
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>An additional identifier for a revision, such as a commit date or, for artifacts
1382
1381
  * stored in Amazon S3 buckets, the ETag value.</p>
1382
+ * @public
1383
1383
  */
1384
1384
  revisionChangeIdentifier?: string;
1385
1385
  /**
1386
- * @public
1387
1386
  * <p>Summary information about the most recent revision of the artifact. For GitHub and
1388
1387
  * CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the
1389
1388
  * user-provided content of a <code>codepipeline-artifact-revision-summary</code> key
1390
1389
  * specified in the object metadata.</p>
1390
+ * @public
1391
1391
  */
1392
1392
  revisionSummary?: string;
1393
1393
  /**
1394
- * @public
1395
1394
  * <p>The date and time when the most recent revision of the artifact was created, in
1396
1395
  * timestamp format.</p>
1396
+ * @public
1397
1397
  */
1398
1398
  created?: Date;
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>The commit ID for the artifact revision. For artifacts stored in GitHub or
1402
1401
  * CodeCommit repositories, the commit ID is linked to a commit details page.</p>
1402
+ * @public
1403
1403
  */
1404
1404
  revisionUrl?: string;
1405
1405
  }
@@ -1415,14 +1415,13 @@ export declare const EncryptionKeyType: {
1415
1415
  */
1416
1416
  export type EncryptionKeyType = (typeof EncryptionKeyType)[keyof typeof EncryptionKeyType];
1417
1417
  /**
1418
- * @public
1419
1418
  * <p>Represents information about the key used to encrypt data in the artifact store,
1420
1419
  * such as an Amazon Web Services Key Management Service (Key Management Service)
1421
1420
  * key.</p>
1421
+ * @public
1422
1422
  */
1423
1423
  export interface EncryptionKey {
1424
1424
  /**
1425
- * @public
1426
1425
  * <p>The ID used to identify the key. For an Amazon Web Services KMS key, you can use the
1427
1426
  * key ID, the key ARN, or the alias ARN.</p>
1428
1427
  * <note>
@@ -1432,12 +1431,13 @@ export interface EncryptionKey {
1432
1431
  * (AccountB), so specifying the key ID will use the key from the other account
1433
1432
  * (AccountB).</p>
1434
1433
  * </note>
1434
+ * @public
1435
1435
  */
1436
1436
  id: string | undefined;
1437
1437
  /**
1438
- * @public
1439
1438
  * <p>The type of encryption key, such as an Amazon Web Services KMS key. When creating or
1440
1439
  * updating a pipeline, the value must be set to 'KMS'.</p>
1440
+ * @public
1441
1441
  */
1442
1442
  type: EncryptionKeyType | undefined;
1443
1443
  }
@@ -1453,7 +1453,6 @@ export declare const ArtifactStoreType: {
1453
1453
  */
1454
1454
  export type ArtifactStoreType = (typeof ArtifactStoreType)[keyof typeof ArtifactStoreType];
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>The S3 bucket where artifacts for the pipeline are stored.</p>
1458
1457
  * <note>
1459
1458
  * <p>You must include either <code>artifactStore</code> or
@@ -1461,51 +1460,52 @@ export type ArtifactStoreType = (typeof ArtifactStoreType)[keyof typeof Artifact
1461
1460
  * create a cross-region action in your pipeline, you must use
1462
1461
  * <code>artifactStores</code>.</p>
1463
1462
  * </note>
1463
+ * @public
1464
1464
  */
1465
1465
  export interface ArtifactStore {
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>The type of the artifact store, such as S3.</p>
1468
+ * @public
1469
1469
  */
1470
1470
  type: ArtifactStoreType | undefined;
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>The S3 bucket used for storing the artifacts for a pipeline. You can specify the
1474
1473
  * name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline
1475
1474
  * artifacts is created for you based on the name of the pipeline. You can use any S3
1476
1475
  * bucket in the same Amazon Web Services Region as the pipeline to store your pipeline
1477
1476
  * artifacts.</p>
1477
+ * @public
1478
1478
  */
1479
1479
  location: string | undefined;
1480
1480
  /**
1481
- * @public
1482
1481
  * <p>The encryption key used to encrypt the data in the artifact store, such as an
1483
1482
  * Amazon Web Services Key Management Service key. If this is undefined, the default key
1484
1483
  * for Amazon S3 is used.</p>
1484
+ * @public
1485
1485
  */
1486
1486
  encryptionKey?: EncryptionKey;
1487
1487
  }
1488
1488
  /**
1489
- * @public
1490
1489
  * <p>Represents an Amazon Web Services session credentials object. These credentials are
1491
1490
  * temporary credentials that are issued by Amazon Web Services Secure Token Service (STS).
1492
1491
  * They can be used to access input and output artifacts in the S3 bucket used to store
1493
1492
  * artifact for the pipeline in CodePipeline.</p>
1493
+ * @public
1494
1494
  */
1495
1495
  export interface AWSSessionCredentials {
1496
1496
  /**
1497
- * @public
1498
1497
  * <p>The access key for the session.</p>
1498
+ * @public
1499
1499
  */
1500
1500
  accessKeyId: string | undefined;
1501
1501
  /**
1502
- * @public
1503
1502
  * <p>The secret access key for the session.</p>
1503
+ * @public
1504
1504
  */
1505
1505
  secretAccessKey: string | undefined;
1506
1506
  /**
1507
- * @public
1508
1507
  * <p>The token for the session.</p>
1508
+ * @public
1509
1509
  */
1510
1510
  sessionToken: string | undefined;
1511
1511
  }
@@ -1521,24 +1521,24 @@ export declare const BlockerType: {
1521
1521
  */
1522
1522
  export type BlockerType = (typeof BlockerType)[keyof typeof BlockerType];
1523
1523
  /**
1524
- * @public
1525
1524
  * <p>Reserved for future use.</p>
1525
+ * @public
1526
1526
  */
1527
1527
  export interface BlockerDeclaration {
1528
1528
  /**
1529
- * @public
1530
1529
  * <p>Reserved for future use.</p>
1530
+ * @public
1531
1531
  */
1532
1532
  name: string | undefined;
1533
1533
  /**
1534
- * @public
1535
1534
  * <p>Reserved for future use.</p>
1535
+ * @public
1536
1536
  */
1537
1537
  type: BlockerType | undefined;
1538
1538
  }
1539
1539
  /**
1540
- * @public
1541
1540
  * <p>Unable to modify the tag due to a simultaneous update request.</p>
1541
+ * @public
1542
1542
  */
1543
1543
  export declare class ConcurrentModificationException extends __BaseException {
1544
1544
  readonly name: "ConcurrentModificationException";
@@ -1549,50 +1549,49 @@ export declare class ConcurrentModificationException extends __BaseException {
1549
1549
  constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
1550
1550
  }
1551
1551
  /**
1552
- * @public
1553
1552
  * <p>A tag is a key-value pair that is used to manage the resource.</p>
1553
+ * @public
1554
1554
  */
1555
1555
  export interface Tag {
1556
1556
  /**
1557
- * @public
1558
1557
  * <p>The tag's key.</p>
1558
+ * @public
1559
1559
  */
1560
1560
  key: string | undefined;
1561
1561
  /**
1562
- * @public
1563
1562
  * <p>The tag's value.</p>
1563
+ * @public
1564
1564
  */
1565
1565
  value: string | undefined;
1566
1566
  }
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>Represents the input of a CreateCustomActionType operation.</p>
1569
+ * @public
1570
1570
  */
1571
1571
  export interface CreateCustomActionTypeInput {
1572
1572
  /**
1573
- * @public
1574
1573
  * <p>The category of the custom action, such as a build action or a test
1575
1574
  * action.</p>
1575
+ * @public
1576
1576
  */
1577
1577
  category: ActionCategory | undefined;
1578
1578
  /**
1579
- * @public
1580
1579
  * <p>The provider of the service used in the custom action, such as
1581
1580
  * CodeDeploy.</p>
1581
+ * @public
1582
1582
  */
1583
1583
  provider: string | undefined;
1584
1584
  /**
1585
- * @public
1586
1585
  * <p>The version identifier of the custom action.</p>
1586
+ * @public
1587
1587
  */
1588
1588
  version: string | undefined;
1589
1589
  /**
1590
- * @public
1591
1590
  * <p>URLs that provide users information about this custom action.</p>
1591
+ * @public
1592
1592
  */
1593
1593
  settings?: ActionTypeSettings;
1594
1594
  /**
1595
- * @public
1596
1595
  * <p>The configuration properties for the custom action.</p>
1597
1596
  * <note>
1598
1597
  * <p>You can refer to a name in the configuration properties of the custom action
@@ -1601,43 +1600,44 @@ export interface CreateCustomActionTypeInput {
1601
1600
  * <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html">Create a
1602
1601
  * Custom Action for a Pipeline</a>.</p>
1603
1602
  * </note>
1603
+ * @public
1604
1604
  */
1605
1605
  configurationProperties?: ActionConfigurationProperty[];
1606
1606
  /**
1607
- * @public
1608
1607
  * <p>The details of the input artifact for the action, such as its commit ID.</p>
1608
+ * @public
1609
1609
  */
1610
1610
  inputArtifactDetails: ArtifactDetails | undefined;
1611
1611
  /**
1612
- * @public
1613
1612
  * <p>The details of the output artifact of the action, such as its commit ID.</p>
1613
+ * @public
1614
1614
  */
1615
1615
  outputArtifactDetails: ArtifactDetails | undefined;
1616
1616
  /**
1617
- * @public
1618
1617
  * <p>The tags for the custom action.</p>
1618
+ * @public
1619
1619
  */
1620
1620
  tags?: Tag[];
1621
1621
  }
1622
1622
  /**
1623
- * @public
1624
1623
  * <p>Represents the output of a <code>CreateCustomActionType</code> operation.</p>
1624
+ * @public
1625
1625
  */
1626
1626
  export interface CreateCustomActionTypeOutput {
1627
1627
  /**
1628
- * @public
1629
1628
  * <p>Returns information about the details of an action type.</p>
1629
+ * @public
1630
1630
  */
1631
1631
  actionType: ActionType | undefined;
1632
1632
  /**
1633
- * @public
1634
1633
  * <p>Specifies the tags applied to the custom action.</p>
1634
+ * @public
1635
1635
  */
1636
1636
  tags?: Tag[];
1637
1637
  }
1638
1638
  /**
1639
- * @public
1640
1639
  * <p>The specified resource tags are invalid.</p>
1640
+ * @public
1641
1641
  */
1642
1642
  export declare class InvalidTagsException extends __BaseException {
1643
1643
  readonly name: "InvalidTagsException";
@@ -1648,9 +1648,9 @@ export declare class InvalidTagsException extends __BaseException {
1648
1648
  constructor(opts: __ExceptionOptionType<InvalidTagsException, __BaseException>);
1649
1649
  }
1650
1650
  /**
1651
- * @public
1652
1651
  * <p>The number of pipelines associated with the Amazon Web Services account has exceeded
1653
1652
  * the limit allowed for the account.</p>
1653
+ * @public
1654
1654
  */
1655
1655
  export declare class LimitExceededException extends __BaseException {
1656
1656
  readonly name: "LimitExceededException";
@@ -1661,8 +1661,8 @@ export declare class LimitExceededException extends __BaseException {
1661
1661
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1662
1662
  }
1663
1663
  /**
1664
- * @public
1665
1664
  * <p>The tags limit for a resource has been exceeded.</p>
1665
+ * @public
1666
1666
  */
1667
1667
  export declare class TooManyTagsException extends __BaseException {
1668
1668
  readonly name: "TooManyTagsException";
@@ -1698,42 +1698,42 @@ export declare const PipelineType: {
1698
1698
  */
1699
1699
  export type PipelineType = (typeof PipelineType)[keyof typeof PipelineType];
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>Represents information about a stage and its definition.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  export interface StageDeclaration {
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>The name of the stage.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  name: string | undefined;
1710
1710
  /**
1711
- * @public
1712
1711
  * <p>Reserved for future use.</p>
1712
+ * @public
1713
1713
  */
1714
1714
  blockers?: BlockerDeclaration[];
1715
1715
  /**
1716
- * @public
1717
1716
  * <p>The actions included in a stage.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  actions: ActionDeclaration[] | undefined;
1720
1720
  }
1721
1721
  /**
1722
- * @public
1723
1722
  * <p>The Git repository branches specified as filter criteria to start the
1724
1723
  * pipeline.</p>
1724
+ * @public
1725
1725
  */
1726
1726
  export interface GitBranchFilterCriteria {
1727
1727
  /**
1728
- * @public
1729
1728
  * <p>The list of patterns of Git branches that, when a commit is pushed, are to be
1730
1729
  * included as criteria that starts the pipeline.</p>
1730
+ * @public
1731
1731
  */
1732
1732
  includes?: string[];
1733
1733
  /**
1734
- * @public
1735
1734
  * <p>The list of patterns of Git branches that, when a commit is pushed, are to be
1736
1735
  * excluded from starting the pipeline.</p>
1736
+ * @public
1737
1737
  */
1738
1738
  excludes?: string[];
1739
1739
  }
@@ -1751,124 +1751,124 @@ export declare const GitPullRequestEventType: {
1751
1751
  */
1752
1752
  export type GitPullRequestEventType = (typeof GitPullRequestEventType)[keyof typeof GitPullRequestEventType];
1753
1753
  /**
1754
- * @public
1755
1754
  * <p>The Git repository file paths specified as filter criteria to start the
1756
1755
  * pipeline.</p>
1756
+ * @public
1757
1757
  */
1758
1758
  export interface GitFilePathFilterCriteria {
1759
1759
  /**
1760
- * @public
1761
1760
  * <p>The list of patterns of Git repository file paths that, when a commit is pushed,
1762
1761
  * are to be included as criteria that starts the pipeline.</p>
1762
+ * @public
1763
1763
  */
1764
1764
  includes?: string[];
1765
1765
  /**
1766
- * @public
1767
1766
  * <p>The list of patterns of Git repository file paths that, when a commit is pushed,
1768
1767
  * are to be excluded from starting the pipeline.</p>
1768
+ * @public
1769
1769
  */
1770
1770
  excludes?: string[];
1771
1771
  }
1772
1772
  /**
1773
- * @public
1774
1773
  * <p>The event criteria for the pull request trigger configuration, such as the lists of
1775
1774
  * branches or file paths to include and exclude.</p>
1775
+ * @public
1776
1776
  */
1777
1777
  export interface GitPullRequestFilter {
1778
1778
  /**
1779
- * @public
1780
1779
  * <p>The field that specifies which pull request events to filter on (opened, updated,
1781
1780
  * closed) for the trigger configuration.</p>
1781
+ * @public
1782
1782
  */
1783
1783
  events?: GitPullRequestEventType[];
1784
1784
  /**
1785
- * @public
1786
1785
  * <p>The field that specifies to filter on branches for the pull request trigger
1787
1786
  * configuration.</p>
1787
+ * @public
1788
1788
  */
1789
1789
  branches?: GitBranchFilterCriteria;
1790
1790
  /**
1791
- * @public
1792
1791
  * <p>The field that specifies to filter on file paths for the pull request trigger
1793
1792
  * configuration.</p>
1793
+ * @public
1794
1794
  */
1795
1795
  filePaths?: GitFilePathFilterCriteria;
1796
1796
  }
1797
1797
  /**
1798
- * @public
1799
1798
  * <p>The Git tags specified as filter criteria for whether a Git tag repository event
1800
1799
  * will start the pipeline.</p>
1800
+ * @public
1801
1801
  */
1802
1802
  export interface GitTagFilterCriteria {
1803
1803
  /**
1804
- * @public
1805
1804
  * <p>The list of patterns of Git tags that, when pushed, are to be included as criteria
1806
1805
  * that starts the pipeline.</p>
1806
+ * @public
1807
1807
  */
1808
1808
  includes?: string[];
1809
1809
  /**
1810
- * @public
1811
1810
  * <p>The list of patterns of Git tags that, when pushed, are to be excluded from
1812
1811
  * starting the pipeline.</p>
1812
+ * @public
1813
1813
  */
1814
1814
  excludes?: string[];
1815
1815
  }
1816
1816
  /**
1817
- * @public
1818
1817
  * <p>The event criteria that specify when a specified repository event will start the
1819
1818
  * pipeline for the specified trigger configuration, such as the lists of Git tags to
1820
1819
  * include and exclude.</p>
1820
+ * @public
1821
1821
  */
1822
1822
  export interface GitPushFilter {
1823
1823
  /**
1824
- * @public
1825
1824
  * <p>The field that contains the details for the Git tags trigger
1826
1825
  * configuration.</p>
1826
+ * @public
1827
1827
  */
1828
1828
  tags?: GitTagFilterCriteria;
1829
1829
  /**
1830
- * @public
1831
1830
  * <p>The field that specifies to filter on branches for the push trigger
1832
1831
  * configuration.</p>
1832
+ * @public
1833
1833
  */
1834
1834
  branches?: GitBranchFilterCriteria;
1835
1835
  /**
1836
- * @public
1837
1836
  * <p>The field that specifies to filter on file paths for the push trigger
1838
1837
  * configuration.</p>
1838
+ * @public
1839
1839
  */
1840
1840
  filePaths?: GitFilePathFilterCriteria;
1841
1841
  }
1842
1842
  /**
1843
- * @public
1844
1843
  * <p>A type of trigger configuration for Git-based source actions.</p>
1845
1844
  * <note>
1846
1845
  * <p>You can specify the Git configuration trigger type for all third-party
1847
1846
  * Git-based source actions that are supported by the
1848
1847
  * <code>CodeStarSourceConnection</code> action type.</p>
1849
1848
  * </note>
1849
+ * @public
1850
1850
  */
1851
1851
  export interface GitConfiguration {
1852
1852
  /**
1853
- * @public
1854
1853
  * <p>The name of the pipeline source action where the trigger configuration, such as Git
1855
1854
  * tags, is specified. The trigger configuration will start the pipeline upon the specified
1856
1855
  * change only.</p>
1857
1856
  * <note>
1858
1857
  * <p>You can only specify one trigger configuration per source action.</p>
1859
1858
  * </note>
1859
+ * @public
1860
1860
  */
1861
1861
  sourceActionName: string | undefined;
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>The field where the repository event that will start the pipeline, such as pushing
1865
1864
  * Git tags, is specified with details.</p>
1865
+ * @public
1866
1866
  */
1867
1867
  push?: GitPushFilter[];
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>The field where the repository event that will start the pipeline is specified as
1871
1870
  * pull requests.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  pullRequest?: GitPullRequestFilter[];
1874
1874
  }
@@ -1884,7 +1884,6 @@ export declare const PipelineTriggerProviderType: {
1884
1884
  */
1885
1885
  export type PipelineTriggerProviderType = (typeof PipelineTriggerProviderType)[keyof typeof PipelineTriggerProviderType];
1886
1886
  /**
1887
- * @public
1888
1887
  * <p>Represents information about the specified trigger configuration, such as the
1889
1888
  * filter criteria and the source stage for the action that contains the trigger.</p>
1890
1889
  * <note>
@@ -1895,63 +1894,63 @@ export type PipelineTriggerProviderType = (typeof PipelineTriggerProviderType)[k
1895
1894
  * <p>When a trigger configuration is specified, default change detection for
1896
1895
  * repository and branch commits is disabled.</p>
1897
1896
  * </note>
1897
+ * @public
1898
1898
  */
1899
1899
  export interface PipelineTriggerDeclaration {
1900
1900
  /**
1901
- * @public
1902
1901
  * <p>The source provider for the event, such as connections configured for a repository
1903
1902
  * with Git tags, for the specified trigger configuration.</p>
1903
+ * @public
1904
1904
  */
1905
1905
  providerType: PipelineTriggerProviderType | undefined;
1906
1906
  /**
1907
- * @public
1908
1907
  * <p>Provides the filter criteria and the source stage for the repository event that
1909
1908
  * starts the pipeline, such as Git tags.</p>
1909
+ * @public
1910
1910
  */
1911
1911
  gitConfiguration: GitConfiguration | undefined;
1912
1912
  }
1913
1913
  /**
1914
- * @public
1915
1914
  * <p>A variable declared at the pipeline level.</p>
1915
+ * @public
1916
1916
  */
1917
1917
  export interface PipelineVariableDeclaration {
1918
1918
  /**
1919
- * @public
1920
1919
  * <p>The name of a pipeline-level variable.</p>
1920
+ * @public
1921
1921
  */
1922
1922
  name: string | undefined;
1923
1923
  /**
1924
- * @public
1925
1924
  * <p>The value of a pipeline-level variable.</p>
1925
+ * @public
1926
1926
  */
1927
1927
  defaultValue?: string;
1928
1928
  /**
1929
- * @public
1930
1929
  * <p>The description of a pipeline-level variable. It's used to add additional context
1931
1930
  * about the variable, and not being used at time when pipeline executes.</p>
1931
+ * @public
1932
1932
  */
1933
1933
  description?: string;
1934
1934
  }
1935
1935
  /**
1936
- * @public
1937
1936
  * <p>Represents the structure of actions and stages to be performed in the
1938
1937
  * pipeline.</p>
1938
+ * @public
1939
1939
  */
1940
1940
  export interface PipelineDeclaration {
1941
1941
  /**
1942
- * @public
1943
1942
  * <p>The name of the pipeline.</p>
1943
+ * @public
1944
1944
  */
1945
1945
  name: string | undefined;
1946
1946
  /**
1947
- * @public
1948
1947
  * <p>The Amazon Resource Name (ARN) for CodePipeline to use to either perform
1949
1948
  * actions with no <code>actionRoleArn</code>, or to use to assume roles for actions with
1950
1949
  * an <code>actionRoleArn</code>.</p>
1950
+ * @public
1951
1951
  */
1952
1952
  roleArn: string | undefined;
1953
1953
  /**
1954
- * @public
1955
1954
  * <p>Represents information about the S3 bucket where artifacts are stored for the
1956
1955
  * pipeline.</p>
1957
1956
  * <note>
@@ -1960,10 +1959,10 @@ export interface PipelineDeclaration {
1960
1959
  * create a cross-region action in your pipeline, you must use
1961
1960
  * <code>artifactStores</code>.</p>
1962
1961
  * </note>
1962
+ * @public
1963
1963
  */
1964
1964
  artifactStore?: ArtifactStore;
1965
1965
  /**
1966
- * @public
1967
1966
  * <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
1968
1967
  * each cross-region action in the pipeline.</p>
1969
1968
  * <note>
@@ -1972,27 +1971,27 @@ export interface PipelineDeclaration {
1972
1971
  * create a cross-region action in your pipeline, you must use
1973
1972
  * <code>artifactStores</code>.</p>
1974
1973
  * </note>
1974
+ * @public
1975
1975
  */
1976
1976
  artifactStores?: Record<string, ArtifactStore>;
1977
1977
  /**
1978
- * @public
1979
1978
  * <p>The stage in which to perform the action.</p>
1979
+ * @public
1980
1980
  */
1981
1981
  stages: StageDeclaration[] | undefined;
1982
1982
  /**
1983
- * @public
1984
1983
  * <p>The version number of the pipeline. A new pipeline always has a version number of
1985
1984
  * 1. This number is incremented when a pipeline is updated.</p>
1985
+ * @public
1986
1986
  */
1987
1987
  version?: number;
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>The method that the pipeline will use to handle multiple executions. The default
1991
1990
  * mode is SUPERSEDED.</p>
1991
+ * @public
1992
1992
  */
1993
1993
  executionMode?: ExecutionMode;
1994
1994
  /**
1995
- * @public
1996
1995
  * <p>CodePipeline provides the following pipeline types, which differ in
1997
1996
  * characteristics and price, so that you can tailor your pipeline features and cost to the
1998
1997
  * needs of your applications.</p>
@@ -2014,63 +2013,64 @@ export interface PipelineDeclaration {
2014
2013
  * <p>For information about pricing for CodePipeline, see <a href="http://aws.amazon.com/codepipeline/pricing/">Pricing</a>.</p>
2015
2014
  * <p> For information about which type of pipeline to choose, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html">What type of
2016
2015
  * pipeline is right for me?</a>.</p>
2016
+ * @public
2017
2017
  */
2018
2018
  pipelineType?: PipelineType;
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>A list that defines the pipeline variables for a pipeline resource. Variable names can
2022
2021
  * have alphanumeric and underscore characters, and the values must match
2023
2022
  * <code>[A-Za-z0-9@\-_]+</code>.</p>
2023
+ * @public
2024
2024
  */
2025
2025
  variables?: PipelineVariableDeclaration[];
2026
2026
  /**
2027
- * @public
2028
2027
  * <p>The trigger configuration specifying a type of event, such as Git tags, that starts
2029
2028
  * the pipeline.</p>
2030
2029
  * <note>
2031
2030
  * <p>When a trigger configuration is specified, default change detection for
2032
2031
  * repository and branch commits is disabled.</p>
2033
2032
  * </note>
2033
+ * @public
2034
2034
  */
2035
2035
  triggers?: PipelineTriggerDeclaration[];
2036
2036
  }
2037
2037
  /**
2038
- * @public
2039
2038
  * <p>Represents the input of a <code>CreatePipeline</code> action.</p>
2039
+ * @public
2040
2040
  */
2041
2041
  export interface CreatePipelineInput {
2042
2042
  /**
2043
- * @public
2044
2043
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
2045
2044
  * </p>
2045
+ * @public
2046
2046
  */
2047
2047
  pipeline: PipelineDeclaration | undefined;
2048
2048
  /**
2049
- * @public
2050
2049
  * <p>The tags for the pipeline.</p>
2050
+ * @public
2051
2051
  */
2052
2052
  tags?: Tag[];
2053
2053
  }
2054
2054
  /**
2055
- * @public
2056
2055
  * <p>Represents the output of a <code>CreatePipeline</code> action.</p>
2056
+ * @public
2057
2057
  */
2058
2058
  export interface CreatePipelineOutput {
2059
2059
  /**
2060
- * @public
2061
2060
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
2062
2061
  * </p>
2062
+ * @public
2063
2063
  */
2064
2064
  pipeline?: PipelineDeclaration;
2065
2065
  /**
2066
- * @public
2067
2066
  * <p>Specifies the tags applied to the pipeline.</p>
2067
+ * @public
2068
2068
  */
2069
2069
  tags?: Tag[];
2070
2070
  }
2071
2071
  /**
2072
- * @public
2073
2072
  * <p>The action declaration was specified in an invalid format.</p>
2073
+ * @public
2074
2074
  */
2075
2075
  export declare class InvalidActionDeclarationException extends __BaseException {
2076
2076
  readonly name: "InvalidActionDeclarationException";
@@ -2081,8 +2081,8 @@ export declare class InvalidActionDeclarationException extends __BaseException {
2081
2081
  constructor(opts: __ExceptionOptionType<InvalidActionDeclarationException, __BaseException>);
2082
2082
  }
2083
2083
  /**
2084
- * @public
2085
2084
  * <p>Reserved for future use.</p>
2085
+ * @public
2086
2086
  */
2087
2087
  export declare class InvalidBlockerDeclarationException extends __BaseException {
2088
2088
  readonly name: "InvalidBlockerDeclarationException";
@@ -2093,8 +2093,8 @@ export declare class InvalidBlockerDeclarationException extends __BaseException
2093
2093
  constructor(opts: __ExceptionOptionType<InvalidBlockerDeclarationException, __BaseException>);
2094
2094
  }
2095
2095
  /**
2096
- * @public
2097
2096
  * <p>The stage declaration was specified in an invalid format.</p>
2097
+ * @public
2098
2098
  */
2099
2099
  export declare class InvalidStageDeclarationException extends __BaseException {
2100
2100
  readonly name: "InvalidStageDeclarationException";
@@ -2105,8 +2105,8 @@ export declare class InvalidStageDeclarationException extends __BaseException {
2105
2105
  constructor(opts: __ExceptionOptionType<InvalidStageDeclarationException, __BaseException>);
2106
2106
  }
2107
2107
  /**
2108
- * @public
2109
2108
  * <p>The structure was specified in an invalid format.</p>
2109
+ * @public
2110
2110
  */
2111
2111
  export declare class InvalidStructureException extends __BaseException {
2112
2112
  readonly name: "InvalidStructureException";
@@ -2117,8 +2117,8 @@ export declare class InvalidStructureException extends __BaseException {
2117
2117
  constructor(opts: __ExceptionOptionType<InvalidStructureException, __BaseException>);
2118
2118
  }
2119
2119
  /**
2120
- * @public
2121
2120
  * <p>The specified pipeline name is already in use.</p>
2121
+ * @public
2122
2122
  */
2123
2123
  export declare class PipelineNameInUseException extends __BaseException {
2124
2124
  readonly name: "PipelineNameInUseException";
@@ -2129,37 +2129,37 @@ export declare class PipelineNameInUseException extends __BaseException {
2129
2129
  constructor(opts: __ExceptionOptionType<PipelineNameInUseException, __BaseException>);
2130
2130
  }
2131
2131
  /**
2132
- * @public
2133
2132
  * <p>Represents the input of a <code>DeleteCustomActionType</code> operation. The custom
2134
2133
  * action will be marked as deleted.</p>
2134
+ * @public
2135
2135
  */
2136
2136
  export interface DeleteCustomActionTypeInput {
2137
2137
  /**
2138
- * @public
2139
2138
  * <p>The category of the custom action that you want to delete, such as source or
2140
2139
  * deploy.</p>
2140
+ * @public
2141
2141
  */
2142
2142
  category: ActionCategory | undefined;
2143
2143
  /**
2144
- * @public
2145
2144
  * <p>The provider of the service used in the custom action, such as
2146
2145
  * CodeDeploy.</p>
2146
+ * @public
2147
2147
  */
2148
2148
  provider: string | undefined;
2149
2149
  /**
2150
- * @public
2151
2150
  * <p>The version of the custom action to delete.</p>
2151
+ * @public
2152
2152
  */
2153
2153
  version: string | undefined;
2154
2154
  }
2155
2155
  /**
2156
- * @public
2157
2156
  * <p>Represents the input of a <code>DeletePipeline</code> action.</p>
2157
+ * @public
2158
2158
  */
2159
2159
  export interface DeletePipelineInput {
2160
2160
  /**
2161
- * @public
2162
2161
  * <p>The name of the pipeline to be deleted.</p>
2162
+ * @public
2163
2163
  */
2164
2164
  name: string | undefined;
2165
2165
  }
@@ -2168,8 +2168,8 @@ export interface DeletePipelineInput {
2168
2168
  */
2169
2169
  export interface DeleteWebhookInput {
2170
2170
  /**
2171
- * @public
2172
2171
  * <p>The name of the webhook you want to delete.</p>
2172
+ * @public
2173
2173
  */
2174
2174
  name: string | undefined;
2175
2175
  }
@@ -2183,8 +2183,8 @@ export interface DeleteWebhookOutput {
2183
2183
  */
2184
2184
  export interface DeregisterWebhookWithThirdPartyInput {
2185
2185
  /**
2186
- * @public
2187
2186
  * <p>The name of the webhook you want to deregister.</p>
2187
+ * @public
2188
2188
  */
2189
2189
  webhookName?: string;
2190
2190
  }
@@ -2194,9 +2194,9 @@ export interface DeregisterWebhookWithThirdPartyInput {
2194
2194
  export interface DeregisterWebhookWithThirdPartyOutput {
2195
2195
  }
2196
2196
  /**
2197
- * @public
2198
2197
  * <p>The specified webhook was entered in an invalid format or cannot be
2199
2198
  * found.</p>
2199
+ * @public
2200
2200
  */
2201
2201
  export declare class WebhookNotFoundException extends __BaseException {
2202
2202
  readonly name: "WebhookNotFoundException";
@@ -2219,41 +2219,41 @@ export declare const StageTransitionType: {
2219
2219
  */
2220
2220
  export type StageTransitionType = (typeof StageTransitionType)[keyof typeof StageTransitionType];
2221
2221
  /**
2222
- * @public
2223
2222
  * <p>Represents the input of a <code>DisableStageTransition</code> action.</p>
2223
+ * @public
2224
2224
  */
2225
2225
  export interface DisableStageTransitionInput {
2226
2226
  /**
2227
- * @public
2228
2227
  * <p>The name of the pipeline in which you want to disable the flow of artifacts from
2229
2228
  * one stage to another.</p>
2229
+ * @public
2230
2230
  */
2231
2231
  pipelineName: string | undefined;
2232
2232
  /**
2233
- * @public
2234
2233
  * <p>The name of the stage where you want to disable the inbound or outbound transition
2235
2234
  * of artifacts.</p>
2235
+ * @public
2236
2236
  */
2237
2237
  stageName: string | undefined;
2238
2238
  /**
2239
- * @public
2240
2239
  * <p>Specifies whether artifacts are prevented from transitioning into the stage and
2241
2240
  * being processed by the actions in that stage (inbound), or prevented from transitioning
2242
2241
  * from the stage after they have been processed by the actions in that stage
2243
2242
  * (outbound).</p>
2243
+ * @public
2244
2244
  */
2245
2245
  transitionType: StageTransitionType | undefined;
2246
2246
  /**
2247
- * @public
2248
2247
  * <p>The reason given to the user that a stage is disabled, such as waiting for manual
2249
2248
  * approval or manual tests. This message is displayed in the pipeline console
2250
2249
  * UI.</p>
2250
+ * @public
2251
2251
  */
2252
2252
  reason: string | undefined;
2253
2253
  }
2254
2254
  /**
2255
- * @public
2256
2255
  * <p>The pipeline was specified in an invalid format or cannot be found.</p>
2256
+ * @public
2257
2257
  */
2258
2258
  export declare class PipelineNotFoundException extends __BaseException {
2259
2259
  readonly name: "PipelineNotFoundException";
@@ -2264,8 +2264,8 @@ export declare class PipelineNotFoundException extends __BaseException {
2264
2264
  constructor(opts: __ExceptionOptionType<PipelineNotFoundException, __BaseException>);
2265
2265
  }
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>The stage was specified in an invalid format or cannot be found.</p>
2268
+ * @public
2269
2269
  */
2270
2270
  export declare class StageNotFoundException extends __BaseException {
2271
2271
  readonly name: "StageNotFoundException";
@@ -2276,27 +2276,27 @@ export declare class StageNotFoundException extends __BaseException {
2276
2276
  constructor(opts: __ExceptionOptionType<StageNotFoundException, __BaseException>);
2277
2277
  }
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>Represents the input of an <code>EnableStageTransition</code> action.</p>
2280
+ * @public
2281
2281
  */
2282
2282
  export interface EnableStageTransitionInput {
2283
2283
  /**
2284
- * @public
2285
2284
  * <p>The name of the pipeline in which you want to enable the flow of artifacts from one
2286
2285
  * stage to another.</p>
2286
+ * @public
2287
2287
  */
2288
2288
  pipelineName: string | undefined;
2289
2289
  /**
2290
- * @public
2291
2290
  * <p>The name of the stage where you want to enable the transition of artifacts, either
2292
2291
  * into the stage (inbound) or from that stage to the next stage (outbound).</p>
2292
+ * @public
2293
2293
  */
2294
2294
  stageName: string | undefined;
2295
2295
  /**
2296
- * @public
2297
2296
  * <p>Specifies whether artifacts are allowed to enter the stage and be processed by the
2298
2297
  * actions in that stage (inbound) or whether already processed artifacts are allowed to
2299
2298
  * transition to the next stage (outbound).</p>
2299
+ * @public
2300
2300
  */
2301
2301
  transitionType: StageTransitionType | undefined;
2302
2302
  }
@@ -2305,7 +2305,6 @@ export interface EnableStageTransitionInput {
2305
2305
  */
2306
2306
  export interface GetActionTypeInput {
2307
2307
  /**
2308
- * @public
2309
2308
  * <p>Defines what kind of action can be taken in the stage. The following are the valid
2310
2309
  * values:</p>
2311
2310
  * <ul>
@@ -2340,23 +2339,24 @@ export interface GetActionTypeInput {
2340
2339
  * </p>
2341
2340
  * </li>
2342
2341
  * </ul>
2342
+ * @public
2343
2343
  */
2344
2344
  category: ActionCategory | undefined;
2345
2345
  /**
2346
- * @public
2347
2346
  * <p>The creator of an action type that was created with any supported integration model.
2348
2347
  * There are two valid values: <code>AWS</code> and <code>ThirdParty</code>.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  owner: string | undefined;
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>The provider of the action type being called. The provider name is specified when the
2354
2353
  * action type is created.</p>
2354
+ * @public
2355
2355
  */
2356
2356
  provider: string | undefined;
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>A string that describes the action type version.</p>
2359
+ * @public
2360
2360
  */
2361
2361
  version: string | undefined;
2362
2362
  }
@@ -2365,36 +2365,35 @@ export interface GetActionTypeInput {
2365
2365
  */
2366
2366
  export interface GetActionTypeOutput {
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>The action type information for the requested action type, such as the action type
2370
2369
  * ID.</p>
2370
+ * @public
2371
2371
  */
2372
2372
  actionType?: ActionTypeDeclaration;
2373
2373
  }
2374
2374
  /**
2375
- * @public
2376
2375
  * <p>Represents the input of a <code>GetJobDetails</code> action.</p>
2376
+ * @public
2377
2377
  */
2378
2378
  export interface GetJobDetailsInput {
2379
2379
  /**
2380
- * @public
2381
2380
  * <p>The unique system-generated ID for the job.</p>
2381
+ * @public
2382
2382
  */
2383
2383
  jobId: string | undefined;
2384
2384
  }
2385
2385
  /**
2386
- * @public
2387
2386
  * <p>Represents information about a stage to a job worker.</p>
2387
+ * @public
2388
2388
  */
2389
2389
  export interface StageContext {
2390
2390
  /**
2391
- * @public
2392
2391
  * <p>The name of the stage.</p>
2392
+ * @public
2393
2393
  */
2394
2394
  name?: string;
2395
2395
  }
2396
2396
  /**
2397
- * @public
2398
2397
  * <p>Represents information about a pipeline to a job worker.</p>
2399
2398
  * <note>
2400
2399
  * <p>PipelineContext contains <code>pipelineArn</code> and
@@ -2402,168 +2401,168 @@ export interface StageContext {
2402
2401
  * <code>pipelineArn</code> and <code>pipelineExecutionId</code> fields are not
2403
2402
  * populated for ThirdParty action jobs.</p>
2404
2403
  * </note>
2404
+ * @public
2405
2405
  */
2406
2406
  export interface PipelineContext {
2407
2407
  /**
2408
- * @public
2409
2408
  * <p>The name of the pipeline. This is a user-specified value. Pipeline names must be
2410
2409
  * unique across all pipeline names under an Amazon Web Services account.</p>
2410
+ * @public
2411
2411
  */
2412
2412
  pipelineName?: string;
2413
2413
  /**
2414
- * @public
2415
2414
  * <p>The stage of the pipeline.</p>
2415
+ * @public
2416
2416
  */
2417
2417
  stage?: StageContext;
2418
2418
  /**
2419
- * @public
2420
2419
  * <p>The context of an action to a job worker in the stage of a pipeline.</p>
2420
+ * @public
2421
2421
  */
2422
2422
  action?: ActionContext;
2423
2423
  /**
2424
- * @public
2425
2424
  * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
2425
+ * @public
2426
2426
  */
2427
2427
  pipelineArn?: string;
2428
2428
  /**
2429
- * @public
2430
2429
  * <p>The execution ID of the pipeline.</p>
2430
+ * @public
2431
2431
  */
2432
2432
  pipelineExecutionId?: string;
2433
2433
  }
2434
2434
  /**
2435
- * @public
2436
2435
  * <p>Represents other information about a job required for a job worker to complete the
2437
2436
  * job.</p>
2437
+ * @public
2438
2438
  */
2439
2439
  export interface JobData {
2440
2440
  /**
2441
- * @public
2442
2441
  * <p>Represents information about an action type.</p>
2442
+ * @public
2443
2443
  */
2444
2444
  actionTypeId?: ActionTypeId;
2445
2445
  /**
2446
- * @public
2447
2446
  * <p>Represents information about an action configuration.</p>
2447
+ * @public
2448
2448
  */
2449
2449
  actionConfiguration?: ActionConfiguration;
2450
2450
  /**
2451
- * @public
2452
2451
  * <p>Represents information about a pipeline to a job worker.</p>
2453
2452
  * <note>
2454
2453
  * <p>Includes <code>pipelineArn</code> and <code>pipelineExecutionId</code> for
2455
2454
  * custom jobs.</p>
2456
2455
  * </note>
2456
+ * @public
2457
2457
  */
2458
2458
  pipelineContext?: PipelineContext;
2459
2459
  /**
2460
- * @public
2461
2460
  * <p>The artifact supplied to the job.</p>
2461
+ * @public
2462
2462
  */
2463
2463
  inputArtifacts?: Artifact[];
2464
2464
  /**
2465
- * @public
2466
2465
  * <p>The output of the job.</p>
2466
+ * @public
2467
2467
  */
2468
2468
  outputArtifacts?: Artifact[];
2469
2469
  /**
2470
- * @public
2471
2470
  * <p>Represents an Amazon Web Services session credentials object. These credentials are
2472
2471
  * temporary credentials that are issued by Amazon Web Services Secure Token Service (STS).
2473
2472
  * They can be used to access input and output artifacts in the S3 bucket used to store
2474
2473
  * artifacts for the pipeline in CodePipeline.</p>
2474
+ * @public
2475
2475
  */
2476
2476
  artifactCredentials?: AWSSessionCredentials;
2477
2477
  /**
2478
- * @public
2479
2478
  * <p>A system-generated token, such as a deployment ID, required by a job to continue
2480
2479
  * the job asynchronously.</p>
2480
+ * @public
2481
2481
  */
2482
2482
  continuationToken?: string;
2483
2483
  /**
2484
- * @public
2485
2484
  * <p>Represents information about the key used to encrypt data in the artifact store,
2486
2485
  * such as an KMS key. </p>
2486
+ * @public
2487
2487
  */
2488
2488
  encryptionKey?: EncryptionKey;
2489
2489
  }
2490
2490
  /**
2491
- * @public
2492
2491
  * <p>Represents information about the details of a job.</p>
2492
+ * @public
2493
2493
  */
2494
2494
  export interface JobDetails {
2495
2495
  /**
2496
- * @public
2497
2496
  * <p>The unique system-generated ID of the job.</p>
2497
+ * @public
2498
2498
  */
2499
2499
  id?: string;
2500
2500
  /**
2501
- * @public
2502
2501
  * <p>Represents other information about a job required for a job worker to complete the
2503
2502
  * job. </p>
2503
+ * @public
2504
2504
  */
2505
2505
  data?: JobData;
2506
2506
  /**
2507
- * @public
2508
2507
  * <p>The Amazon Web Services account ID associated with the job.</p>
2508
+ * @public
2509
2509
  */
2510
2510
  accountId?: string;
2511
2511
  }
2512
2512
  /**
2513
- * @public
2514
2513
  * <p>Represents the output of a <code>GetJobDetails</code> action.</p>
2514
+ * @public
2515
2515
  */
2516
2516
  export interface GetJobDetailsOutput {
2517
2517
  /**
2518
- * @public
2519
2518
  * <p>The details of the job.</p>
2520
2519
  * <note>
2521
2520
  * <p>If AWSSessionCredentials is used, a long-running job can call
2522
2521
  * <code>GetJobDetails</code> again to obtain new credentials.</p>
2523
2522
  * </note>
2523
+ * @public
2524
2524
  */
2525
2525
  jobDetails?: JobDetails;
2526
2526
  }
2527
2527
  /**
2528
- * @public
2529
2528
  * <p>Represents the input of a <code>GetPipeline</code> action.</p>
2529
+ * @public
2530
2530
  */
2531
2531
  export interface GetPipelineInput {
2532
2532
  /**
2533
- * @public
2534
2533
  * <p>The name of the pipeline for which you want to get information. Pipeline names must
2535
2534
  * be unique in an Amazon Web Services account.</p>
2535
+ * @public
2536
2536
  */
2537
2537
  name: string | undefined;
2538
2538
  /**
2539
- * @public
2540
2539
  * <p>The version number of the pipeline. If you do not specify a version, defaults to
2541
2540
  * the current version.</p>
2541
+ * @public
2542
2542
  */
2543
2543
  version?: number;
2544
2544
  }
2545
2545
  /**
2546
- * @public
2547
2546
  * <p>Information about a pipeline.</p>
2547
+ * @public
2548
2548
  */
2549
2549
  export interface PipelineMetadata {
2550
2550
  /**
2551
- * @public
2552
2551
  * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
2552
+ * @public
2553
2553
  */
2554
2554
  pipelineArn?: string;
2555
2555
  /**
2556
- * @public
2557
2556
  * <p>The date and time the pipeline was created, in timestamp format.</p>
2557
+ * @public
2558
2558
  */
2559
2559
  created?: Date;
2560
2560
  /**
2561
- * @public
2562
2561
  * <p>The date and time the pipeline was last updated, in timestamp format.</p>
2562
+ * @public
2563
2563
  */
2564
2564
  updated?: Date;
2565
2565
  /**
2566
- * @public
2567
2566
  * <p>The date and time that polling for source changes (periodic checks) was stopped for
2568
2567
  * the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use
2569
2568
  * event-based change detection. For example, for a pipeline with a CodeCommit
@@ -2571,31 +2570,32 @@ export interface PipelineMetadata {
2571
2570
  * learn more, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html">Migrate polling
2572
2571
  * pipelines to use event-based change detection</a> in the CodePipeline
2573
2572
  * User Guide.</p>
2573
+ * @public
2574
2574
  */
2575
2575
  pollingDisabledAt?: Date;
2576
2576
  }
2577
2577
  /**
2578
- * @public
2579
2578
  * <p>Represents the output of a <code>GetPipeline</code> action.</p>
2579
+ * @public
2580
2580
  */
2581
2581
  export interface GetPipelineOutput {
2582
2582
  /**
2583
- * @public
2584
2583
  * <p>Represents the structure of actions and stages to be performed in the pipeline.
2585
2584
  * </p>
2585
+ * @public
2586
2586
  */
2587
2587
  pipeline?: PipelineDeclaration;
2588
2588
  /**
2589
- * @public
2590
2589
  * <p>Represents the pipeline metadata information returned as part of the output of a
2591
2590
  * <code>GetPipeline</code> action.</p>
2591
+ * @public
2592
2592
  */
2593
2593
  metadata?: PipelineMetadata;
2594
2594
  }
2595
2595
  /**
2596
- * @public
2597
2596
  * <p>The pipeline version was specified in an invalid format or cannot be
2598
2597
  * found.</p>
2598
+ * @public
2599
2599
  */
2600
2600
  export declare class PipelineVersionNotFoundException extends __BaseException {
2601
2601
  readonly name: "PipelineVersionNotFoundException";
@@ -2606,19 +2606,19 @@ export declare class PipelineVersionNotFoundException extends __BaseException {
2606
2606
  constructor(opts: __ExceptionOptionType<PipelineVersionNotFoundException, __BaseException>);
2607
2607
  }
2608
2608
  /**
2609
- * @public
2610
2609
  * <p>Represents the input of a <code>GetPipelineExecution</code> action.</p>
2610
+ * @public
2611
2611
  */
2612
2612
  export interface GetPipelineExecutionInput {
2613
2613
  /**
2614
- * @public
2615
2614
  * <p>The name of the pipeline about which you want to get execution details.</p>
2615
+ * @public
2616
2616
  */
2617
2617
  pipelineName: string | undefined;
2618
2618
  /**
2619
- * @public
2620
2619
  * <p>The ID of the pipeline execution about which you want to get execution
2621
2620
  * details.</p>
2621
+ * @public
2622
2622
  */
2623
2623
  pipelineExecutionId: string | undefined;
2624
2624
  }
@@ -2657,62 +2657,61 @@ export declare const TriggerType: {
2657
2657
  */
2658
2658
  export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType];
2659
2659
  /**
2660
- * @public
2661
2660
  * <p>The interaction or event that started a pipeline execution.</p>
2661
+ * @public
2662
2662
  */
2663
2663
  export interface ExecutionTrigger {
2664
2664
  /**
2665
- * @public
2666
2665
  * <p>The type of change-detection method, command, or user interaction that started a
2667
2666
  * pipeline execution.</p>
2667
+ * @public
2668
2668
  */
2669
2669
  triggerType?: TriggerType;
2670
2670
  /**
2671
- * @public
2672
2671
  * <p>Detail related to the event that started a pipeline execution, such as the webhook ARN
2673
2672
  * of the webhook that triggered the pipeline execution or the user ARN for a
2674
2673
  * user-initiated <code>start-pipeline-execution</code> CLI command.</p>
2674
+ * @public
2675
2675
  */
2676
2676
  triggerDetail?: string;
2677
2677
  }
2678
2678
  /**
2679
- * @public
2680
2679
  * <p>A pipeline-level variable used for a pipeline execution.</p>
2680
+ * @public
2681
2681
  */
2682
2682
  export interface ResolvedPipelineVariable {
2683
2683
  /**
2684
- * @public
2685
2684
  * <p>The name of a pipeline-level variable.</p>
2685
+ * @public
2686
2686
  */
2687
2687
  name?: string;
2688
2688
  /**
2689
- * @public
2690
2689
  * <p>The resolved value of a pipeline-level variable.</p>
2690
+ * @public
2691
2691
  */
2692
2692
  resolvedValue?: string;
2693
2693
  }
2694
2694
  /**
2695
- * @public
2696
2695
  * <p>Represents information about an execution of a pipeline.</p>
2696
+ * @public
2697
2697
  */
2698
2698
  export interface PipelineExecution {
2699
2699
  /**
2700
- * @public
2701
2700
  * <p>The name of the pipeline with the specified pipeline execution.</p>
2701
+ * @public
2702
2702
  */
2703
2703
  pipelineName?: string;
2704
2704
  /**
2705
- * @public
2706
2705
  * <p>The version number of the pipeline with the specified pipeline execution.</p>
2706
+ * @public
2707
2707
  */
2708
2708
  pipelineVersion?: number;
2709
2709
  /**
2710
- * @public
2711
2710
  * <p>The ID of the pipeline execution.</p>
2711
+ * @public
2712
2712
  */
2713
2713
  pipelineExecutionId?: string;
2714
2714
  /**
2715
- * @public
2716
2715
  * <p>The status of the pipeline execution.</p>
2717
2716
  * <ul>
2718
2717
  * <li>
@@ -2743,51 +2742,52 @@ export interface PipelineExecution {
2743
2742
  * <p>Failed: The pipeline execution was not completed successfully.</p>
2744
2743
  * </li>
2745
2744
  * </ul>
2745
+ * @public
2746
2746
  */
2747
2747
  status?: PipelineExecutionStatus;
2748
2748
  /**
2749
- * @public
2750
2749
  * <p>A summary that contains a description of the pipeline execution status.</p>
2750
+ * @public
2751
2751
  */
2752
2752
  statusSummary?: string;
2753
2753
  /**
2754
- * @public
2755
2754
  * <p>A list of <code>ArtifactRevision</code> objects included in a pipeline
2756
2755
  * execution.</p>
2756
+ * @public
2757
2757
  */
2758
2758
  artifactRevisions?: ArtifactRevision[];
2759
2759
  /**
2760
- * @public
2761
2760
  * <p>A list of pipeline variables used for the pipeline execution.</p>
2761
+ * @public
2762
2762
  */
2763
2763
  variables?: ResolvedPipelineVariable[];
2764
2764
  /**
2765
- * @public
2766
2765
  * <p>The interaction or event that started a pipeline execution.</p>
2766
+ * @public
2767
2767
  */
2768
2768
  trigger?: ExecutionTrigger;
2769
2769
  /**
2770
- * @public
2771
2770
  * <p>The method that the pipeline will use to handle multiple executions. The default
2772
2771
  * mode is SUPERSEDED.</p>
2772
+ * @public
2773
2773
  */
2774
2774
  executionMode?: ExecutionMode;
2775
2775
  }
2776
2776
  /**
2777
- * @public
2778
2777
  * <p>Represents the output of a <code>GetPipelineExecution</code> action.</p>
2778
+ * @public
2779
2779
  */
2780
2780
  export interface GetPipelineExecutionOutput {
2781
2781
  /**
2782
- * @public
2783
2782
  * <p>Represents information about the execution of a pipeline.</p>
2783
+ * @public
2784
2784
  */
2785
2785
  pipelineExecution?: PipelineExecution;
2786
2786
  }
2787
2787
  /**
2788
- * @public
2789
2788
  * <p>The pipeline execution was specified in an invalid format or cannot be found, or an
2790
2789
  * execution ID does not belong to the specified pipeline. </p>
2790
+ * @public
2791
2791
  */
2792
2792
  export declare class PipelineExecutionNotFoundException extends __BaseException {
2793
2793
  readonly name: "PipelineExecutionNotFoundException";
@@ -2798,13 +2798,13 @@ export declare class PipelineExecutionNotFoundException extends __BaseException
2798
2798
  constructor(opts: __ExceptionOptionType<PipelineExecutionNotFoundException, __BaseException>);
2799
2799
  }
2800
2800
  /**
2801
- * @public
2802
2801
  * <p>Represents the input of a <code>GetPipelineState</code> action.</p>
2802
+ * @public
2803
2803
  */
2804
2804
  export interface GetPipelineStateInput {
2805
2805
  /**
2806
- * @public
2807
2806
  * <p>The name of the pipeline about which you want to get information.</p>
2807
+ * @public
2808
2808
  */
2809
2809
  name: string | undefined;
2810
2810
  }
@@ -2825,244 +2825,244 @@ export declare const StageExecutionStatus: {
2825
2825
  */
2826
2826
  export type StageExecutionStatus = (typeof StageExecutionStatus)[keyof typeof StageExecutionStatus];
2827
2827
  /**
2828
- * @public
2829
2828
  * <p>Represents information about the run of a stage.</p>
2829
+ * @public
2830
2830
  */
2831
2831
  export interface StageExecution {
2832
2832
  /**
2833
- * @public
2834
2833
  * <p>The ID of the pipeline execution associated with the stage.</p>
2834
+ * @public
2835
2835
  */
2836
2836
  pipelineExecutionId: string | undefined;
2837
2837
  /**
2838
- * @public
2839
2838
  * <p>The status of the stage, or for a completed stage, the last status of the
2840
2839
  * stage.</p>
2841
2840
  * <note>
2842
2841
  * <p>A status of cancelled means that the pipeline’s definition was updated before the
2843
2842
  * stage execution could be completed.</p>
2844
2843
  * </note>
2844
+ * @public
2845
2845
  */
2846
2846
  status: StageExecutionStatus | undefined;
2847
2847
  }
2848
2848
  /**
2849
- * @public
2850
2849
  * <p>Represents information about the state of transitions between one stage and another
2851
2850
  * stage.</p>
2851
+ * @public
2852
2852
  */
2853
2853
  export interface TransitionState {
2854
2854
  /**
2855
- * @public
2856
2855
  * <p>Whether the transition between stages is enabled (true) or disabled
2857
2856
  * (false).</p>
2857
+ * @public
2858
2858
  */
2859
2859
  enabled?: boolean;
2860
2860
  /**
2861
- * @public
2862
2861
  * <p>The ID of the user who last changed the transition state.</p>
2862
+ * @public
2863
2863
  */
2864
2864
  lastChangedBy?: string;
2865
2865
  /**
2866
- * @public
2867
2866
  * <p>The timestamp when the transition state was last changed.</p>
2867
+ * @public
2868
2868
  */
2869
2869
  lastChangedAt?: Date;
2870
2870
  /**
2871
- * @public
2872
2871
  * <p>The user-specified reason why the transition between two stages of a pipeline was
2873
2872
  * disabled.</p>
2873
+ * @public
2874
2874
  */
2875
2875
  disabledReason?: string;
2876
2876
  }
2877
2877
  /**
2878
- * @public
2879
2878
  * <p>Represents information about the state of the stage.</p>
2879
+ * @public
2880
2880
  */
2881
2881
  export interface StageState {
2882
2882
  /**
2883
- * @public
2884
2883
  * <p>The name of the stage.</p>
2884
+ * @public
2885
2885
  */
2886
2886
  stageName?: string;
2887
2887
  /**
2888
- * @public
2889
2888
  * <p>Represents information about the run of a stage.</p>
2889
+ * @public
2890
2890
  */
2891
2891
  inboundExecution?: StageExecution;
2892
2892
  /**
2893
- * @public
2894
2893
  * <p>The inbound executions for a stage.</p>
2894
+ * @public
2895
2895
  */
2896
2896
  inboundExecutions?: StageExecution[];
2897
2897
  /**
2898
- * @public
2899
2898
  * <p>The state of the inbound transition, which is either enabled or disabled.</p>
2899
+ * @public
2900
2900
  */
2901
2901
  inboundTransitionState?: TransitionState;
2902
2902
  /**
2903
- * @public
2904
2903
  * <p>The state of the stage.</p>
2904
+ * @public
2905
2905
  */
2906
2906
  actionStates?: ActionState[];
2907
2907
  /**
2908
- * @public
2909
2908
  * <p>Information about the latest execution in the stage, including its ID and
2910
2909
  * status.</p>
2910
+ * @public
2911
2911
  */
2912
2912
  latestExecution?: StageExecution;
2913
2913
  }
2914
2914
  /**
2915
- * @public
2916
2915
  * <p>Represents the output of a <code>GetPipelineState</code> action.</p>
2916
+ * @public
2917
2917
  */
2918
2918
  export interface GetPipelineStateOutput {
2919
2919
  /**
2920
- * @public
2921
2920
  * <p>The name of the pipeline for which you want to get the state.</p>
2921
+ * @public
2922
2922
  */
2923
2923
  pipelineName?: string;
2924
2924
  /**
2925
- * @public
2926
2925
  * <p>The version number of the pipeline.</p>
2927
2926
  * <note>
2928
2927
  * <p>A newly created pipeline is always assigned a version number of
2929
2928
  * <code>1</code>.</p>
2930
2929
  * </note>
2930
+ * @public
2931
2931
  */
2932
2932
  pipelineVersion?: number;
2933
2933
  /**
2934
- * @public
2935
2934
  * <p>A list of the pipeline stage output information, including stage name, state, most
2936
2935
  * recent run details, whether the stage is disabled, and other data.</p>
2936
+ * @public
2937
2937
  */
2938
2938
  stageStates?: StageState[];
2939
2939
  /**
2940
- * @public
2941
2940
  * <p>The date and time the pipeline was created, in timestamp format.</p>
2941
+ * @public
2942
2942
  */
2943
2943
  created?: Date;
2944
2944
  /**
2945
- * @public
2946
2945
  * <p>The date and time the pipeline was last updated, in timestamp format.</p>
2946
+ * @public
2947
2947
  */
2948
2948
  updated?: Date;
2949
2949
  }
2950
2950
  /**
2951
- * @public
2952
2951
  * <p>Represents the input of a <code>GetThirdPartyJobDetails</code> action.</p>
2952
+ * @public
2953
2953
  */
2954
2954
  export interface GetThirdPartyJobDetailsInput {
2955
2955
  /**
2956
- * @public
2957
2956
  * <p>The unique system-generated ID used for identifying the job.</p>
2957
+ * @public
2958
2958
  */
2959
2959
  jobId: string | undefined;
2960
2960
  /**
2961
- * @public
2962
2961
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
2963
2962
  * the calling entity is allowed access to the job and its details.</p>
2963
+ * @public
2964
2964
  */
2965
2965
  clientToken: string | undefined;
2966
2966
  }
2967
2967
  /**
2968
- * @public
2969
2968
  * <p>Represents information about the job data for a partner action.</p>
2969
+ * @public
2970
2970
  */
2971
2971
  export interface ThirdPartyJobData {
2972
2972
  /**
2973
- * @public
2974
2973
  * <p>Represents information about an action type.</p>
2974
+ * @public
2975
2975
  */
2976
2976
  actionTypeId?: ActionTypeId;
2977
2977
  /**
2978
- * @public
2979
2978
  * <p>Represents information about an action configuration.</p>
2979
+ * @public
2980
2980
  */
2981
2981
  actionConfiguration?: ActionConfiguration;
2982
2982
  /**
2983
- * @public
2984
2983
  * <p>Represents information about a pipeline to a job worker.</p>
2985
2984
  * <note>
2986
2985
  * <p>Does not include <code>pipelineArn</code> and <code>pipelineExecutionId</code>
2987
2986
  * for ThirdParty jobs.</p>
2988
2987
  * </note>
2988
+ * @public
2989
2989
  */
2990
2990
  pipelineContext?: PipelineContext;
2991
2991
  /**
2992
- * @public
2993
2992
  * <p>The name of the artifact that is worked on by the action, if any. This name might
2994
2993
  * be system-generated, such as "MyApp", or it might be defined by the user when the action
2995
2994
  * is created. The input artifact name must match the name of an output artifact generated
2996
2995
  * by an action in an earlier action or stage of the pipeline.</p>
2996
+ * @public
2997
2997
  */
2998
2998
  inputArtifacts?: Artifact[];
2999
2999
  /**
3000
- * @public
3001
3000
  * <p>The name of the artifact that is the result of the action, if any. This name might
3002
3001
  * be system-generated, such as "MyBuiltApp", or it might be defined by the user when the
3003
3002
  * action is created.</p>
3003
+ * @public
3004
3004
  */
3005
3005
  outputArtifacts?: Artifact[];
3006
3006
  /**
3007
- * @public
3008
3007
  * <p>Represents an Amazon Web Services session credentials object. These credentials are
3009
3008
  * temporary credentials that are issued by Amazon Web Services Secure Token Service (STS).
3010
3009
  * They can be used to access input and output artifacts in the S3 bucket used to store
3011
3010
  * artifact for the pipeline in CodePipeline. </p>
3011
+ * @public
3012
3012
  */
3013
3013
  artifactCredentials?: AWSSessionCredentials;
3014
3014
  /**
3015
- * @public
3016
3015
  * <p>A system-generated token, such as a CodeDeploy deployment ID, that a job requires
3017
3016
  * to continue the job asynchronously.</p>
3017
+ * @public
3018
3018
  */
3019
3019
  continuationToken?: string;
3020
3020
  /**
3021
- * @public
3022
3021
  * <p>The encryption key used to encrypt and decrypt data in the artifact store for the
3023
3022
  * pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS)
3024
3023
  * key. This is optional and might not be present.</p>
3024
+ * @public
3025
3025
  */
3026
3026
  encryptionKey?: EncryptionKey;
3027
3027
  }
3028
3028
  /**
3029
- * @public
3030
3029
  * <p>The details of a job sent in response to a <code>GetThirdPartyJobDetails</code>
3031
3030
  * request.</p>
3031
+ * @public
3032
3032
  */
3033
3033
  export interface ThirdPartyJobDetails {
3034
3034
  /**
3035
- * @public
3036
3035
  * <p>The identifier used to identify the job details in CodePipeline.</p>
3036
+ * @public
3037
3037
  */
3038
3038
  id?: string;
3039
3039
  /**
3040
- * @public
3041
3040
  * <p>The data to be returned by the third party job worker.</p>
3041
+ * @public
3042
3042
  */
3043
3043
  data?: ThirdPartyJobData;
3044
3044
  /**
3045
- * @public
3046
3045
  * <p>A system-generated random number that CodePipeline uses to ensure that the
3047
3046
  * job is being worked on by only one job worker. Use this number in an <a>AcknowledgeThirdPartyJob</a> request.</p>
3047
+ * @public
3048
3048
  */
3049
3049
  nonce?: string;
3050
3050
  }
3051
3051
  /**
3052
- * @public
3053
3052
  * <p>Represents the output of a <code>GetThirdPartyJobDetails</code> action.</p>
3053
+ * @public
3054
3054
  */
3055
3055
  export interface GetThirdPartyJobDetailsOutput {
3056
3056
  /**
3057
- * @public
3058
3057
  * <p>The details of the job, including any protected values defined for the
3059
3058
  * job.</p>
3059
+ * @public
3060
3060
  */
3061
3061
  jobDetails?: ThirdPartyJobDetails;
3062
3062
  }
3063
3063
  /**
3064
- * @public
3065
3064
  * <p>The job was specified in an invalid format or cannot be found.</p>
3065
+ * @public
3066
3066
  */
3067
3067
  export declare class InvalidJobException extends __BaseException {
3068
3068
  readonly name: "InvalidJobException";
@@ -3073,9 +3073,9 @@ export declare class InvalidJobException extends __BaseException {
3073
3073
  constructor(opts: __ExceptionOptionType<InvalidJobException, __BaseException>);
3074
3074
  }
3075
3075
  /**
3076
- * @public
3077
3076
  * <p>The next token was specified in an invalid format. Make sure that the next token
3078
3077
  * you provide is the token returned by a previous call.</p>
3078
+ * @public
3079
3079
  */
3080
3080
  export declare class InvalidNextTokenException extends __BaseException {
3081
3081
  readonly name: "InvalidNextTokenException";
@@ -3090,17 +3090,16 @@ export declare class InvalidNextTokenException extends __BaseException {
3090
3090
  */
3091
3091
  export interface ListActionExecutionsInput {
3092
3092
  /**
3093
- * @public
3094
3093
  * <p> The name of the pipeline for which you want to list action execution history.</p>
3094
+ * @public
3095
3095
  */
3096
3096
  pipelineName: string | undefined;
3097
3097
  /**
3098
- * @public
3099
3098
  * <p>Input information used to filter action execution history.</p>
3099
+ * @public
3100
3100
  */
3101
3101
  filter?: ActionExecutionFilter;
3102
3102
  /**
3103
- * @public
3104
3103
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
3105
3104
  * results, make another call with the returned nextToken value. Action execution history
3106
3105
  * is retained for up to 12 months, based on action execution start times. Default value is
@@ -3109,12 +3108,13 @@ export interface ListActionExecutionsInput {
3109
3108
  * <p>Detailed execution history is available for executions run on or after February
3110
3109
  * 21, 2019.</p>
3111
3110
  * </note>
3111
+ * @public
3112
3112
  */
3113
3113
  maxResults?: number;
3114
3114
  /**
3115
- * @public
3116
3115
  * <p>The token that was returned from the previous <code>ListActionExecutions</code> call,
3117
3116
  * which can be used to return the next set of action executions in the list.</p>
3117
+ * @public
3118
3118
  */
3119
3119
  nextToken?: string;
3120
3120
  }
@@ -3123,141 +3123,140 @@ export interface ListActionExecutionsInput {
3123
3123
  */
3124
3124
  export interface ListActionExecutionsOutput {
3125
3125
  /**
3126
- * @public
3127
3126
  * <p>The details for a list of recent executions, such as action execution ID.</p>
3127
+ * @public
3128
3128
  */
3129
3129
  actionExecutionDetails?: ActionExecutionDetail[];
3130
3130
  /**
3131
- * @public
3132
3131
  * <p>If the amount of returned information is significantly large, an identifier is also
3133
3132
  * returned and can be used in a subsequent <code>ListActionExecutions</code> call to
3134
3133
  * return the next set of action executions in the list.</p>
3134
+ * @public
3135
3135
  */
3136
3136
  nextToken?: string;
3137
3137
  }
3138
3138
  /**
3139
- * @public
3140
3139
  * <p>Represents the input of a <code>ListActionTypes</code> action.</p>
3140
+ * @public
3141
3141
  */
3142
3142
  export interface ListActionTypesInput {
3143
3143
  /**
3144
- * @public
3145
3144
  * <p>Filters the list of action types to those created by a specified entity.</p>
3145
+ * @public
3146
3146
  */
3147
3147
  actionOwnerFilter?: ActionOwner;
3148
3148
  /**
3149
- * @public
3150
3149
  * <p>An identifier that was returned from the previous list action types call, which can
3151
3150
  * be used to return the next set of action types in the list.</p>
3151
+ * @public
3152
3152
  */
3153
3153
  nextToken?: string;
3154
3154
  /**
3155
- * @public
3156
3155
  * <p>The Region to filter on for the list of action types.</p>
3156
+ * @public
3157
3157
  */
3158
3158
  regionFilter?: string;
3159
3159
  }
3160
3160
  /**
3161
- * @public
3162
3161
  * <p>Represents the output of a <code>ListActionTypes</code> action.</p>
3162
+ * @public
3163
3163
  */
3164
3164
  export interface ListActionTypesOutput {
3165
3165
  /**
3166
- * @public
3167
3166
  * <p>Provides details of the action types.</p>
3167
+ * @public
3168
3168
  */
3169
3169
  actionTypes: ActionType[] | undefined;
3170
3170
  /**
3171
- * @public
3172
3171
  * <p>If the amount of returned information is significantly large, an identifier is also
3173
3172
  * returned. It can be used in a subsequent list action types call to return the next set
3174
3173
  * of action types in the list.</p>
3174
+ * @public
3175
3175
  */
3176
3176
  nextToken?: string;
3177
3177
  }
3178
3178
  /**
3179
- * @public
3180
3179
  * <p>Represents the input of a <code>ListPipelineExecutions</code> action.</p>
3180
+ * @public
3181
3181
  */
3182
3182
  export interface ListPipelineExecutionsInput {
3183
3183
  /**
3184
- * @public
3185
3184
  * <p>The name of the pipeline for which you want to get execution summary
3186
3185
  * information.</p>
3186
+ * @public
3187
3187
  */
3188
3188
  pipelineName: string | undefined;
3189
3189
  /**
3190
- * @public
3191
3190
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
3192
3191
  * results, make another call with the returned nextToken value. Pipeline history is
3193
3192
  * limited to the most recent 12 months, based on pipeline execution start times. Default
3194
3193
  * value is 100.</p>
3194
+ * @public
3195
3195
  */
3196
3196
  maxResults?: number;
3197
3197
  /**
3198
- * @public
3199
3198
  * <p>The token that was returned from the previous <code>ListPipelineExecutions</code>
3200
3199
  * call, which can be used to return the next set of pipeline executions in the
3201
3200
  * list.</p>
3201
+ * @public
3202
3202
  */
3203
3203
  nextToken?: string;
3204
3204
  }
3205
3205
  /**
3206
- * @public
3207
3206
  * <p>Information about the version (or revision) of a source artifact that initiated a
3208
3207
  * pipeline execution.</p>
3208
+ * @public
3209
3209
  */
3210
3210
  export interface SourceRevision {
3211
3211
  /**
3212
- * @public
3213
3212
  * <p>The name of the action that processed the revision to the source
3214
3213
  * artifact.</p>
3214
+ * @public
3215
3215
  */
3216
3216
  actionName: string | undefined;
3217
3217
  /**
3218
- * @public
3219
3218
  * <p>The system-generated unique ID that identifies the revision number of the
3220
3219
  * artifact.</p>
3220
+ * @public
3221
3221
  */
3222
3222
  revisionId?: string;
3223
3223
  /**
3224
- * @public
3225
3224
  * <p>Summary information about the most recent revision of the artifact. For GitHub and
3226
3225
  * CodeCommit repositories, the commit message. For Amazon S3 buckets or actions,
3227
3226
  * the user-provided content of a <code>codepipeline-artifact-revision-summary</code> key
3228
3227
  * specified in the object metadata.</p>
3228
+ * @public
3229
3229
  */
3230
3230
  revisionSummary?: string;
3231
3231
  /**
3232
- * @public
3233
3232
  * <p>The commit ID for the artifact revision. For artifacts stored in GitHub or
3234
3233
  * CodeCommit repositories, the commit ID is linked to a commit details page.</p>
3234
+ * @public
3235
3235
  */
3236
3236
  revisionUrl?: string;
3237
3237
  }
3238
3238
  /**
3239
- * @public
3240
3239
  * <p>The interaction that stopped a pipeline execution.</p>
3240
+ * @public
3241
3241
  */
3242
3242
  export interface StopExecutionTrigger {
3243
3243
  /**
3244
- * @public
3245
3244
  * <p>The user-specified reason the pipeline was stopped.</p>
3245
+ * @public
3246
3246
  */
3247
3247
  reason?: string;
3248
3248
  }
3249
3249
  /**
3250
- * @public
3251
3250
  * <p>Summary information about a pipeline execution.</p>
3251
+ * @public
3252
3252
  */
3253
3253
  export interface PipelineExecutionSummary {
3254
3254
  /**
3255
- * @public
3256
3255
  * <p>The ID of the pipeline execution.</p>
3256
+ * @public
3257
3257
  */
3258
3258
  pipelineExecutionId?: string;
3259
3259
  /**
3260
- * @public
3261
3260
  * <p>The status of the pipeline execution.</p>
3262
3261
  * <ul>
3263
3262
  * <li>
@@ -3284,97 +3283,97 @@ export interface PipelineExecutionSummary {
3284
3283
  * <p>Failed: The pipeline execution was not completed successfully.</p>
3285
3284
  * </li>
3286
3285
  * </ul>
3286
+ * @public
3287
3287
  */
3288
3288
  status?: PipelineExecutionStatus;
3289
3289
  /**
3290
- * @public
3291
3290
  * <p>The date and time when the pipeline execution began, in timestamp format.</p>
3291
+ * @public
3292
3292
  */
3293
3293
  startTime?: Date;
3294
3294
  /**
3295
- * @public
3296
3295
  * <p>The date and time of the last change to the pipeline execution, in timestamp
3297
3296
  * format.</p>
3297
+ * @public
3298
3298
  */
3299
3299
  lastUpdateTime?: Date;
3300
3300
  /**
3301
- * @public
3302
3301
  * <p>A list of the source artifact revisions that initiated a pipeline
3303
3302
  * execution.</p>
3303
+ * @public
3304
3304
  */
3305
3305
  sourceRevisions?: SourceRevision[];
3306
3306
  /**
3307
- * @public
3308
3307
  * <p>The interaction or event that started a pipeline execution, such as automated change
3309
3308
  * detection or a <code>StartPipelineExecution</code> API call.</p>
3309
+ * @public
3310
3310
  */
3311
3311
  trigger?: ExecutionTrigger;
3312
3312
  /**
3313
- * @public
3314
3313
  * <p>The interaction that stopped a pipeline execution.</p>
3314
+ * @public
3315
3315
  */
3316
3316
  stopTrigger?: StopExecutionTrigger;
3317
3317
  /**
3318
- * @public
3319
3318
  * <p>The method that the pipeline will use to handle multiple executions. The default
3320
3319
  * mode is SUPERSEDED.</p>
3320
+ * @public
3321
3321
  */
3322
3322
  executionMode?: ExecutionMode;
3323
3323
  }
3324
3324
  /**
3325
- * @public
3326
3325
  * <p>Represents the output of a <code>ListPipelineExecutions</code> action.</p>
3326
+ * @public
3327
3327
  */
3328
3328
  export interface ListPipelineExecutionsOutput {
3329
3329
  /**
3330
- * @public
3331
3330
  * <p>A list of executions in the history of a pipeline.</p>
3331
+ * @public
3332
3332
  */
3333
3333
  pipelineExecutionSummaries?: PipelineExecutionSummary[];
3334
3334
  /**
3335
- * @public
3336
3335
  * <p>A token that can be used in the next <code>ListPipelineExecutions</code> call. To
3337
3336
  * view all items in the list, continue to call this operation with each subsequent token
3338
3337
  * until no more nextToken values are returned.</p>
3338
+ * @public
3339
3339
  */
3340
3340
  nextToken?: string;
3341
3341
  }
3342
3342
  /**
3343
- * @public
3344
3343
  * <p>Represents the input of a <code>ListPipelines</code> action.</p>
3344
+ * @public
3345
3345
  */
3346
3346
  export interface ListPipelinesInput {
3347
3347
  /**
3348
- * @public
3349
3348
  * <p>An identifier that was returned from the previous list pipelines call. It can be
3350
3349
  * used to return the next set of pipelines in the list.</p>
3350
+ * @public
3351
3351
  */
3352
3352
  nextToken?: string;
3353
3353
  /**
3354
- * @public
3355
3354
  * <p>The maximum number of pipelines to return in a single call. To retrieve the remaining
3356
3355
  * pipelines, make another call with the returned nextToken value. The minimum value you
3357
3356
  * can specify is 1. The maximum accepted value is 1000.</p>
3357
+ * @public
3358
3358
  */
3359
3359
  maxResults?: number;
3360
3360
  }
3361
3361
  /**
3362
- * @public
3363
3362
  * <p>Returns a summary of a pipeline.</p>
3363
+ * @public
3364
3364
  */
3365
3365
  export interface PipelineSummary {
3366
3366
  /**
3367
- * @public
3368
3367
  * <p>The name of the pipeline.</p>
3368
+ * @public
3369
3369
  */
3370
3370
  name?: string;
3371
3371
  /**
3372
- * @public
3373
3372
  * <p>The version number of the pipeline.</p>
3373
+ * @public
3374
3374
  */
3375
3375
  version?: number;
3376
3376
  /**
3377
- * @public
3378
3377
  * <p>CodePipeline provides the following pipeline types, which differ in
3379
3378
  * characteristics and price, so that you can tailor your pipeline features and cost to the
3380
3379
  * needs of your applications.</p>
@@ -3396,47 +3395,48 @@ export interface PipelineSummary {
3396
3395
  * <p>For information about pricing for CodePipeline, see <a href="http://aws.amazon.com/codepipeline/pricing/">Pricing</a>.</p>
3397
3396
  * <p> For information about which type of pipeline to choose, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html">What type of
3398
3397
  * pipeline is right for me?</a>.</p>
3398
+ * @public
3399
3399
  */
3400
3400
  pipelineType?: PipelineType;
3401
3401
  /**
3402
- * @public
3403
3402
  * <p>The method that the pipeline will use to handle multiple executions. The default
3404
3403
  * mode is SUPERSEDED.</p>
3404
+ * @public
3405
3405
  */
3406
3406
  executionMode?: ExecutionMode;
3407
3407
  /**
3408
- * @public
3409
3408
  * <p>The date and time the pipeline was created, in timestamp format.</p>
3409
+ * @public
3410
3410
  */
3411
3411
  created?: Date;
3412
3412
  /**
3413
- * @public
3414
3413
  * <p>The date and time of the last update to the pipeline, in timestamp
3415
3414
  * format.</p>
3415
+ * @public
3416
3416
  */
3417
3417
  updated?: Date;
3418
3418
  }
3419
3419
  /**
3420
- * @public
3421
3420
  * <p>Represents the output of a <code>ListPipelines</code> action.</p>
3421
+ * @public
3422
3422
  */
3423
3423
  export interface ListPipelinesOutput {
3424
3424
  /**
3425
- * @public
3426
3425
  * <p>The list of pipelines.</p>
3426
+ * @public
3427
3427
  */
3428
3428
  pipelines?: PipelineSummary[];
3429
3429
  /**
3430
- * @public
3431
3430
  * <p>If the amount of returned information is significantly large, an identifier is also
3432
3431
  * returned. It can be used in a subsequent list pipelines call to return the next set of
3433
3432
  * pipelines in the list.</p>
3433
+ * @public
3434
3434
  */
3435
3435
  nextToken?: string;
3436
3436
  }
3437
3437
  /**
3438
- * @public
3439
3438
  * <p>The specified resource ARN is invalid.</p>
3439
+ * @public
3440
3440
  */
3441
3441
  export declare class InvalidArnException extends __BaseException {
3442
3442
  readonly name: "InvalidArnException";
@@ -3451,20 +3451,20 @@ export declare class InvalidArnException extends __BaseException {
3451
3451
  */
3452
3452
  export interface ListTagsForResourceInput {
3453
3453
  /**
3454
- * @public
3455
3454
  * <p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>
3455
+ * @public
3456
3456
  */
3457
3457
  resourceArn: string | undefined;
3458
3458
  /**
3459
- * @public
3460
3459
  * <p>The token that was returned from the previous API call, which would be used to return
3461
3460
  * the next page of the list. The ListTagsforResource call lists all available tags in one
3462
3461
  * call and does not use pagination.</p>
3462
+ * @public
3463
3463
  */
3464
3464
  nextToken?: string;
3465
3465
  /**
3466
- * @public
3467
3466
  * <p>The maximum number of results to return in a single call.</p>
3467
+ * @public
3468
3468
  */
3469
3469
  maxResults?: number;
3470
3470
  }
@@ -3473,22 +3473,22 @@ export interface ListTagsForResourceInput {
3473
3473
  */
3474
3474
  export interface ListTagsForResourceOutput {
3475
3475
  /**
3476
- * @public
3477
3476
  * <p>The tags for the resource.</p>
3477
+ * @public
3478
3478
  */
3479
3479
  tags?: Tag[];
3480
3480
  /**
3481
- * @public
3482
3481
  * <p>If the amount of returned information is significantly large, an identifier is also
3483
3482
  * returned and can be used in a subsequent API call to return the next page of the list.
3484
3483
  * The ListTagsforResource call lists all available tags in one call and does not use
3485
3484
  * pagination.</p>
3485
+ * @public
3486
3486
  */
3487
3487
  nextToken?: string;
3488
3488
  }
3489
3489
  /**
3490
- * @public
3491
3490
  * <p>The resource was specified in an invalid format.</p>
3491
+ * @public
3492
3492
  */
3493
3493
  export declare class ResourceNotFoundException extends __BaseException {
3494
3494
  readonly name: "ResourceNotFoundException";
@@ -3503,15 +3503,15 @@ export declare class ResourceNotFoundException extends __BaseException {
3503
3503
  */
3504
3504
  export interface ListWebhooksInput {
3505
3505
  /**
3506
- * @public
3507
3506
  * <p>The token that was returned from the previous ListWebhooks call, which can be used
3508
3507
  * to return the next set of webhooks in the list.</p>
3508
+ * @public
3509
3509
  */
3510
3510
  NextToken?: string;
3511
3511
  /**
3512
- * @public
3513
3512
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
3514
3513
  * results, make another call with the returned nextToken value.</p>
3514
+ * @public
3515
3515
  */
3516
3516
  MaxResults?: number;
3517
3517
  }
@@ -3529,41 +3529,40 @@ export declare const WebhookAuthenticationType: {
3529
3529
  */
3530
3530
  export type WebhookAuthenticationType = (typeof WebhookAuthenticationType)[keyof typeof WebhookAuthenticationType];
3531
3531
  /**
3532
- * @public
3533
3532
  * <p>The authentication applied to incoming webhook trigger requests.</p>
3533
+ * @public
3534
3534
  */
3535
3535
  export interface WebhookAuthConfiguration {
3536
3536
  /**
3537
- * @public
3538
3537
  * <p>The property used to configure acceptance of webhooks in an IP address range. For
3539
3538
  * IP, only the <code>AllowedIPRange</code> property must be set. This property must be set
3540
3539
  * to a valid CIDR range.</p>
3540
+ * @public
3541
3541
  */
3542
3542
  AllowedIPRange?: string;
3543
3543
  /**
3544
- * @public
3545
3544
  * <p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the
3546
3545
  * <code>SecretToken</code> property must be set.</p>
3546
+ * @public
3547
3547
  */
3548
3548
  SecretToken?: string;
3549
3549
  }
3550
3550
  /**
3551
- * @public
3552
3551
  * <p>The event criteria that specify when a webhook notification is sent to your
3553
3552
  * URL.</p>
3553
+ * @public
3554
3554
  */
3555
3555
  export interface WebhookFilterRule {
3556
3556
  /**
3557
- * @public
3558
3557
  * <p>A JsonPath expression that is applied to the body/payload of the webhook. The value
3559
3558
  * selected by the JsonPath expression must match the value specified in the
3560
3559
  * <code>MatchEquals</code> field. Otherwise, the request is ignored. For more
3561
3560
  * information, see <a href="https://github.com/json-path/JsonPath">Java JsonPath
3562
3561
  * implementation</a> in GitHub.</p>
3562
+ * @public
3563
3563
  */
3564
3564
  jsonPath: string | undefined;
3565
3565
  /**
3566
- * @public
3567
3566
  * <p>The value selected by the <code>JsonPath</code> expression must match what is
3568
3567
  * supplied in the <code>MatchEquals</code> field. Otherwise, the request is ignored.
3569
3568
  * Properties from the target action configuration can be included as placeholders in this
@@ -3572,39 +3571,39 @@ export interface WebhookFilterRule {
3572
3571
  * configuration property called "Branch" with a value of "main", the
3573
3572
  * <code>MatchEquals</code> value is evaluated as "refs/heads/main". For a list of
3574
3573
  * action configuration properties for built-in action types, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements">Pipeline Structure Reference Action Requirements</a>.</p>
3574
+ * @public
3575
3575
  */
3576
3576
  matchEquals?: string;
3577
3577
  }
3578
3578
  /**
3579
- * @public
3580
3579
  * <p>Represents information about a webhook and its definition.</p>
3580
+ * @public
3581
3581
  */
3582
3582
  export interface WebhookDefinition {
3583
3583
  /**
3584
- * @public
3585
3584
  * <p>The name of the webhook.</p>
3585
+ * @public
3586
3586
  */
3587
3587
  name: string | undefined;
3588
3588
  /**
3589
- * @public
3590
3589
  * <p>The name of the pipeline you want to connect to the webhook.</p>
3590
+ * @public
3591
3591
  */
3592
3592
  targetPipeline: string | undefined;
3593
3593
  /**
3594
- * @public
3595
3594
  * <p>The name of the action in a pipeline you want to connect to the webhook. The action
3596
3595
  * must be from the source (first) stage of the pipeline.</p>
3596
+ * @public
3597
3597
  */
3598
3598
  targetAction: string | undefined;
3599
3599
  /**
3600
- * @public
3601
3600
  * <p>A list of rules applied to the body/payload sent in the POST request to a webhook
3602
3601
  * URL. All defined rules must pass for the request to be accepted and the pipeline
3603
3602
  * started.</p>
3603
+ * @public
3604
3604
  */
3605
3605
  filters: WebhookFilterRule[] | undefined;
3606
3606
  /**
3607
- * @public
3608
3607
  * <p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p>
3609
3608
  * <ul>
3610
3609
  * <li>
@@ -3622,62 +3621,63 @@ export interface WebhookDefinition {
3622
3621
  * origin.</p>
3623
3622
  * </li>
3624
3623
  * </ul>
3624
+ * @public
3625
3625
  */
3626
3626
  authentication: WebhookAuthenticationType | undefined;
3627
3627
  /**
3628
- * @public
3629
3628
  * <p>Properties that configure the authentication applied to incoming webhook trigger
3630
3629
  * requests. The required properties depend on the authentication type. For GITHUB_HMAC,
3631
3630
  * only the <code>SecretToken </code>property must be set. For IP, only the
3632
3631
  * <code>AllowedIPRange </code>property must be set to a valid CIDR range. For
3633
3632
  * UNAUTHENTICATED, no properties can be set.</p>
3633
+ * @public
3634
3634
  */
3635
3635
  authenticationConfiguration: WebhookAuthConfiguration | undefined;
3636
3636
  }
3637
3637
  /**
3638
- * @public
3639
3638
  * <p>The detail returned for each webhook after listing webhooks, such as the webhook
3640
3639
  * URL, the webhook name, and the webhook ARN.</p>
3640
+ * @public
3641
3641
  */
3642
3642
  export interface ListWebhookItem {
3643
3643
  /**
3644
- * @public
3645
3644
  * <p>The detail returned for each webhook, such as the webhook authentication type and
3646
3645
  * filter rules.</p>
3646
+ * @public
3647
3647
  */
3648
3648
  definition: WebhookDefinition | undefined;
3649
3649
  /**
3650
- * @public
3651
3650
  * <p>A unique URL generated by CodePipeline. When a POST request is made to this
3652
3651
  * URL, the defined pipeline is started as long as the body of the post request satisfies
3653
3652
  * the defined authentication and filtering conditions. Deleting and re-creating a webhook
3654
3653
  * makes the old URL invalid and generates a new one.</p>
3654
+ * @public
3655
3655
  */
3656
3656
  url: string | undefined;
3657
3657
  /**
3658
- * @public
3659
3658
  * <p>The text of the error message about the webhook.</p>
3659
+ * @public
3660
3660
  */
3661
3661
  errorMessage?: string;
3662
3662
  /**
3663
- * @public
3664
3663
  * <p>The number code of the error.</p>
3664
+ * @public
3665
3665
  */
3666
3666
  errorCode?: string;
3667
3667
  /**
3668
- * @public
3669
3668
  * <p>The date and time a webhook was last successfully triggered, in timestamp
3670
3669
  * format.</p>
3670
+ * @public
3671
3671
  */
3672
3672
  lastTriggered?: Date;
3673
3673
  /**
3674
- * @public
3675
3674
  * <p>The Amazon Resource Name (ARN) of the webhook.</p>
3675
+ * @public
3676
3676
  */
3677
3677
  arn?: string;
3678
3678
  /**
3679
- * @public
3680
3679
  * <p>Specifies the tags applied to the webhook.</p>
3680
+ * @public
3681
3681
  */
3682
3682
  tags?: Tag[];
3683
3683
  }
@@ -3686,173 +3686,173 @@ export interface ListWebhookItem {
3686
3686
  */
3687
3687
  export interface ListWebhooksOutput {
3688
3688
  /**
3689
- * @public
3690
3689
  * <p>The JSON detail returned for each webhook in the list output for the ListWebhooks
3691
3690
  * call.</p>
3691
+ * @public
3692
3692
  */
3693
3693
  webhooks?: ListWebhookItem[];
3694
3694
  /**
3695
- * @public
3696
3695
  * <p>If the amount of returned information is significantly large, an identifier is also
3697
3696
  * returned and can be used in a subsequent ListWebhooks call to return the next set of
3698
3697
  * webhooks in the list. </p>
3698
+ * @public
3699
3699
  */
3700
3700
  NextToken?: string;
3701
3701
  }
3702
3702
  /**
3703
- * @public
3704
3703
  * <p>Represents the input of a <code>PollForJobs</code> action.</p>
3704
+ * @public
3705
3705
  */
3706
3706
  export interface PollForJobsInput {
3707
3707
  /**
3708
- * @public
3709
3708
  * <p>Represents information about an action type.</p>
3709
+ * @public
3710
3710
  */
3711
3711
  actionTypeId: ActionTypeId | undefined;
3712
3712
  /**
3713
- * @public
3714
3713
  * <p>The maximum number of jobs to return in a poll for jobs call.</p>
3714
+ * @public
3715
3715
  */
3716
3716
  maxBatchSize?: number;
3717
3717
  /**
3718
- * @public
3719
3718
  * <p>A map of property names and values. For an action type with no queryable
3720
3719
  * properties, this value must be null or an empty map. For an action type with a queryable
3721
3720
  * property, you must supply that property as a key in the map. Only jobs whose action
3722
3721
  * configuration matches the mapped value are returned.</p>
3722
+ * @public
3723
3723
  */
3724
3724
  queryParam?: Record<string, string>;
3725
3725
  }
3726
3726
  /**
3727
- * @public
3728
3727
  * <p>Represents information about a job.</p>
3728
+ * @public
3729
3729
  */
3730
3730
  export interface Job {
3731
3731
  /**
3732
- * @public
3733
3732
  * <p>The unique system-generated ID of the job.</p>
3733
+ * @public
3734
3734
  */
3735
3735
  id?: string;
3736
3736
  /**
3737
- * @public
3738
3737
  * <p>Other data about a job.</p>
3738
+ * @public
3739
3739
  */
3740
3740
  data?: JobData;
3741
3741
  /**
3742
- * @public
3743
3742
  * <p>A system-generated random number that CodePipeline uses to ensure that the
3744
3743
  * job is being worked on by only one job worker. Use this number in an <a>AcknowledgeJob</a> request.</p>
3744
+ * @public
3745
3745
  */
3746
3746
  nonce?: string;
3747
3747
  /**
3748
- * @public
3749
3748
  * <p>The ID of the Amazon Web Services account to use when performing the job.</p>
3749
+ * @public
3750
3750
  */
3751
3751
  accountId?: string;
3752
3752
  }
3753
3753
  /**
3754
- * @public
3755
3754
  * <p>Represents the output of a <code>PollForJobs</code> action.</p>
3755
+ * @public
3756
3756
  */
3757
3757
  export interface PollForJobsOutput {
3758
3758
  /**
3759
- * @public
3760
3759
  * <p>Information about the jobs to take action on.</p>
3760
+ * @public
3761
3761
  */
3762
3762
  jobs?: Job[];
3763
3763
  }
3764
3764
  /**
3765
- * @public
3766
3765
  * <p>Represents the input of a <code>PollForThirdPartyJobs</code> action.</p>
3766
+ * @public
3767
3767
  */
3768
3768
  export interface PollForThirdPartyJobsInput {
3769
3769
  /**
3770
- * @public
3771
3770
  * <p>Represents information about an action type.</p>
3771
+ * @public
3772
3772
  */
3773
3773
  actionTypeId: ActionTypeId | undefined;
3774
3774
  /**
3775
- * @public
3776
3775
  * <p>The maximum number of jobs to return in a poll for jobs call.</p>
3776
+ * @public
3777
3777
  */
3778
3778
  maxBatchSize?: number;
3779
3779
  }
3780
3780
  /**
3781
- * @public
3782
3781
  * <p>A response to a <code>PollForThirdPartyJobs</code> request returned by CodePipeline when there is a job to be worked on by a partner action.</p>
3782
+ * @public
3783
3783
  */
3784
3784
  export interface ThirdPartyJob {
3785
3785
  /**
3786
- * @public
3787
3786
  * <p>The <code>clientToken</code> portion of the <code>clientId</code> and
3788
3787
  * <code>clientToken</code> pair used to verify that the calling entity is allowed
3789
3788
  * access to the job and its details.</p>
3789
+ * @public
3790
3790
  */
3791
3791
  clientId?: string;
3792
3792
  /**
3793
- * @public
3794
3793
  * <p>The identifier used to identify the job in CodePipeline.</p>
3794
+ * @public
3795
3795
  */
3796
3796
  jobId?: string;
3797
3797
  }
3798
3798
  /**
3799
- * @public
3800
3799
  * <p>Represents the output of a <code>PollForThirdPartyJobs</code> action.</p>
3800
+ * @public
3801
3801
  */
3802
3802
  export interface PollForThirdPartyJobsOutput {
3803
3803
  /**
3804
- * @public
3805
3804
  * <p>Information about the jobs to take action on.</p>
3805
+ * @public
3806
3806
  */
3807
3807
  jobs?: ThirdPartyJob[];
3808
3808
  }
3809
3809
  /**
3810
- * @public
3811
3810
  * <p>Represents the input of a <code>PutActionRevision</code> action.</p>
3811
+ * @public
3812
3812
  */
3813
3813
  export interface PutActionRevisionInput {
3814
3814
  /**
3815
- * @public
3816
3815
  * <p>The name of the pipeline that starts processing the revision to the
3817
3816
  * source.</p>
3817
+ * @public
3818
3818
  */
3819
3819
  pipelineName: string | undefined;
3820
3820
  /**
3821
- * @public
3822
3821
  * <p>The name of the stage that contains the action that acts on the revision.</p>
3822
+ * @public
3823
3823
  */
3824
3824
  stageName: string | undefined;
3825
3825
  /**
3826
- * @public
3827
3826
  * <p>The name of the action that processes the revision.</p>
3827
+ * @public
3828
3828
  */
3829
3829
  actionName: string | undefined;
3830
3830
  /**
3831
- * @public
3832
3831
  * <p>Represents information about the version (or revision) of an action.</p>
3832
+ * @public
3833
3833
  */
3834
3834
  actionRevision: ActionRevision | undefined;
3835
3835
  }
3836
3836
  /**
3837
- * @public
3838
3837
  * <p>Represents the output of a <code>PutActionRevision</code> action.</p>
3838
+ * @public
3839
3839
  */
3840
3840
  export interface PutActionRevisionOutput {
3841
3841
  /**
3842
- * @public
3843
3842
  * <p>Indicates whether the artifact revision was previously used in an execution of the
3844
3843
  * specified pipeline.</p>
3844
+ * @public
3845
3845
  */
3846
3846
  newRevision?: boolean;
3847
3847
  /**
3848
- * @public
3849
3848
  * <p>The ID of the current workflow state of the pipeline.</p>
3849
+ * @public
3850
3850
  */
3851
3851
  pipelineExecutionId?: string;
3852
3852
  }
3853
3853
  /**
3854
- * @public
3855
3854
  * <p>The approval request already received a response or has expired.</p>
3855
+ * @public
3856
3856
  */
3857
3857
  export declare class InvalidApprovalTokenException extends __BaseException {
3858
3858
  readonly name: "InvalidApprovalTokenException";
@@ -3863,52 +3863,52 @@ export declare class InvalidApprovalTokenException extends __BaseException {
3863
3863
  constructor(opts: __ExceptionOptionType<InvalidApprovalTokenException, __BaseException>);
3864
3864
  }
3865
3865
  /**
3866
- * @public
3867
3866
  * <p>Represents the input of a <code>PutApprovalResult</code> action.</p>
3867
+ * @public
3868
3868
  */
3869
3869
  export interface PutApprovalResultInput {
3870
3870
  /**
3871
- * @public
3872
3871
  * <p>The name of the pipeline that contains the action. </p>
3872
+ * @public
3873
3873
  */
3874
3874
  pipelineName: string | undefined;
3875
3875
  /**
3876
- * @public
3877
3876
  * <p>The name of the stage that contains the action.</p>
3877
+ * @public
3878
3878
  */
3879
3879
  stageName: string | undefined;
3880
3880
  /**
3881
- * @public
3882
3881
  * <p>The name of the action for which approval is requested.</p>
3882
+ * @public
3883
3883
  */
3884
3884
  actionName: string | undefined;
3885
3885
  /**
3886
- * @public
3887
3886
  * <p>Represents information about the result of the approval request.</p>
3887
+ * @public
3888
3888
  */
3889
3889
  result: ApprovalResult | undefined;
3890
3890
  /**
3891
- * @public
3892
3891
  * <p>The system-generated token used to identify a unique approval request. The token
3893
3892
  * for each open approval request can be obtained using the <a>GetPipelineState</a> action. It is used to validate that the approval
3894
3893
  * request corresponding to this token is still valid.</p>
3894
+ * @public
3895
3895
  */
3896
3896
  token: string | undefined;
3897
3897
  }
3898
3898
  /**
3899
- * @public
3900
3899
  * <p>Represents the output of a <code>PutApprovalResult</code> action.</p>
3900
+ * @public
3901
3901
  */
3902
3902
  export interface PutApprovalResultOutput {
3903
3903
  /**
3904
- * @public
3905
3904
  * <p>The timestamp showing when the approval or rejection was submitted.</p>
3905
+ * @public
3906
3906
  */
3907
3907
  approvedAt?: Date;
3908
3908
  }
3909
3909
  /**
3910
- * @public
3911
3910
  * <p>The job state was specified in an invalid format.</p>
3911
+ * @public
3912
3912
  */
3913
3913
  export declare class InvalidJobStateException extends __BaseException {
3914
3914
  readonly name: "InvalidJobStateException";
@@ -3935,46 +3935,46 @@ export declare const FailureType: {
3935
3935
  */
3936
3936
  export type FailureType = (typeof FailureType)[keyof typeof FailureType];
3937
3937
  /**
3938
- * @public
3939
3938
  * <p>Represents information about failure details.</p>
3939
+ * @public
3940
3940
  */
3941
3941
  export interface FailureDetails {
3942
3942
  /**
3943
- * @public
3944
3943
  * <p>The type of the failure.</p>
3944
+ * @public
3945
3945
  */
3946
3946
  type: FailureType | undefined;
3947
3947
  /**
3948
- * @public
3949
3948
  * <p>The message about the failure.</p>
3949
+ * @public
3950
3950
  */
3951
3951
  message: string | undefined;
3952
3952
  /**
3953
- * @public
3954
3953
  * <p>The external ID of the run of the action that failed.</p>
3954
+ * @public
3955
3955
  */
3956
3956
  externalExecutionId?: string;
3957
3957
  }
3958
3958
  /**
3959
- * @public
3960
3959
  * <p>Represents the input of a <code>PutJobFailureResult</code> action.</p>
3960
+ * @public
3961
3961
  */
3962
3962
  export interface PutJobFailureResultInput {
3963
3963
  /**
3964
- * @public
3965
3964
  * <p>The unique system-generated ID of the job that failed. This is the same ID returned
3966
3965
  * from <code>PollForJobs</code>.</p>
3966
+ * @public
3967
3967
  */
3968
3968
  jobId: string | undefined;
3969
3969
  /**
3970
- * @public
3971
3970
  * <p>The details about the failure of a job.</p>
3971
+ * @public
3972
3972
  */
3973
3973
  failureDetails: FailureDetails | undefined;
3974
3974
  }
3975
3975
  /**
3976
- * @public
3977
3976
  * <p>Exceeded the total size limit for all variables in the pipeline.</p>
3977
+ * @public
3978
3978
  */
3979
3979
  export declare class OutputVariablesSizeExceededException extends __BaseException {
3980
3980
  readonly name: "OutputVariablesSizeExceededException";
@@ -3985,162 +3985,162 @@ export declare class OutputVariablesSizeExceededException extends __BaseExceptio
3985
3985
  constructor(opts: __ExceptionOptionType<OutputVariablesSizeExceededException, __BaseException>);
3986
3986
  }
3987
3987
  /**
3988
- * @public
3989
3988
  * <p>Represents information about a current revision.</p>
3989
+ * @public
3990
3990
  */
3991
3991
  export interface CurrentRevision {
3992
3992
  /**
3993
- * @public
3994
3993
  * <p>The revision ID of the current version of an artifact.</p>
3994
+ * @public
3995
3995
  */
3996
3996
  revision: string | undefined;
3997
3997
  /**
3998
- * @public
3999
3998
  * <p>The change identifier for the current revision.</p>
3999
+ * @public
4000
4000
  */
4001
4001
  changeIdentifier: string | undefined;
4002
4002
  /**
4003
- * @public
4004
4003
  * <p>The date and time when the most recent revision of the artifact was created, in
4005
4004
  * timestamp format.</p>
4005
+ * @public
4006
4006
  */
4007
4007
  created?: Date;
4008
4008
  /**
4009
- * @public
4010
4009
  * <p>The summary of the most recent revision of the artifact.</p>
4010
+ * @public
4011
4011
  */
4012
4012
  revisionSummary?: string;
4013
4013
  }
4014
4014
  /**
4015
- * @public
4016
4015
  * <p>The details of the actions taken and results produced on an artifact as it passes
4017
4016
  * through stages in the pipeline.</p>
4017
+ * @public
4018
4018
  */
4019
4019
  export interface ExecutionDetails {
4020
4020
  /**
4021
- * @public
4022
4021
  * <p>The summary of the current status of the actions.</p>
4022
+ * @public
4023
4023
  */
4024
4024
  summary?: string;
4025
4025
  /**
4026
- * @public
4027
4026
  * <p>The system-generated unique ID of this action used to identify this job worker in
4028
4027
  * any external systems, such as CodeDeploy.</p>
4028
+ * @public
4029
4029
  */
4030
4030
  externalExecutionId?: string;
4031
4031
  /**
4032
- * @public
4033
4032
  * <p>The percentage of work completed on the action, represented on a scale of 0 to 100
4034
4033
  * percent.</p>
4034
+ * @public
4035
4035
  */
4036
4036
  percentComplete?: number;
4037
4037
  }
4038
4038
  /**
4039
- * @public
4040
4039
  * <p>Represents the input of a <code>PutJobSuccessResult</code> action.</p>
4040
+ * @public
4041
4041
  */
4042
4042
  export interface PutJobSuccessResultInput {
4043
4043
  /**
4044
- * @public
4045
4044
  * <p>The unique system-generated ID of the job that succeeded. This is the same ID
4046
4045
  * returned from <code>PollForJobs</code>.</p>
4046
+ * @public
4047
4047
  */
4048
4048
  jobId: string | undefined;
4049
4049
  /**
4050
- * @public
4051
4050
  * <p>The ID of the current revision of the artifact successfully worked on by the
4052
4051
  * job.</p>
4052
+ * @public
4053
4053
  */
4054
4054
  currentRevision?: CurrentRevision;
4055
4055
  /**
4056
- * @public
4057
4056
  * <p>A token generated by a job worker, such as a CodeDeploy deployment ID, that a
4058
4057
  * successful job provides to identify a custom action in progress. Future jobs use this
4059
4058
  * token to identify the running instance of the action. It can be reused to return more
4060
4059
  * information about the progress of the custom action. When the action is complete, no
4061
4060
  * continuation token should be supplied.</p>
4061
+ * @public
4062
4062
  */
4063
4063
  continuationToken?: string;
4064
4064
  /**
4065
- * @public
4066
4065
  * <p>The execution details of the successful job, such as the actions taken by the job
4067
4066
  * worker.</p>
4067
+ * @public
4068
4068
  */
4069
4069
  executionDetails?: ExecutionDetails;
4070
4070
  /**
4071
- * @public
4072
4071
  * <p>Key-value pairs produced as output by a job worker that can be made available to a
4073
4072
  * downstream action configuration. <code>outputVariables</code> can be included only when
4074
4073
  * there is no continuation token on the request.</p>
4074
+ * @public
4075
4075
  */
4076
4076
  outputVariables?: Record<string, string>;
4077
4077
  }
4078
4078
  /**
4079
- * @public
4080
4079
  * <p>Represents the input of a <code>PutThirdPartyJobFailureResult</code>
4081
4080
  * action.</p>
4081
+ * @public
4082
4082
  */
4083
4083
  export interface PutThirdPartyJobFailureResultInput {
4084
4084
  /**
4085
- * @public
4086
4085
  * <p>The ID of the job that failed. This is the same ID returned from
4087
4086
  * <code>PollForThirdPartyJobs</code>.</p>
4087
+ * @public
4088
4088
  */
4089
4089
  jobId: string | undefined;
4090
4090
  /**
4091
- * @public
4092
4091
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
4093
4092
  * the calling entity is allowed access to the job and its details.</p>
4093
+ * @public
4094
4094
  */
4095
4095
  clientToken: string | undefined;
4096
4096
  /**
4097
- * @public
4098
4097
  * <p>Represents information about failure details.</p>
4098
+ * @public
4099
4099
  */
4100
4100
  failureDetails: FailureDetails | undefined;
4101
4101
  }
4102
4102
  /**
4103
- * @public
4104
4103
  * <p>Represents the input of a <code>PutThirdPartyJobSuccessResult</code>
4105
4104
  * action.</p>
4105
+ * @public
4106
4106
  */
4107
4107
  export interface PutThirdPartyJobSuccessResultInput {
4108
4108
  /**
4109
- * @public
4110
4109
  * <p>The ID of the job that successfully completed. This is the same ID returned from
4111
4110
  * <code>PollForThirdPartyJobs</code>.</p>
4111
+ * @public
4112
4112
  */
4113
4113
  jobId: string | undefined;
4114
4114
  /**
4115
- * @public
4116
4115
  * <p>The clientToken portion of the clientId and clientToken pair used to verify that
4117
4116
  * the calling entity is allowed access to the job and its details.</p>
4117
+ * @public
4118
4118
  */
4119
4119
  clientToken: string | undefined;
4120
4120
  /**
4121
- * @public
4122
4121
  * <p>Represents information about a current revision.</p>
4122
+ * @public
4123
4123
  */
4124
4124
  currentRevision?: CurrentRevision;
4125
4125
  /**
4126
- * @public
4127
4126
  * <p>A token generated by a job worker, such as a CodeDeploy deployment ID, that a
4128
4127
  * successful job provides to identify a partner action in progress. Future jobs use this
4129
4128
  * token to identify the running instance of the action. It can be reused to return more
4130
4129
  * information about the progress of the partner action. When the action is complete, no
4131
4130
  * continuation token should be supplied.</p>
4131
+ * @public
4132
4132
  */
4133
4133
  continuationToken?: string;
4134
4134
  /**
4135
- * @public
4136
4135
  * <p>The details of the actions taken and results produced on an artifact as it passes
4137
4136
  * through stages in the pipeline. </p>
4137
+ * @public
4138
4138
  */
4139
4139
  executionDetails?: ExecutionDetails;
4140
4140
  }
4141
4141
  /**
4142
- * @public
4143
4142
  * <p>The specified authentication type is in an invalid format.</p>
4143
+ * @public
4144
4144
  */
4145
4145
  export declare class InvalidWebhookAuthenticationParametersException extends __BaseException {
4146
4146
  readonly name: "InvalidWebhookAuthenticationParametersException";
@@ -4151,8 +4151,8 @@ export declare class InvalidWebhookAuthenticationParametersException extends __B
4151
4151
  constructor(opts: __ExceptionOptionType<InvalidWebhookAuthenticationParametersException, __BaseException>);
4152
4152
  }
4153
4153
  /**
4154
- * @public
4155
4154
  * <p>The specified event filter rule is in an invalid format.</p>
4155
+ * @public
4156
4156
  */
4157
4157
  export declare class InvalidWebhookFilterPatternException extends __BaseException {
4158
4158
  readonly name: "InvalidWebhookFilterPatternException";
@@ -4167,16 +4167,16 @@ export declare class InvalidWebhookFilterPatternException extends __BaseExceptio
4167
4167
  */
4168
4168
  export interface PutWebhookInput {
4169
4169
  /**
4170
- * @public
4171
4170
  * <p>The detail provided in an input file to create the webhook, such as the webhook
4172
4171
  * name, the pipeline name, and the action name. Give the webhook a unique name that helps
4173
4172
  * you identify it. You might name the webhook after the pipeline and action it targets so
4174
4173
  * that you can easily recognize what it's used for later.</p>
4174
+ * @public
4175
4175
  */
4176
4176
  webhook: WebhookDefinition | undefined;
4177
4177
  /**
4178
- * @public
4179
4178
  * <p>The tags for the webhook.</p>
4179
+ * @public
4180
4180
  */
4181
4181
  tags?: Tag[];
4182
4182
  }
@@ -4185,9 +4185,9 @@ export interface PutWebhookInput {
4185
4185
  */
4186
4186
  export interface PutWebhookOutput {
4187
4187
  /**
4188
- * @public
4189
4188
  * <p>The detail returned from creating the webhook, such as the webhook name, webhook
4190
4189
  * URL, and webhook ARN.</p>
4190
+ * @public
4191
4191
  */
4192
4192
  webhook?: ListWebhookItem;
4193
4193
  }
@@ -4196,9 +4196,9 @@ export interface PutWebhookOutput {
4196
4196
  */
4197
4197
  export interface RegisterWebhookWithThirdPartyInput {
4198
4198
  /**
4199
- * @public
4200
4199
  * <p>The name of an existing webhook created with PutWebhook to register with a
4201
4200
  * supported third party. </p>
4201
+ * @public
4202
4202
  */
4203
4203
  webhookName?: string;
4204
4204
  }
@@ -4208,9 +4208,9 @@ export interface RegisterWebhookWithThirdPartyInput {
4208
4208
  export interface RegisterWebhookWithThirdPartyOutput {
4209
4209
  }
4210
4210
  /**
4211
- * @public
4212
4211
  * <p>Your request cannot be handled because the pipeline is busy handling ongoing
4213
4212
  * activities. Try again later.</p>
4213
+ * @public
4214
4214
  */
4215
4215
  export declare class ConflictException extends __BaseException {
4216
4216
  readonly name: "ConflictException";
@@ -4221,10 +4221,10 @@ export declare class ConflictException extends __BaseException {
4221
4221
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
4222
4222
  }
4223
4223
  /**
4224
- * @public
4225
4224
  * <p>The stage has failed in a later run of the pipeline and the
4226
4225
  * <code>pipelineExecutionId</code> associated with the request is out of
4227
4226
  * date.</p>
4227
+ * @public
4228
4228
  */
4229
4229
  export declare class NotLatestPipelineExecutionException extends __BaseException {
4230
4230
  readonly name: "NotLatestPipelineExecutionException";
@@ -4247,48 +4247,48 @@ export declare const StageRetryMode: {
4247
4247
  */
4248
4248
  export type StageRetryMode = (typeof StageRetryMode)[keyof typeof StageRetryMode];
4249
4249
  /**
4250
- * @public
4251
4250
  * <p>Represents the input of a <code>RetryStageExecution</code> action.</p>
4251
+ * @public
4252
4252
  */
4253
4253
  export interface RetryStageExecutionInput {
4254
4254
  /**
4255
- * @public
4256
4255
  * <p>The name of the pipeline that contains the failed stage.</p>
4256
+ * @public
4257
4257
  */
4258
4258
  pipelineName: string | undefined;
4259
4259
  /**
4260
- * @public
4261
4260
  * <p>The name of the failed stage to be retried.</p>
4261
+ * @public
4262
4262
  */
4263
4263
  stageName: string | undefined;
4264
4264
  /**
4265
- * @public
4266
4265
  * <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
4267
4266
  * the failed stage</p>
4267
+ * @public
4268
4268
  */
4269
4269
  pipelineExecutionId: string | undefined;
4270
4270
  /**
4271
- * @public
4272
4271
  * <p>The scope of the retry attempt.</p>
4272
+ * @public
4273
4273
  */
4274
4274
  retryMode: StageRetryMode | undefined;
4275
4275
  }
4276
4276
  /**
4277
- * @public
4278
4277
  * <p>Represents the output of a <code>RetryStageExecution</code> action.</p>
4278
+ * @public
4279
4279
  */
4280
4280
  export interface RetryStageExecutionOutput {
4281
4281
  /**
4282
- * @public
4283
4282
  * <p>The ID of the current workflow execution in the failed stage.</p>
4283
+ * @public
4284
4284
  */
4285
4285
  pipelineExecutionId?: string;
4286
4286
  }
4287
4287
  /**
4288
- * @public
4289
4288
  * <p>Unable to retry. The pipeline structure or stage state might have changed while
4290
4289
  * actions awaited retry, or the stage contains no failed
4291
4290
  * actions.</p>
4291
+ * @public
4292
4292
  */
4293
4293
  export declare class StageNotRetryableException extends __BaseException {
4294
4294
  readonly name: "StageNotRetryableException";
@@ -4299,8 +4299,8 @@ export declare class StageNotRetryableException extends __BaseException {
4299
4299
  constructor(opts: __ExceptionOptionType<StageNotRetryableException, __BaseException>);
4300
4300
  }
4301
4301
  /**
4302
- * @public
4303
4302
  * <p>The pipeline has reached the limit for concurrent pipeline executions.</p>
4303
+ * @public
4304
4304
  */
4305
4305
  export declare class ConcurrentPipelineExecutionsLimitExceededException extends __BaseException {
4306
4306
  readonly name: "ConcurrentPipelineExecutionsLimitExceededException";
@@ -4324,96 +4324,96 @@ export declare const SourceRevisionType: {
4324
4324
  */
4325
4325
  export type SourceRevisionType = (typeof SourceRevisionType)[keyof typeof SourceRevisionType];
4326
4326
  /**
4327
- * @public
4328
4327
  * <p>A list that allows you to specify, or override, the source revision for a pipeline
4329
4328
  * execution that's being started. A source revision is the version with all the changes to
4330
4329
  * your application code, or source artifact, for the pipeline execution.</p>
4330
+ * @public
4331
4331
  */
4332
4332
  export interface SourceRevisionOverride {
4333
4333
  /**
4334
- * @public
4335
4334
  * <p>The name of the action where the override will be applied.</p>
4335
+ * @public
4336
4336
  */
4337
4337
  actionName: string | undefined;
4338
4338
  /**
4339
- * @public
4340
4339
  * <p>The type of source revision, based on the source provider. For example, the revision
4341
4340
  * type for the CodeCommit action provider is the commit ID.</p>
4341
+ * @public
4342
4342
  */
4343
4343
  revisionType: SourceRevisionType | undefined;
4344
4344
  /**
4345
- * @public
4346
4345
  * <p>The source revision, or version of your source artifact, with the changes that you
4347
4346
  * want to run in the pipeline execution.</p>
4347
+ * @public
4348
4348
  */
4349
4349
  revisionValue: string | undefined;
4350
4350
  }
4351
4351
  /**
4352
- * @public
4353
4352
  * <p>A pipeline-level variable used for a pipeline execution.</p>
4353
+ * @public
4354
4354
  */
4355
4355
  export interface PipelineVariable {
4356
4356
  /**
4357
- * @public
4358
4357
  * <p>The name of a pipeline-level variable.</p>
4358
+ * @public
4359
4359
  */
4360
4360
  name: string | undefined;
4361
4361
  /**
4362
- * @public
4363
4362
  * <p>The value of a pipeline-level variable.</p>
4363
+ * @public
4364
4364
  */
4365
4365
  value: string | undefined;
4366
4366
  }
4367
4367
  /**
4368
- * @public
4369
4368
  * <p>Represents the input of a <code>StartPipelineExecution</code> action.</p>
4369
+ * @public
4370
4370
  */
4371
4371
  export interface StartPipelineExecutionInput {
4372
4372
  /**
4373
- * @public
4374
4373
  * <p>The name of the pipeline to start.</p>
4374
+ * @public
4375
4375
  */
4376
4376
  name: string | undefined;
4377
4377
  /**
4378
- * @public
4379
4378
  * <p>A list that overrides pipeline variables for a pipeline execution that's being
4380
4379
  * started. Variable names must match <code>[A-Za-z0-9@\-_]+</code>, and the values can be
4381
4380
  * anything except an empty string.</p>
4381
+ * @public
4382
4382
  */
4383
4383
  variables?: PipelineVariable[];
4384
4384
  /**
4385
- * @public
4386
4385
  * <p>The system-generated unique ID used to identify a unique execution
4387
4386
  * request.</p>
4387
+ * @public
4388
4388
  */
4389
4389
  clientRequestToken?: string;
4390
4390
  /**
4391
- * @public
4392
4391
  * <p>A list that allows you to specify, or override, the source revision for a pipeline
4393
4392
  * execution that's being started. A source revision is the version with all the changes to
4394
4393
  * your application code, or source artifact, for the pipeline execution.</p>
4394
+ * @public
4395
4395
  */
4396
4396
  sourceRevisions?: SourceRevisionOverride[];
4397
4397
  }
4398
4398
  /**
4399
- * @public
4400
4399
  * <p>Represents the output of a <code>StartPipelineExecution</code> action.</p>
4400
+ * @public
4401
4401
  */
4402
4402
  export interface StartPipelineExecutionOutput {
4403
4403
  /**
4404
- * @public
4405
4404
  * <p>The unique system-generated ID of the pipeline execution that was
4406
4405
  * started.</p>
4406
+ * @public
4407
4407
  */
4408
4408
  pipelineExecutionId?: string;
4409
4409
  }
4410
4410
  /**
4411
- * @public
4412
4411
  * <p>The pipeline execution is already in a <code>Stopping</code> state. If you already
4413
4412
  * chose to stop and wait, you cannot make that request again. You can choose to stop and
4414
4413
  * abandon now, but be aware that this option can lead to failed tasks or out of sequence
4415
4414
  * tasks. If you already chose to stop and abandon, you cannot make that request
4416
4415
  * again.</p>
4416
+ * @public
4417
4417
  */
4418
4418
  export declare class DuplicatedStopRequestException extends __BaseException {
4419
4419
  readonly name: "DuplicatedStopRequestException";
@@ -4424,9 +4424,9 @@ export declare class DuplicatedStopRequestException extends __BaseException {
4424
4424
  constructor(opts: __ExceptionOptionType<DuplicatedStopRequestException, __BaseException>);
4425
4425
  }
4426
4426
  /**
4427
- * @public
4428
4427
  * <p>Unable to stop the pipeline execution. The execution might already be in a
4429
4428
  * <code>Stopped</code> state, or it might no longer be in progress.</p>
4429
+ * @public
4430
4430
  */
4431
4431
  export declare class PipelineExecutionNotStoppableException extends __BaseException {
4432
4432
  readonly name: "PipelineExecutionNotStoppableException";
@@ -4441,29 +4441,29 @@ export declare class PipelineExecutionNotStoppableException extends __BaseExcept
4441
4441
  */
4442
4442
  export interface StopPipelineExecutionInput {
4443
4443
  /**
4444
- * @public
4445
4444
  * <p>The name of the pipeline to stop.</p>
4445
+ * @public
4446
4446
  */
4447
4447
  pipelineName: string | undefined;
4448
4448
  /**
4449
- * @public
4450
4449
  * <p>The ID of the pipeline execution to be stopped in the current stage. Use the
4451
4450
  * <code>GetPipelineState</code> action to retrieve the current
4452
4451
  * pipelineExecutionId.</p>
4452
+ * @public
4453
4453
  */
4454
4454
  pipelineExecutionId: string | undefined;
4455
4455
  /**
4456
- * @public
4457
4456
  * <p>Use this option to stop the pipeline execution by abandoning, rather than finishing,
4458
4457
  * in-progress actions.</p>
4459
4458
  * <note>
4460
4459
  * <p>This option can lead to failed or out-of-sequence tasks.</p>
4461
4460
  * </note>
4461
+ * @public
4462
4462
  */
4463
4463
  abandon?: boolean;
4464
4464
  /**
4465
- * @public
4466
4465
  * <p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>
4466
+ * @public
4467
4467
  */
4468
4468
  reason?: string;
4469
4469
  }
@@ -4472,8 +4472,8 @@ export interface StopPipelineExecutionInput {
4472
4472
  */
4473
4473
  export interface StopPipelineExecutionOutput {
4474
4474
  /**
4475
- * @public
4476
4475
  * <p>The unique system-generated ID of the pipeline execution that was stopped.</p>
4476
+ * @public
4477
4477
  */
4478
4478
  pipelineExecutionId?: string;
4479
4479
  }
@@ -4482,13 +4482,13 @@ export interface StopPipelineExecutionOutput {
4482
4482
  */
4483
4483
  export interface TagResourceInput {
4484
4484
  /**
4485
- * @public
4486
4485
  * <p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>
4486
+ * @public
4487
4487
  */
4488
4488
  resourceArn: string | undefined;
4489
4489
  /**
4490
- * @public
4491
4490
  * <p>The tags you want to modify or add to the resource.</p>
4491
+ * @public
4492
4492
  */
4493
4493
  tags: Tag[] | undefined;
4494
4494
  }
@@ -4502,13 +4502,13 @@ export interface TagResourceOutput {
4502
4502
  */
4503
4503
  export interface UntagResourceInput {
4504
4504
  /**
4505
- * @public
4506
4505
  * <p> The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
4506
+ * @public
4507
4507
  */
4508
4508
  resourceArn: string | undefined;
4509
4509
  /**
4510
- * @public
4511
4510
  * <p>The list of keys for the tags to be removed from the resource.</p>
4511
+ * @public
4512
4512
  */
4513
4513
  tagKeys: string[] | undefined;
4514
4514
  }
@@ -4518,8 +4518,8 @@ export interface UntagResourceInput {
4518
4518
  export interface UntagResourceOutput {
4519
4519
  }
4520
4520
  /**
4521
- * @public
4522
4521
  * <p>The request failed because of an unknown error, exception, or failure.</p>
4522
+ * @public
4523
4523
  */
4524
4524
  export declare class RequestFailedException extends __BaseException {
4525
4525
  readonly name: "RequestFailedException";
@@ -4534,30 +4534,30 @@ export declare class RequestFailedException extends __BaseException {
4534
4534
  */
4535
4535
  export interface UpdateActionTypeInput {
4536
4536
  /**
4537
- * @public
4538
4537
  * <p>The action type definition for the action type to be updated.</p>
4538
+ * @public
4539
4539
  */
4540
4540
  actionType: ActionTypeDeclaration | undefined;
4541
4541
  }
4542
4542
  /**
4543
- * @public
4544
4543
  * <p>Represents the input of an <code>UpdatePipeline</code> action.</p>
4544
+ * @public
4545
4545
  */
4546
4546
  export interface UpdatePipelineInput {
4547
4547
  /**
4548
- * @public
4549
4548
  * <p>The name of the pipeline to be updated.</p>
4549
+ * @public
4550
4550
  */
4551
4551
  pipeline: PipelineDeclaration | undefined;
4552
4552
  }
4553
4553
  /**
4554
- * @public
4555
4554
  * <p>Represents the output of an <code>UpdatePipeline</code> action.</p>
4555
+ * @public
4556
4556
  */
4557
4557
  export interface UpdatePipelineOutput {
4558
4558
  /**
4559
- * @public
4560
4559
  * <p>The structure of the updated pipeline.</p>
4560
+ * @public
4561
4561
  */
4562
4562
  pipeline?: PipelineDeclaration;
4563
4563
  }