@aws-sdk/client-codepipeline 3.338.0 → 3.340.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -13
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_json1_1.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_json1_1.js +1 -0
- package/dist-types/CodePipeline.d.ts +83 -84
- package/dist-types/CodePipelineClient.d.ts +83 -84
- package/dist-types/commands/AcknowledgeJobCommand.d.ts +1 -1
- package/dist-types/commands/AcknowledgeThirdPartyJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomActionTypeCommand.d.ts +8 -8
- package/dist-types/commands/CreatePipelineCommand.d.ts +18 -18
- package/dist-types/commands/DeleteCustomActionTypeCommand.d.ts +3 -3
- package/dist-types/commands/DeleteWebhookCommand.d.ts +1 -2
- package/dist-types/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +3 -3
- package/dist-types/commands/DisableStageTransitionCommand.d.ts +1 -1
- package/dist-types/commands/EnableStageTransitionCommand.d.ts +1 -1
- package/dist-types/commands/GetActionTypeCommand.d.ts +3 -3
- package/dist-types/commands/GetJobDetailsCommand.d.ts +11 -11
- package/dist-types/commands/GetPipelineCommand.d.ts +8 -7
- package/dist-types/commands/GetPipelineExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetPipelineStateCommand.d.ts +5 -5
- package/dist-types/commands/GetThirdPartyJobDetailsCommand.d.ts +11 -11
- package/dist-types/commands/ListActionExecutionsCommand.d.ts +3 -3
- package/dist-types/commands/ListActionTypesCommand.d.ts +5 -5
- package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +2 -2
- package/dist-types/commands/ListWebhooksCommand.d.ts +4 -4
- package/dist-types/commands/PollForJobsCommand.d.ts +16 -16
- package/dist-types/commands/PollForThirdPartyJobsCommand.d.ts +7 -7
- package/dist-types/commands/PutActionRevisionCommand.d.ts +2 -1
- package/dist-types/commands/PutApprovalResultCommand.d.ts +2 -2
- package/dist-types/commands/PutJobFailureResultCommand.d.ts +1 -1
- package/dist-types/commands/PutThirdPartyJobFailureResultCommand.d.ts +1 -1
- package/dist-types/commands/PutWebhookCommand.d.ts +12 -11
- package/dist-types/commands/RetryStageExecutionCommand.d.ts +4 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionTypeCommand.d.ts +2 -2
- package/dist-types/commands/UpdatePipelineCommand.d.ts +16 -16
- package/dist-types/index.d.ts +83 -84
- package/dist-types/models/models_0.d.ts +195 -178
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +1 -1
|
@@ -184,198 +184,197 @@ export interface CodePipelineClientResolvedConfig extends CodePipelineClientReso
|
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
186
|
* @public
|
|
187
|
-
* <fullname>
|
|
188
|
-
*
|
|
187
|
+
* <fullname>CodePipeline</fullname>
|
|
188
|
+
* <p>
|
|
189
189
|
* <b>Overview</b>
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* actions and data types for
|
|
193
|
-
* only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
* <p>
|
|
190
|
+
* </p>
|
|
191
|
+
* <p>This is the CodePipeline API Reference. This guide provides descriptions
|
|
192
|
+
* of the actions and data types for CodePipeline. Some functionality for your
|
|
193
|
+
* pipeline can only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">CodePipeline User Guide</a>.</p>
|
|
194
|
+
* <p>You can use the CodePipeline API to work with pipelines, stages, actions,
|
|
195
|
+
* and transitions.</p>
|
|
196
|
+
* <p>
|
|
198
197
|
* <i>Pipelines</i> are models of automated release processes. Each pipeline
|
|
199
198
|
* is uniquely named, and consists of stages, actions, and transitions. </p>
|
|
200
|
-
*
|
|
201
|
-
*
|
|
199
|
+
* <p>You can work with pipelines by calling:</p>
|
|
200
|
+
* <ul>
|
|
202
201
|
* <li>
|
|
203
|
-
*
|
|
204
|
-
*
|
|
202
|
+
* <p>
|
|
203
|
+
* <a>CreatePipeline</a>, which creates a uniquely named
|
|
205
204
|
* pipeline.</p>
|
|
206
205
|
* </li>
|
|
207
206
|
* <li>
|
|
208
|
-
*
|
|
209
|
-
*
|
|
207
|
+
* <p>
|
|
208
|
+
* <a>DeletePipeline</a>, which deletes the specified
|
|
210
209
|
* pipeline.</p>
|
|
211
210
|
* </li>
|
|
212
211
|
* <li>
|
|
213
|
-
*
|
|
214
|
-
*
|
|
212
|
+
* <p>
|
|
213
|
+
* <a>GetPipeline</a>, which returns information about the pipeline
|
|
215
214
|
* structure and pipeline metadata, including the pipeline Amazon Resource Name
|
|
216
215
|
* (ARN).</p>
|
|
217
216
|
* </li>
|
|
218
217
|
* <li>
|
|
219
|
-
*
|
|
220
|
-
*
|
|
218
|
+
* <p>
|
|
219
|
+
* <a>GetPipelineExecution</a>, which returns information about a
|
|
221
220
|
* specific execution of a pipeline.</p>
|
|
222
221
|
* </li>
|
|
223
222
|
* <li>
|
|
224
|
-
*
|
|
225
|
-
*
|
|
223
|
+
* <p>
|
|
224
|
+
* <a>GetPipelineState</a>, which returns information about the current
|
|
226
225
|
* state of the stages and actions of a pipeline.</p>
|
|
227
226
|
* </li>
|
|
228
227
|
* <li>
|
|
229
|
-
*
|
|
228
|
+
* <p>
|
|
230
229
|
* <a>ListActionExecutions</a>, which returns action-level details
|
|
231
230
|
* for past executions. The details include full stage and action-level details,
|
|
232
231
|
* including individual action duration, status, any errors that occurred during
|
|
233
232
|
* the execution, and input and output artifact location details.</p>
|
|
234
233
|
* </li>
|
|
235
234
|
* <li>
|
|
236
|
-
*
|
|
237
|
-
*
|
|
235
|
+
* <p>
|
|
236
|
+
* <a>ListPipelines</a>, which gets a summary of all of the pipelines
|
|
238
237
|
* associated with your account.</p>
|
|
239
238
|
* </li>
|
|
240
239
|
* <li>
|
|
241
|
-
*
|
|
242
|
-
*
|
|
240
|
+
* <p>
|
|
241
|
+
* <a>ListPipelineExecutions</a>, which gets a summary of the most
|
|
243
242
|
* recent executions for a pipeline.</p>
|
|
244
243
|
* </li>
|
|
245
244
|
* <li>
|
|
246
|
-
*
|
|
247
|
-
*
|
|
245
|
+
* <p>
|
|
246
|
+
* <a>StartPipelineExecution</a>, which runs the most recent revision of
|
|
248
247
|
* an artifact through the pipeline.</p>
|
|
249
248
|
* </li>
|
|
250
249
|
* <li>
|
|
251
|
-
*
|
|
252
|
-
*
|
|
250
|
+
* <p>
|
|
251
|
+
* <a>StopPipelineExecution</a>, which stops the specified pipeline
|
|
253
252
|
* execution from continuing through the pipeline.</p>
|
|
254
253
|
* </li>
|
|
255
254
|
* <li>
|
|
256
|
-
*
|
|
257
|
-
*
|
|
255
|
+
* <p>
|
|
256
|
+
* <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
|
|
258
257
|
* to the structure of the pipeline.</p>
|
|
259
258
|
* </li>
|
|
260
259
|
* </ul>
|
|
261
|
-
*
|
|
260
|
+
* <p>Pipelines include <i>stages</i>. Each stage contains one or more
|
|
262
261
|
* actions that must complete before the next stage begins. A stage results in success or
|
|
263
262
|
* failure. If a stage fails, the pipeline stops at that stage and remains stopped until
|
|
264
263
|
* either a new version of an artifact appears in the source location, or a user takes
|
|
265
264
|
* action to rerun the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the
|
|
266
265
|
* status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
|
|
267
266
|
* entire structure of the pipeline, including the stages of that pipeline. For more
|
|
268
|
-
* information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">
|
|
267
|
+
* information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline
|
|
269
268
|
* Pipeline Structure Reference</a>.</p>
|
|
270
|
-
*
|
|
269
|
+
* <p>Pipeline stages include <i>actions</i> that are categorized into
|
|
271
270
|
* categories such as source or build actions performed in a stage of a pipeline. For
|
|
272
271
|
* example, you can use a source action to import artifacts into a pipeline from a source
|
|
273
272
|
* such as Amazon S3. Like stages, you do not work with actions directly in most cases, but
|
|
274
273
|
* you do define and interact with actions when working with pipeline operations such as
|
|
275
274
|
* <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid
|
|
276
275
|
* action categories are:</p>
|
|
277
|
-
*
|
|
276
|
+
* <ul>
|
|
278
277
|
* <li>
|
|
279
|
-
*
|
|
278
|
+
* <p>Source</p>
|
|
280
279
|
* </li>
|
|
281
280
|
* <li>
|
|
282
|
-
*
|
|
281
|
+
* <p>Build</p>
|
|
283
282
|
* </li>
|
|
284
283
|
* <li>
|
|
285
|
-
*
|
|
284
|
+
* <p>Test</p>
|
|
286
285
|
* </li>
|
|
287
286
|
* <li>
|
|
288
|
-
*
|
|
287
|
+
* <p>Deploy</p>
|
|
289
288
|
* </li>
|
|
290
289
|
* <li>
|
|
291
|
-
*
|
|
290
|
+
* <p>Approval</p>
|
|
292
291
|
* </li>
|
|
293
292
|
* <li>
|
|
294
|
-
*
|
|
293
|
+
* <p>Invoke</p>
|
|
295
294
|
* </li>
|
|
296
295
|
* </ul>
|
|
297
|
-
*
|
|
296
|
+
* <p>Pipelines also include <i>transitions</i>, which allow the transition
|
|
298
297
|
* of artifacts from one stage to the next in a pipeline after the actions in one stage
|
|
299
298
|
* complete.</p>
|
|
300
|
-
*
|
|
301
|
-
*
|
|
299
|
+
* <p>You can work with transitions by calling:</p>
|
|
300
|
+
* <ul>
|
|
302
301
|
* <li>
|
|
303
|
-
*
|
|
304
|
-
*
|
|
302
|
+
* <p>
|
|
303
|
+
* <a>DisableStageTransition</a>, which prevents artifacts from
|
|
305
304
|
* transitioning to the next stage in a pipeline.</p>
|
|
306
305
|
* </li>
|
|
307
306
|
* <li>
|
|
308
|
-
*
|
|
309
|
-
*
|
|
307
|
+
* <p>
|
|
308
|
+
* <a>EnableStageTransition</a>, which enables transition of artifacts
|
|
310
309
|
* between stages in a pipeline. </p>
|
|
311
310
|
* </li>
|
|
312
311
|
* </ul>
|
|
313
|
-
*
|
|
314
|
-
* <b>Using the API to integrate with
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
* with
|
|
318
|
-
* integrate with
|
|
312
|
+
* <p>
|
|
313
|
+
* <b>Using the API to integrate with CodePipeline</b>
|
|
314
|
+
* </p>
|
|
315
|
+
* <p>For third-party integrators or developers who want to create their own integrations
|
|
316
|
+
* with CodePipeline, the expected sequence varies from the standard API user. To
|
|
317
|
+
* integrate with CodePipeline, developers need to work with the following
|
|
319
318
|
* items:</p>
|
|
320
|
-
*
|
|
319
|
+
* <p>
|
|
321
320
|
* <b>Jobs</b>, which are instances of an action. For
|
|
322
321
|
* example, a job for a source action might import a revision of an artifact from a source. </p>
|
|
323
|
-
*
|
|
324
|
-
*
|
|
322
|
+
* <p>You can work with jobs by calling:</p>
|
|
323
|
+
* <ul>
|
|
325
324
|
* <li>
|
|
326
|
-
*
|
|
327
|
-
*
|
|
325
|
+
* <p>
|
|
326
|
+
* <a>AcknowledgeJob</a>, which confirms whether a job worker has
|
|
328
327
|
* received the specified job.</p>
|
|
329
328
|
* </li>
|
|
330
329
|
* <li>
|
|
331
|
-
*
|
|
332
|
-
*
|
|
330
|
+
* <p>
|
|
331
|
+
* <a>GetJobDetails</a>, which returns the details of a job.</p>
|
|
333
332
|
* </li>
|
|
334
333
|
* <li>
|
|
335
|
-
*
|
|
336
|
-
*
|
|
334
|
+
* <p>
|
|
335
|
+
* <a>PollForJobs</a>, which determines whether there are any jobs to
|
|
337
336
|
* act on.</p>
|
|
338
337
|
* </li>
|
|
339
338
|
* <li>
|
|
340
|
-
*
|
|
341
|
-
*
|
|
339
|
+
* <p>
|
|
340
|
+
* <a>PutJobFailureResult</a>, which provides details of a job failure.
|
|
342
341
|
* </p>
|
|
343
342
|
* </li>
|
|
344
343
|
* <li>
|
|
345
|
-
*
|
|
346
|
-
*
|
|
344
|
+
* <p>
|
|
345
|
+
* <a>PutJobSuccessResult</a>, which provides details of a job
|
|
347
346
|
* success.</p>
|
|
348
347
|
* </li>
|
|
349
348
|
* </ul>
|
|
350
|
-
*
|
|
349
|
+
* <p>
|
|
351
350
|
* <b>Third party jobs</b>, which are instances of an action
|
|
352
|
-
* created by a partner action and integrated into
|
|
353
|
-
* created by members of the
|
|
354
|
-
*
|
|
355
|
-
*
|
|
351
|
+
* created by a partner action and integrated into CodePipeline. Partner actions are
|
|
352
|
+
* created by members of the Amazon Web Services Partner Network.</p>
|
|
353
|
+
* <p>You can work with third party jobs by calling:</p>
|
|
354
|
+
* <ul>
|
|
356
355
|
* <li>
|
|
357
|
-
*
|
|
358
|
-
*
|
|
356
|
+
* <p>
|
|
357
|
+
* <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
|
|
359
358
|
* has received the specified job.</p>
|
|
360
359
|
* </li>
|
|
361
360
|
* <li>
|
|
362
|
-
*
|
|
363
|
-
*
|
|
361
|
+
* <p>
|
|
362
|
+
* <a>GetThirdPartyJobDetails</a>, which requests the details of a job
|
|
364
363
|
* for a partner action.</p>
|
|
365
364
|
* </li>
|
|
366
365
|
* <li>
|
|
367
|
-
*
|
|
368
|
-
*
|
|
366
|
+
* <p>
|
|
367
|
+
* <a>PollForThirdPartyJobs</a>, which determines whether there are any
|
|
369
368
|
* jobs to act on. </p>
|
|
370
369
|
* </li>
|
|
371
370
|
* <li>
|
|
372
|
-
*
|
|
373
|
-
*
|
|
371
|
+
* <p>
|
|
372
|
+
* <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
|
|
374
373
|
* failure.</p>
|
|
375
374
|
* </li>
|
|
376
375
|
* <li>
|
|
377
|
-
*
|
|
378
|
-
*
|
|
376
|
+
* <p>
|
|
377
|
+
* <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
|
|
379
378
|
* success.</p>
|
|
380
379
|
* </li>
|
|
381
380
|
* </ul>
|
|
@@ -38,7 +38,7 @@ export interface AcknowledgeJobCommandOutput extends AcknowledgeJobOutput, __Met
|
|
|
38
38
|
* const command = new AcknowledgeJobCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
40
|
* // { // AcknowledgeJobOutput
|
|
41
|
-
* // status: "
|
|
41
|
+
* // status: "Created" || "Queued" || "Dispatched" || "InProgress" || "TimedOut" || "Succeeded" || "Failed",
|
|
42
42
|
* // };
|
|
43
43
|
*
|
|
44
44
|
* ```
|
|
@@ -39,7 +39,7 @@ export interface AcknowledgeThirdPartyJobCommandOutput extends AcknowledgeThirdP
|
|
|
39
39
|
* const command = new AcknowledgeThirdPartyJobCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
41
|
* // { // AcknowledgeThirdPartyJobOutput
|
|
42
|
-
* // status: "
|
|
42
|
+
* // status: "Created" || "Queued" || "Dispatched" || "InProgress" || "TimedOut" || "Succeeded" || "Failed",
|
|
43
43
|
* // };
|
|
44
44
|
*
|
|
45
45
|
* ```
|
|
@@ -24,7 +24,7 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a new custom action that can be used in all pipelines associated with the
|
|
27
|
-
*
|
|
27
|
+
* Amazon Web Services account. Only used for custom actions.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -32,7 +32,7 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
32
32
|
* // const { CodePipelineClient, CreateCustomActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
|
|
33
33
|
* const client = new CodePipelineClient(config);
|
|
34
34
|
* const input = { // CreateCustomActionTypeInput
|
|
35
|
-
* category: "
|
|
35
|
+
* category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
36
36
|
* provider: "STRING_VALUE", // required
|
|
37
37
|
* version: "STRING_VALUE", // required
|
|
38
38
|
* settings: { // ActionTypeSettings
|
|
@@ -49,7 +49,7 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
49
49
|
* secret: true || false, // required
|
|
50
50
|
* queryable: true || false,
|
|
51
51
|
* description: "STRING_VALUE",
|
|
52
|
-
* type: "
|
|
52
|
+
* type: "String" || "Number" || "Boolean",
|
|
53
53
|
* },
|
|
54
54
|
* ],
|
|
55
55
|
* inputArtifactDetails: { // ArtifactDetails
|
|
@@ -72,8 +72,8 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
72
72
|
* // { // CreateCustomActionTypeOutput
|
|
73
73
|
* // actionType: { // ActionType
|
|
74
74
|
* // id: { // ActionTypeId
|
|
75
|
-
* // category: "
|
|
76
|
-
* // owner: "
|
|
75
|
+
* // category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
76
|
+
* // owner: "AWS" || "ThirdParty" || "Custom", // required
|
|
77
77
|
* // provider: "STRING_VALUE", // required
|
|
78
78
|
* // version: "STRING_VALUE", // required
|
|
79
79
|
* // },
|
|
@@ -91,7 +91,7 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
91
91
|
* // secret: true || false, // required
|
|
92
92
|
* // queryable: true || false,
|
|
93
93
|
* // description: "STRING_VALUE",
|
|
94
|
-
* // type: "
|
|
94
|
+
* // type: "String" || "Number" || "Boolean",
|
|
95
95
|
* // },
|
|
96
96
|
* // ],
|
|
97
97
|
* // inputArtifactDetails: { // ArtifactDetails
|
|
@@ -126,8 +126,8 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT
|
|
|
126
126
|
* <p>The specified resource tags are invalid.</p>
|
|
127
127
|
*
|
|
128
128
|
* @throws {@link LimitExceededException} (client fault)
|
|
129
|
-
* <p>The number of pipelines associated with the
|
|
130
|
-
* allowed for the account.</p>
|
|
129
|
+
* <p>The number of pipelines associated with the Amazon Web Services account has exceeded
|
|
130
|
+
* the limit allowed for the account.</p>
|
|
131
131
|
*
|
|
132
132
|
* @throws {@link TooManyTagsException} (client fault)
|
|
133
133
|
* <p>The tags limit for a resource has been exceeded.</p>
|
|
@@ -24,12 +24,12 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a pipeline.</p>
|
|
27
|
-
*
|
|
27
|
+
* <note>
|
|
28
28
|
* <p>In the pipeline structure, you must include either <code>artifactStore</code>
|
|
29
29
|
* or <code>artifactStores</code> in your pipeline, but you cannot use both. If you
|
|
30
30
|
* create a cross-region action in your pipeline, you must use
|
|
31
31
|
* <code>artifactStores</code>.</p>
|
|
32
|
-
*
|
|
32
|
+
* </note>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -41,20 +41,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
41
41
|
* name: "STRING_VALUE", // required
|
|
42
42
|
* roleArn: "STRING_VALUE", // required
|
|
43
43
|
* artifactStore: { // ArtifactStore
|
|
44
|
-
* type: "
|
|
44
|
+
* type: "S3", // required
|
|
45
45
|
* location: "STRING_VALUE", // required
|
|
46
46
|
* encryptionKey: { // EncryptionKey
|
|
47
47
|
* id: "STRING_VALUE", // required
|
|
48
|
-
* type: "
|
|
48
|
+
* type: "KMS", // required
|
|
49
49
|
* },
|
|
50
50
|
* },
|
|
51
51
|
* artifactStores: { // ArtifactStoreMap
|
|
52
52
|
* "<keys>": {
|
|
53
|
-
* type: "
|
|
53
|
+
* type: "S3", // required
|
|
54
54
|
* location: "STRING_VALUE", // required
|
|
55
55
|
* encryptionKey: {
|
|
56
56
|
* id: "STRING_VALUE", // required
|
|
57
|
-
* type: "
|
|
57
|
+
* type: "KMS", // required
|
|
58
58
|
* },
|
|
59
59
|
* },
|
|
60
60
|
* },
|
|
@@ -64,15 +64,15 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
64
64
|
* blockers: [ // StageBlockerDeclarationList
|
|
65
65
|
* { // BlockerDeclaration
|
|
66
66
|
* name: "STRING_VALUE", // required
|
|
67
|
-
* type: "
|
|
67
|
+
* type: "Schedule", // required
|
|
68
68
|
* },
|
|
69
69
|
* ],
|
|
70
70
|
* actions: [ // StageActionDeclarationList // required
|
|
71
71
|
* { // ActionDeclaration
|
|
72
72
|
* name: "STRING_VALUE", // required
|
|
73
73
|
* actionTypeId: { // ActionTypeId
|
|
74
|
-
* category: "
|
|
75
|
-
* owner: "
|
|
74
|
+
* category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
75
|
+
* owner: "AWS" || "ThirdParty" || "Custom", // required
|
|
76
76
|
* provider: "STRING_VALUE", // required
|
|
77
77
|
* version: "STRING_VALUE", // required
|
|
78
78
|
* },
|
|
@@ -113,20 +113,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
113
113
|
* // name: "STRING_VALUE", // required
|
|
114
114
|
* // roleArn: "STRING_VALUE", // required
|
|
115
115
|
* // artifactStore: { // ArtifactStore
|
|
116
|
-
* // type: "
|
|
116
|
+
* // type: "S3", // required
|
|
117
117
|
* // location: "STRING_VALUE", // required
|
|
118
118
|
* // encryptionKey: { // EncryptionKey
|
|
119
119
|
* // id: "STRING_VALUE", // required
|
|
120
|
-
* // type: "
|
|
120
|
+
* // type: "KMS", // required
|
|
121
121
|
* // },
|
|
122
122
|
* // },
|
|
123
123
|
* // artifactStores: { // ArtifactStoreMap
|
|
124
124
|
* // "<keys>": {
|
|
125
|
-
* // type: "
|
|
125
|
+
* // type: "S3", // required
|
|
126
126
|
* // location: "STRING_VALUE", // required
|
|
127
127
|
* // encryptionKey: {
|
|
128
128
|
* // id: "STRING_VALUE", // required
|
|
129
|
-
* // type: "
|
|
129
|
+
* // type: "KMS", // required
|
|
130
130
|
* // },
|
|
131
131
|
* // },
|
|
132
132
|
* // },
|
|
@@ -136,15 +136,15 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
136
136
|
* // blockers: [ // StageBlockerDeclarationList
|
|
137
137
|
* // { // BlockerDeclaration
|
|
138
138
|
* // name: "STRING_VALUE", // required
|
|
139
|
-
* // type: "
|
|
139
|
+
* // type: "Schedule", // required
|
|
140
140
|
* // },
|
|
141
141
|
* // ],
|
|
142
142
|
* // actions: [ // StageActionDeclarationList // required
|
|
143
143
|
* // { // ActionDeclaration
|
|
144
144
|
* // name: "STRING_VALUE", // required
|
|
145
145
|
* // actionTypeId: { // ActionTypeId
|
|
146
|
-
* // category: "
|
|
147
|
-
* // owner: "
|
|
146
|
+
* // category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
147
|
+
* // owner: "AWS" || "ThirdParty" || "Custom", // required
|
|
148
148
|
* // provider: "STRING_VALUE", // required
|
|
149
149
|
* // version: "STRING_VALUE", // required
|
|
150
150
|
* // },
|
|
@@ -206,8 +206,8 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
206
206
|
* <p>The specified resource tags are invalid.</p>
|
|
207
207
|
*
|
|
208
208
|
* @throws {@link LimitExceededException} (client fault)
|
|
209
|
-
* <p>The number of pipelines associated with the
|
|
210
|
-
* allowed for the account.</p>
|
|
209
|
+
* <p>The number of pipelines associated with the Amazon Web Services account has exceeded
|
|
210
|
+
* the limit allowed for the account.</p>
|
|
211
211
|
*
|
|
212
212
|
* @throws {@link PipelineNameInUseException} (client fault)
|
|
213
213
|
* <p>The specified pipeline name is already in use.</p>
|
|
@@ -25,13 +25,13 @@ export interface DeleteCustomActionTypeCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Marks a custom action as deleted. <code>PollForJobs</code> for the custom action
|
|
27
27
|
* fails after the action is marked for deletion. Used for custom actions only.</p>
|
|
28
|
-
*
|
|
28
|
+
* <important>
|
|
29
29
|
* <p>To re-create a custom action after it has been deleted you must use a string in
|
|
30
30
|
* the version field that has never been used before. This string can be an incremented
|
|
31
31
|
* version number, for example. To restore a deleted custom action, use a JSON file
|
|
32
32
|
* that is identical to the deleted action, including the original string in the
|
|
33
33
|
* version field.</p>
|
|
34
|
-
*
|
|
34
|
+
* </important>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -39,7 +39,7 @@ export interface DeleteCustomActionTypeCommandOutput extends __MetadataBearer {
|
|
|
39
39
|
* // const { CodePipelineClient, DeleteCustomActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
|
|
40
40
|
* const client = new CodePipelineClient(config);
|
|
41
41
|
* const input = { // DeleteCustomActionTypeInput
|
|
42
|
-
* category: "
|
|
42
|
+
* category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
43
43
|
* provider: "STRING_VALUE", // required
|
|
44
44
|
* version: "STRING_VALUE", // required
|
|
45
45
|
* };
|
|
@@ -23,8 +23,7 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookOutput, __Metad
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes a previously created webhook by name. Deleting the webhook stops
|
|
27
|
-
* CodePipeline from starting a pipeline every time an external event occurs. The API
|
|
26
|
+
* <p>Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API
|
|
28
27
|
* returns successfully when trying to delete a webhook that is already deleted. If a
|
|
29
28
|
* deleted webhook is re-created by calling PutWebhook with the same name, it will have a
|
|
30
29
|
* different URL.</p>
|
|
@@ -23,9 +23,9 @@ export interface DeregisterWebhookWithThirdPartyCommandOutput extends Deregister
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Removes the connection between the webhook that was created by CodePipeline
|
|
27
|
-
* external tool with events to be detected. Currently supported only for webhooks
|
|
28
|
-
* target an action type of GitHub.</p>
|
|
26
|
+
* <p>Removes the connection between the webhook that was created by CodePipeline
|
|
27
|
+
* and the external tool with events to be detected. Currently supported only for webhooks
|
|
28
|
+
* that target an action type of GitHub.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -34,7 +34,7 @@ export interface DisableStageTransitionCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* const input = { // DisableStageTransitionInput
|
|
35
35
|
* pipelineName: "STRING_VALUE", // required
|
|
36
36
|
* stageName: "STRING_VALUE", // required
|
|
37
|
-
* transitionType: "
|
|
37
|
+
* transitionType: "Inbound" || "Outbound", // required
|
|
38
38
|
* reason: "STRING_VALUE", // required
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DisableStageTransitionCommand(input);
|
|
@@ -33,7 +33,7 @@ export interface EnableStageTransitionCommandOutput extends __MetadataBearer {
|
|
|
33
33
|
* const input = { // EnableStageTransitionInput
|
|
34
34
|
* pipelineName: "STRING_VALUE", // required
|
|
35
35
|
* stageName: "STRING_VALUE", // required
|
|
36
|
-
* transitionType: "
|
|
36
|
+
* transitionType: "Inbound" || "Outbound", // required
|
|
37
37
|
* };
|
|
38
38
|
* const command = new EnableStageTransitionCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
@@ -33,7 +33,7 @@ export interface GetActionTypeCommandOutput extends GetActionTypeOutput, __Metad
|
|
|
33
33
|
* // const { CodePipelineClient, GetActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
|
|
34
34
|
* const client = new CodePipelineClient(config);
|
|
35
35
|
* const input = { // GetActionTypeInput
|
|
36
|
-
* category: "
|
|
36
|
+
* category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
37
37
|
* owner: "STRING_VALUE", // required
|
|
38
38
|
* provider: "STRING_VALUE", // required
|
|
39
39
|
* version: "STRING_VALUE", // required
|
|
@@ -57,12 +57,12 @@ export interface GetActionTypeCommandOutput extends GetActionTypeOutput, __Metad
|
|
|
57
57
|
* // ],
|
|
58
58
|
* // },
|
|
59
59
|
* // },
|
|
60
|
-
* // type: "
|
|
60
|
+
* // type: "JobWorker" || "Lambda", // required
|
|
61
61
|
* // policyStatementsTemplate: "STRING_VALUE",
|
|
62
62
|
* // jobTimeout: Number("int"),
|
|
63
63
|
* // },
|
|
64
64
|
* // id: { // ActionTypeIdentifier
|
|
65
|
-
* // category: "
|
|
65
|
+
* // category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
66
66
|
* // owner: "STRING_VALUE", // required
|
|
67
67
|
* // provider: "STRING_VALUE", // required
|
|
68
68
|
* // version: "STRING_VALUE", // required
|
|
@@ -24,12 +24,12 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about a job. Used for custom actions only.</p>
|
|
27
|
-
*
|
|
28
|
-
* <p>When this API is called,
|
|
29
|
-
* S3 bucket used to store artifacts for the pipeline, if the action requires
|
|
30
|
-
* that S3 bucket for input or output artifacts. This API also returns any
|
|
31
|
-
* values defined for the action.</p>
|
|
32
|
-
*
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>When this API is called, CodePipeline returns temporary credentials for
|
|
29
|
+
* the S3 bucket used to store artifacts for the pipeline, if the action requires
|
|
30
|
+
* access to that S3 bucket for input or output artifacts. This API also returns any
|
|
31
|
+
* secret values defined for the action.</p>
|
|
32
|
+
* </important>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -46,8 +46,8 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad
|
|
|
46
46
|
* // id: "STRING_VALUE",
|
|
47
47
|
* // data: { // JobData
|
|
48
48
|
* // actionTypeId: { // ActionTypeId
|
|
49
|
-
* // category: "
|
|
50
|
-
* // owner: "
|
|
49
|
+
* // category: "Source" || "Build" || "Deploy" || "Test" || "Invoke" || "Approval", // required
|
|
50
|
+
* // owner: "AWS" || "ThirdParty" || "Custom", // required
|
|
51
51
|
* // provider: "STRING_VALUE", // required
|
|
52
52
|
* // version: "STRING_VALUE", // required
|
|
53
53
|
* // },
|
|
@@ -73,7 +73,7 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad
|
|
|
73
73
|
* // name: "STRING_VALUE",
|
|
74
74
|
* // revision: "STRING_VALUE",
|
|
75
75
|
* // location: { // ArtifactLocation
|
|
76
|
-
* // type: "
|
|
76
|
+
* // type: "S3",
|
|
77
77
|
* // s3Location: { // S3ArtifactLocation
|
|
78
78
|
* // bucketName: "STRING_VALUE", // required
|
|
79
79
|
* // objectKey: "STRING_VALUE", // required
|
|
@@ -86,7 +86,7 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad
|
|
|
86
86
|
* // name: "STRING_VALUE",
|
|
87
87
|
* // revision: "STRING_VALUE",
|
|
88
88
|
* // location: {
|
|
89
|
-
* // type: "
|
|
89
|
+
* // type: "S3",
|
|
90
90
|
* // s3Location: {
|
|
91
91
|
* // bucketName: "STRING_VALUE", // required
|
|
92
92
|
* // objectKey: "STRING_VALUE", // required
|
|
@@ -102,7 +102,7 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad
|
|
|
102
102
|
* // continuationToken: "STRING_VALUE",
|
|
103
103
|
* // encryptionKey: { // EncryptionKey
|
|
104
104
|
* // id: "STRING_VALUE", // required
|
|
105
|
-
* // type: "
|
|
105
|
+
* // type: "KMS", // required
|
|
106
106
|
* // },
|
|
107
107
|
* // },
|
|
108
108
|
* // accountId: "STRING_VALUE",
|