@aws-sdk/client-codepipeline 3.337.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/CodePipelineClient.js +2 -1
- package/dist-cjs/commands/AcknowledgeJobCommand.js +2 -1
- package/dist-cjs/commands/AcknowledgeThirdPartyJobCommand.js +2 -1
- package/dist-cjs/commands/CreateCustomActionTypeCommand.js +2 -1
- package/dist-cjs/commands/CreatePipelineCommand.js +2 -1
- package/dist-cjs/commands/DeleteCustomActionTypeCommand.js +2 -1
- package/dist-cjs/commands/DeletePipelineCommand.js +2 -1
- package/dist-cjs/commands/DeleteWebhookCommand.js +2 -1
- package/dist-cjs/commands/DeregisterWebhookWithThirdPartyCommand.js +2 -1
- package/dist-cjs/commands/DisableStageTransitionCommand.js +2 -1
- package/dist-cjs/commands/EnableStageTransitionCommand.js +2 -1
- package/dist-cjs/commands/GetActionTypeCommand.js +2 -1
- package/dist-cjs/commands/GetJobDetailsCommand.js +2 -1
- package/dist-cjs/commands/GetPipelineCommand.js +2 -1
- package/dist-cjs/commands/GetPipelineExecutionCommand.js +2 -1
- package/dist-cjs/commands/GetPipelineStateCommand.js +2 -1
- package/dist-cjs/commands/GetThirdPartyJobDetailsCommand.js +2 -1
- package/dist-cjs/commands/ListActionExecutionsCommand.js +2 -1
- package/dist-cjs/commands/ListActionTypesCommand.js +2 -1
- package/dist-cjs/commands/ListPipelineExecutionsCommand.js +2 -1
- package/dist-cjs/commands/ListPipelinesCommand.js +2 -1
- package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -1
- package/dist-cjs/commands/ListWebhooksCommand.js +2 -1
- package/dist-cjs/commands/PollForJobsCommand.js +2 -1
- package/dist-cjs/commands/PollForThirdPartyJobsCommand.js +2 -1
- package/dist-cjs/commands/PutActionRevisionCommand.js +2 -1
- package/dist-cjs/commands/PutApprovalResultCommand.js +2 -1
- package/dist-cjs/commands/PutJobFailureResultCommand.js +2 -1
- package/dist-cjs/commands/PutJobSuccessResultCommand.js +2 -1
- package/dist-cjs/commands/PutThirdPartyJobFailureResultCommand.js +2 -1
- package/dist-cjs/commands/PutThirdPartyJobSuccessResultCommand.js +2 -1
- package/dist-cjs/commands/PutWebhookCommand.js +2 -1
- package/dist-cjs/commands/RegisterWebhookWithThirdPartyCommand.js +2 -1
- package/dist-cjs/commands/RetryStageExecutionCommand.js +2 -1
- package/dist-cjs/commands/StartPipelineExecutionCommand.js +2 -1
- package/dist-cjs/commands/StopPipelineExecutionCommand.js +2 -1
- package/dist-cjs/commands/TagResourceCommand.js +2 -1
- package/dist-cjs/commands/UntagResourceCommand.js +2 -1
- package/dist-cjs/commands/UpdateActionTypeCommand.js +2 -1
- package/dist-cjs/commands/UpdatePipelineCommand.js +2 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/index.js +2 -2
- package/dist-cjs/models/CodePipelineServiceException.js +2 -1
- package/dist-cjs/protocols/Aws_json1_1.js +1 -0
- package/dist-es/CodePipelineClient.js +1 -0
- package/dist-es/commands/AcknowledgeJobCommand.js +1 -0
- package/dist-es/commands/AcknowledgeThirdPartyJobCommand.js +1 -0
- package/dist-es/commands/CreateCustomActionTypeCommand.js +1 -0
- package/dist-es/commands/CreatePipelineCommand.js +1 -0
- package/dist-es/commands/DeleteCustomActionTypeCommand.js +1 -0
- package/dist-es/commands/DeletePipelineCommand.js +1 -0
- package/dist-es/commands/DeleteWebhookCommand.js +1 -0
- package/dist-es/commands/DeregisterWebhookWithThirdPartyCommand.js +1 -0
- package/dist-es/commands/DisableStageTransitionCommand.js +1 -0
- package/dist-es/commands/EnableStageTransitionCommand.js +1 -0
- package/dist-es/commands/GetActionTypeCommand.js +1 -0
- package/dist-es/commands/GetJobDetailsCommand.js +1 -0
- package/dist-es/commands/GetPipelineCommand.js +1 -0
- package/dist-es/commands/GetPipelineExecutionCommand.js +1 -0
- package/dist-es/commands/GetPipelineStateCommand.js +1 -0
- package/dist-es/commands/GetThirdPartyJobDetailsCommand.js +1 -0
- package/dist-es/commands/ListActionExecutionsCommand.js +1 -0
- package/dist-es/commands/ListActionTypesCommand.js +1 -0
- package/dist-es/commands/ListPipelineExecutionsCommand.js +1 -0
- package/dist-es/commands/ListPipelinesCommand.js +1 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +1 -0
- package/dist-es/commands/ListWebhooksCommand.js +1 -0
- package/dist-es/commands/PollForJobsCommand.js +1 -0
- package/dist-es/commands/PollForThirdPartyJobsCommand.js +1 -0
- package/dist-es/commands/PutActionRevisionCommand.js +1 -0
- package/dist-es/commands/PutApprovalResultCommand.js +1 -0
- package/dist-es/commands/PutJobFailureResultCommand.js +1 -0
- package/dist-es/commands/PutJobSuccessResultCommand.js +1 -0
- package/dist-es/commands/PutThirdPartyJobFailureResultCommand.js +1 -0
- package/dist-es/commands/PutThirdPartyJobSuccessResultCommand.js +1 -0
- package/dist-es/commands/PutWebhookCommand.js +1 -0
- package/dist-es/commands/RegisterWebhookWithThirdPartyCommand.js +1 -0
- package/dist-es/commands/RetryStageExecutionCommand.js +1 -0
- package/dist-es/commands/StartPipelineExecutionCommand.js +1 -0
- package/dist-es/commands/StopPipelineExecutionCommand.js +1 -0
- package/dist-es/commands/TagResourceCommand.js +1 -0
- package/dist-es/commands/UntagResourceCommand.js +1 -0
- package/dist-es/commands/UpdateActionTypeCommand.js +1 -0
- package/dist-es/commands/UpdatePipelineCommand.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/index.js +2 -2
- package/dist-es/models/CodePipelineServiceException.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +1 -0
- package/dist-types/CodePipeline.d.ts +83 -84
- package/dist-types/CodePipelineClient.d.ts +86 -87
- package/dist-types/commands/AcknowledgeJobCommand.d.ts +5 -1
- package/dist-types/commands/AcknowledgeThirdPartyJobCommand.d.ts +5 -1
- package/dist-types/commands/CreateCustomActionTypeCommand.d.ts +12 -8
- package/dist-types/commands/CreatePipelineCommand.d.ts +22 -18
- package/dist-types/commands/DeleteCustomActionTypeCommand.d.ts +7 -3
- package/dist-types/commands/DeletePipelineCommand.d.ts +4 -0
- package/dist-types/commands/DeleteWebhookCommand.d.ts +5 -2
- package/dist-types/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +7 -3
- package/dist-types/commands/DisableStageTransitionCommand.d.ts +5 -1
- package/dist-types/commands/EnableStageTransitionCommand.d.ts +5 -1
- package/dist-types/commands/GetActionTypeCommand.d.ts +7 -3
- package/dist-types/commands/GetJobDetailsCommand.d.ts +15 -11
- package/dist-types/commands/GetPipelineCommand.d.ts +12 -7
- package/dist-types/commands/GetPipelineExecutionCommand.d.ts +5 -1
- package/dist-types/commands/GetPipelineStateCommand.d.ts +9 -5
- package/dist-types/commands/GetThirdPartyJobDetailsCommand.d.ts +15 -11
- package/dist-types/commands/ListActionExecutionsCommand.d.ts +7 -3
- package/dist-types/commands/ListActionTypesCommand.d.ts +9 -5
- package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +6 -2
- package/dist-types/commands/ListPipelinesCommand.d.ts +4 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -0
- package/dist-types/commands/ListWebhooksCommand.d.ts +8 -4
- package/dist-types/commands/PollForJobsCommand.d.ts +20 -16
- package/dist-types/commands/PollForThirdPartyJobsCommand.d.ts +11 -7
- package/dist-types/commands/PutActionRevisionCommand.d.ts +6 -1
- package/dist-types/commands/PutApprovalResultCommand.d.ts +6 -2
- package/dist-types/commands/PutJobFailureResultCommand.d.ts +5 -1
- package/dist-types/commands/PutJobSuccessResultCommand.d.ts +4 -0
- package/dist-types/commands/PutThirdPartyJobFailureResultCommand.d.ts +5 -1
- package/dist-types/commands/PutThirdPartyJobSuccessResultCommand.d.ts +4 -0
- package/dist-types/commands/PutWebhookCommand.d.ts +16 -11
- package/dist-types/commands/RegisterWebhookWithThirdPartyCommand.d.ts +4 -0
- package/dist-types/commands/RetryStageExecutionCommand.d.ts +8 -3
- package/dist-types/commands/StartPipelineExecutionCommand.d.ts +4 -0
- package/dist-types/commands/StopPipelineExecutionCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -1
- package/dist-types/commands/UpdateActionTypeCommand.d.ts +6 -2
- package/dist-types/commands/UpdatePipelineCommand.d.ts +20 -16
- package/dist-types/index.d.ts +200 -2
- package/dist-types/models/CodePipelineServiceException.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +195 -178
- package/dist-types/ts3.4/CodePipelineClient.d.ts +3 -3
- package/dist-types/ts3.4/commands/AcknowledgeJobCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/AcknowledgeThirdPartyJobCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreateCustomActionTypeCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeleteCustomActionTypeCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeleteWebhookCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DisableStageTransitionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/EnableStageTransitionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetActionTypeCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetJobDetailsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetPipelineCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetPipelineExecutionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetPipelineStateCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetThirdPartyJobDetailsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListActionExecutionsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListActionTypesCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListPipelineExecutionsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ListWebhooksCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PollForJobsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PollForThirdPartyJobsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutActionRevisionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutApprovalResultCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutJobFailureResultCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutJobSuccessResultCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutThirdPartyJobFailureResultCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutThirdPartyJobSuccessResultCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/PutWebhookCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/RegisterWebhookWithThirdPartyCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/RetryStageExecutionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/StartPipelineExecutionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/StopPipelineExecutionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/UpdateActionTypeCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/UpdatePipelineCommand.d.ts +1 -0
- package/dist-types/ts3.4/index.d.ts +2 -2
- package/dist-types/ts3.4/models/CodePipelineServiceException.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +28 -28
|
@@ -277,198 +277,197 @@ export interface CodePipeline {
|
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
279
|
* @public
|
|
280
|
-
* <fullname>
|
|
281
|
-
*
|
|
280
|
+
* <fullname>CodePipeline</fullname>
|
|
281
|
+
* <p>
|
|
282
282
|
* <b>Overview</b>
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* actions and data types for
|
|
286
|
-
* only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
* <p>
|
|
283
|
+
* </p>
|
|
284
|
+
* <p>This is the CodePipeline API Reference. This guide provides descriptions
|
|
285
|
+
* of the actions and data types for CodePipeline. Some functionality for your
|
|
286
|
+
* 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>
|
|
287
|
+
* <p>You can use the CodePipeline API to work with pipelines, stages, actions,
|
|
288
|
+
* and transitions.</p>
|
|
289
|
+
* <p>
|
|
291
290
|
* <i>Pipelines</i> are models of automated release processes. Each pipeline
|
|
292
291
|
* is uniquely named, and consists of stages, actions, and transitions. </p>
|
|
293
|
-
*
|
|
294
|
-
*
|
|
292
|
+
* <p>You can work with pipelines by calling:</p>
|
|
293
|
+
* <ul>
|
|
295
294
|
* <li>
|
|
296
|
-
*
|
|
297
|
-
*
|
|
295
|
+
* <p>
|
|
296
|
+
* <a>CreatePipeline</a>, which creates a uniquely named
|
|
298
297
|
* pipeline.</p>
|
|
299
298
|
* </li>
|
|
300
299
|
* <li>
|
|
301
|
-
*
|
|
302
|
-
*
|
|
300
|
+
* <p>
|
|
301
|
+
* <a>DeletePipeline</a>, which deletes the specified
|
|
303
302
|
* pipeline.</p>
|
|
304
303
|
* </li>
|
|
305
304
|
* <li>
|
|
306
|
-
*
|
|
307
|
-
*
|
|
305
|
+
* <p>
|
|
306
|
+
* <a>GetPipeline</a>, which returns information about the pipeline
|
|
308
307
|
* structure and pipeline metadata, including the pipeline Amazon Resource Name
|
|
309
308
|
* (ARN).</p>
|
|
310
309
|
* </li>
|
|
311
310
|
* <li>
|
|
312
|
-
*
|
|
313
|
-
*
|
|
311
|
+
* <p>
|
|
312
|
+
* <a>GetPipelineExecution</a>, which returns information about a
|
|
314
313
|
* specific execution of a pipeline.</p>
|
|
315
314
|
* </li>
|
|
316
315
|
* <li>
|
|
317
|
-
*
|
|
318
|
-
*
|
|
316
|
+
* <p>
|
|
317
|
+
* <a>GetPipelineState</a>, which returns information about the current
|
|
319
318
|
* state of the stages and actions of a pipeline.</p>
|
|
320
319
|
* </li>
|
|
321
320
|
* <li>
|
|
322
|
-
*
|
|
321
|
+
* <p>
|
|
323
322
|
* <a>ListActionExecutions</a>, which returns action-level details
|
|
324
323
|
* for past executions. The details include full stage and action-level details,
|
|
325
324
|
* including individual action duration, status, any errors that occurred during
|
|
326
325
|
* the execution, and input and output artifact location details.</p>
|
|
327
326
|
* </li>
|
|
328
327
|
* <li>
|
|
329
|
-
*
|
|
330
|
-
*
|
|
328
|
+
* <p>
|
|
329
|
+
* <a>ListPipelines</a>, which gets a summary of all of the pipelines
|
|
331
330
|
* associated with your account.</p>
|
|
332
331
|
* </li>
|
|
333
332
|
* <li>
|
|
334
|
-
*
|
|
335
|
-
*
|
|
333
|
+
* <p>
|
|
334
|
+
* <a>ListPipelineExecutions</a>, which gets a summary of the most
|
|
336
335
|
* recent executions for a pipeline.</p>
|
|
337
336
|
* </li>
|
|
338
337
|
* <li>
|
|
339
|
-
*
|
|
340
|
-
*
|
|
338
|
+
* <p>
|
|
339
|
+
* <a>StartPipelineExecution</a>, which runs the most recent revision of
|
|
341
340
|
* an artifact through the pipeline.</p>
|
|
342
341
|
* </li>
|
|
343
342
|
* <li>
|
|
344
|
-
*
|
|
345
|
-
*
|
|
343
|
+
* <p>
|
|
344
|
+
* <a>StopPipelineExecution</a>, which stops the specified pipeline
|
|
346
345
|
* execution from continuing through the pipeline.</p>
|
|
347
346
|
* </li>
|
|
348
347
|
* <li>
|
|
349
|
-
*
|
|
350
|
-
*
|
|
348
|
+
* <p>
|
|
349
|
+
* <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
|
|
351
350
|
* to the structure of the pipeline.</p>
|
|
352
351
|
* </li>
|
|
353
352
|
* </ul>
|
|
354
|
-
*
|
|
353
|
+
* <p>Pipelines include <i>stages</i>. Each stage contains one or more
|
|
355
354
|
* actions that must complete before the next stage begins. A stage results in success or
|
|
356
355
|
* failure. If a stage fails, the pipeline stops at that stage and remains stopped until
|
|
357
356
|
* either a new version of an artifact appears in the source location, or a user takes
|
|
358
357
|
* 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
|
|
359
358
|
* status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
|
|
360
359
|
* entire structure of the pipeline, including the stages of that pipeline. For more
|
|
361
|
-
* information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">
|
|
360
|
+
* information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline
|
|
362
361
|
* Pipeline Structure Reference</a>.</p>
|
|
363
|
-
*
|
|
362
|
+
* <p>Pipeline stages include <i>actions</i> that are categorized into
|
|
364
363
|
* categories such as source or build actions performed in a stage of a pipeline. For
|
|
365
364
|
* example, you can use a source action to import artifacts into a pipeline from a source
|
|
366
365
|
* such as Amazon S3. Like stages, you do not work with actions directly in most cases, but
|
|
367
366
|
* you do define and interact with actions when working with pipeline operations such as
|
|
368
367
|
* <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid
|
|
369
368
|
* action categories are:</p>
|
|
370
|
-
*
|
|
369
|
+
* <ul>
|
|
371
370
|
* <li>
|
|
372
|
-
*
|
|
371
|
+
* <p>Source</p>
|
|
373
372
|
* </li>
|
|
374
373
|
* <li>
|
|
375
|
-
*
|
|
374
|
+
* <p>Build</p>
|
|
376
375
|
* </li>
|
|
377
376
|
* <li>
|
|
378
|
-
*
|
|
377
|
+
* <p>Test</p>
|
|
379
378
|
* </li>
|
|
380
379
|
* <li>
|
|
381
|
-
*
|
|
380
|
+
* <p>Deploy</p>
|
|
382
381
|
* </li>
|
|
383
382
|
* <li>
|
|
384
|
-
*
|
|
383
|
+
* <p>Approval</p>
|
|
385
384
|
* </li>
|
|
386
385
|
* <li>
|
|
387
|
-
*
|
|
386
|
+
* <p>Invoke</p>
|
|
388
387
|
* </li>
|
|
389
388
|
* </ul>
|
|
390
|
-
*
|
|
389
|
+
* <p>Pipelines also include <i>transitions</i>, which allow the transition
|
|
391
390
|
* of artifacts from one stage to the next in a pipeline after the actions in one stage
|
|
392
391
|
* complete.</p>
|
|
393
|
-
*
|
|
394
|
-
*
|
|
392
|
+
* <p>You can work with transitions by calling:</p>
|
|
393
|
+
* <ul>
|
|
395
394
|
* <li>
|
|
396
|
-
*
|
|
397
|
-
*
|
|
395
|
+
* <p>
|
|
396
|
+
* <a>DisableStageTransition</a>, which prevents artifacts from
|
|
398
397
|
* transitioning to the next stage in a pipeline.</p>
|
|
399
398
|
* </li>
|
|
400
399
|
* <li>
|
|
401
|
-
*
|
|
402
|
-
*
|
|
400
|
+
* <p>
|
|
401
|
+
* <a>EnableStageTransition</a>, which enables transition of artifacts
|
|
403
402
|
* between stages in a pipeline. </p>
|
|
404
403
|
* </li>
|
|
405
404
|
* </ul>
|
|
406
|
-
*
|
|
407
|
-
* <b>Using the API to integrate with
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
* with
|
|
411
|
-
* integrate with
|
|
405
|
+
* <p>
|
|
406
|
+
* <b>Using the API to integrate with CodePipeline</b>
|
|
407
|
+
* </p>
|
|
408
|
+
* <p>For third-party integrators or developers who want to create their own integrations
|
|
409
|
+
* with CodePipeline, the expected sequence varies from the standard API user. To
|
|
410
|
+
* integrate with CodePipeline, developers need to work with the following
|
|
412
411
|
* items:</p>
|
|
413
|
-
*
|
|
412
|
+
* <p>
|
|
414
413
|
* <b>Jobs</b>, which are instances of an action. For
|
|
415
414
|
* example, a job for a source action might import a revision of an artifact from a source. </p>
|
|
416
|
-
*
|
|
417
|
-
*
|
|
415
|
+
* <p>You can work with jobs by calling:</p>
|
|
416
|
+
* <ul>
|
|
418
417
|
* <li>
|
|
419
|
-
*
|
|
420
|
-
*
|
|
418
|
+
* <p>
|
|
419
|
+
* <a>AcknowledgeJob</a>, which confirms whether a job worker has
|
|
421
420
|
* received the specified job.</p>
|
|
422
421
|
* </li>
|
|
423
422
|
* <li>
|
|
424
|
-
*
|
|
425
|
-
*
|
|
423
|
+
* <p>
|
|
424
|
+
* <a>GetJobDetails</a>, which returns the details of a job.</p>
|
|
426
425
|
* </li>
|
|
427
426
|
* <li>
|
|
428
|
-
*
|
|
429
|
-
*
|
|
427
|
+
* <p>
|
|
428
|
+
* <a>PollForJobs</a>, which determines whether there are any jobs to
|
|
430
429
|
* act on.</p>
|
|
431
430
|
* </li>
|
|
432
431
|
* <li>
|
|
433
|
-
*
|
|
434
|
-
*
|
|
432
|
+
* <p>
|
|
433
|
+
* <a>PutJobFailureResult</a>, which provides details of a job failure.
|
|
435
434
|
* </p>
|
|
436
435
|
* </li>
|
|
437
436
|
* <li>
|
|
438
|
-
*
|
|
439
|
-
*
|
|
437
|
+
* <p>
|
|
438
|
+
* <a>PutJobSuccessResult</a>, which provides details of a job
|
|
440
439
|
* success.</p>
|
|
441
440
|
* </li>
|
|
442
441
|
* </ul>
|
|
443
|
-
*
|
|
442
|
+
* <p>
|
|
444
443
|
* <b>Third party jobs</b>, which are instances of an action
|
|
445
|
-
* created by a partner action and integrated into
|
|
446
|
-
* created by members of the
|
|
447
|
-
*
|
|
448
|
-
*
|
|
444
|
+
* created by a partner action and integrated into CodePipeline. Partner actions are
|
|
445
|
+
* created by members of the Amazon Web Services Partner Network.</p>
|
|
446
|
+
* <p>You can work with third party jobs by calling:</p>
|
|
447
|
+
* <ul>
|
|
449
448
|
* <li>
|
|
450
|
-
*
|
|
451
|
-
*
|
|
449
|
+
* <p>
|
|
450
|
+
* <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
|
|
452
451
|
* has received the specified job.</p>
|
|
453
452
|
* </li>
|
|
454
453
|
* <li>
|
|
455
|
-
*
|
|
456
|
-
*
|
|
454
|
+
* <p>
|
|
455
|
+
* <a>GetThirdPartyJobDetails</a>, which requests the details of a job
|
|
457
456
|
* for a partner action.</p>
|
|
458
457
|
* </li>
|
|
459
458
|
* <li>
|
|
460
|
-
*
|
|
461
|
-
*
|
|
459
|
+
* <p>
|
|
460
|
+
* <a>PollForThirdPartyJobs</a>, which determines whether there are any
|
|
462
461
|
* jobs to act on. </p>
|
|
463
462
|
* </li>
|
|
464
463
|
* <li>
|
|
465
|
-
*
|
|
466
|
-
*
|
|
464
|
+
* <p>
|
|
465
|
+
* <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
|
|
467
466
|
* failure.</p>
|
|
468
467
|
* </li>
|
|
469
468
|
* <li>
|
|
470
|
-
*
|
|
471
|
-
*
|
|
469
|
+
* <p>
|
|
470
|
+
* <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
|
|
472
471
|
* success.</p>
|
|
473
472
|
* </li>
|
|
474
473
|
* </ul>
|
|
@@ -48,6 +48,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
48
48
|
import { UpdateActionTypeCommandInput, UpdateActionTypeCommandOutput } from "./commands/UpdateActionTypeCommand";
|
|
49
49
|
import { UpdatePipelineCommandInput, UpdatePipelineCommandOutput } from "./commands/UpdatePipelineCommand";
|
|
50
50
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
51
|
+
export { __Client };
|
|
51
52
|
/**
|
|
52
53
|
* @public
|
|
53
54
|
*/
|
|
@@ -162,7 +163,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
162
163
|
/**
|
|
163
164
|
* @public
|
|
164
165
|
*/
|
|
165
|
-
type CodePipelineClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
166
|
+
export type CodePipelineClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
166
167
|
/**
|
|
167
168
|
* @public
|
|
168
169
|
*
|
|
@@ -173,7 +174,7 @@ export interface CodePipelineClientConfig extends CodePipelineClientConfigType {
|
|
|
173
174
|
/**
|
|
174
175
|
* @public
|
|
175
176
|
*/
|
|
176
|
-
type CodePipelineClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
177
|
+
export type CodePipelineClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
177
178
|
/**
|
|
178
179
|
* @public
|
|
179
180
|
*
|
|
@@ -183,198 +184,197 @@ export interface CodePipelineClientResolvedConfig extends CodePipelineClientReso
|
|
|
183
184
|
}
|
|
184
185
|
/**
|
|
185
186
|
* @public
|
|
186
|
-
* <fullname>
|
|
187
|
-
*
|
|
187
|
+
* <fullname>CodePipeline</fullname>
|
|
188
|
+
* <p>
|
|
188
189
|
* <b>Overview</b>
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
* actions and data types for
|
|
192
|
-
* only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
* <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>
|
|
197
197
|
* <i>Pipelines</i> are models of automated release processes. Each pipeline
|
|
198
198
|
* is uniquely named, and consists of stages, actions, and transitions. </p>
|
|
199
|
-
*
|
|
200
|
-
*
|
|
199
|
+
* <p>You can work with pipelines by calling:</p>
|
|
200
|
+
* <ul>
|
|
201
201
|
* <li>
|
|
202
|
-
*
|
|
203
|
-
*
|
|
202
|
+
* <p>
|
|
203
|
+
* <a>CreatePipeline</a>, which creates a uniquely named
|
|
204
204
|
* pipeline.</p>
|
|
205
205
|
* </li>
|
|
206
206
|
* <li>
|
|
207
|
-
*
|
|
208
|
-
*
|
|
207
|
+
* <p>
|
|
208
|
+
* <a>DeletePipeline</a>, which deletes the specified
|
|
209
209
|
* pipeline.</p>
|
|
210
210
|
* </li>
|
|
211
211
|
* <li>
|
|
212
|
-
*
|
|
213
|
-
*
|
|
212
|
+
* <p>
|
|
213
|
+
* <a>GetPipeline</a>, which returns information about the pipeline
|
|
214
214
|
* structure and pipeline metadata, including the pipeline Amazon Resource Name
|
|
215
215
|
* (ARN).</p>
|
|
216
216
|
* </li>
|
|
217
217
|
* <li>
|
|
218
|
-
*
|
|
219
|
-
*
|
|
218
|
+
* <p>
|
|
219
|
+
* <a>GetPipelineExecution</a>, which returns information about a
|
|
220
220
|
* specific execution of a pipeline.</p>
|
|
221
221
|
* </li>
|
|
222
222
|
* <li>
|
|
223
|
-
*
|
|
224
|
-
*
|
|
223
|
+
* <p>
|
|
224
|
+
* <a>GetPipelineState</a>, which returns information about the current
|
|
225
225
|
* state of the stages and actions of a pipeline.</p>
|
|
226
226
|
* </li>
|
|
227
227
|
* <li>
|
|
228
|
-
*
|
|
228
|
+
* <p>
|
|
229
229
|
* <a>ListActionExecutions</a>, which returns action-level details
|
|
230
230
|
* for past executions. The details include full stage and action-level details,
|
|
231
231
|
* including individual action duration, status, any errors that occurred during
|
|
232
232
|
* the execution, and input and output artifact location details.</p>
|
|
233
233
|
* </li>
|
|
234
234
|
* <li>
|
|
235
|
-
*
|
|
236
|
-
*
|
|
235
|
+
* <p>
|
|
236
|
+
* <a>ListPipelines</a>, which gets a summary of all of the pipelines
|
|
237
237
|
* associated with your account.</p>
|
|
238
238
|
* </li>
|
|
239
239
|
* <li>
|
|
240
|
-
*
|
|
241
|
-
*
|
|
240
|
+
* <p>
|
|
241
|
+
* <a>ListPipelineExecutions</a>, which gets a summary of the most
|
|
242
242
|
* recent executions for a pipeline.</p>
|
|
243
243
|
* </li>
|
|
244
244
|
* <li>
|
|
245
|
-
*
|
|
246
|
-
*
|
|
245
|
+
* <p>
|
|
246
|
+
* <a>StartPipelineExecution</a>, which runs the most recent revision of
|
|
247
247
|
* an artifact through the pipeline.</p>
|
|
248
248
|
* </li>
|
|
249
249
|
* <li>
|
|
250
|
-
*
|
|
251
|
-
*
|
|
250
|
+
* <p>
|
|
251
|
+
* <a>StopPipelineExecution</a>, which stops the specified pipeline
|
|
252
252
|
* execution from continuing through the pipeline.</p>
|
|
253
253
|
* </li>
|
|
254
254
|
* <li>
|
|
255
|
-
*
|
|
256
|
-
*
|
|
255
|
+
* <p>
|
|
256
|
+
* <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
|
|
257
257
|
* to the structure of the pipeline.</p>
|
|
258
258
|
* </li>
|
|
259
259
|
* </ul>
|
|
260
|
-
*
|
|
260
|
+
* <p>Pipelines include <i>stages</i>. Each stage contains one or more
|
|
261
261
|
* actions that must complete before the next stage begins. A stage results in success or
|
|
262
262
|
* failure. If a stage fails, the pipeline stops at that stage and remains stopped until
|
|
263
263
|
* either a new version of an artifact appears in the source location, or a user takes
|
|
264
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
|
|
265
265
|
* status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
|
|
266
266
|
* entire structure of the pipeline, including the stages of that pipeline. For more
|
|
267
|
-
* 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
|
|
268
268
|
* Pipeline Structure Reference</a>.</p>
|
|
269
|
-
*
|
|
269
|
+
* <p>Pipeline stages include <i>actions</i> that are categorized into
|
|
270
270
|
* categories such as source or build actions performed in a stage of a pipeline. For
|
|
271
271
|
* example, you can use a source action to import artifacts into a pipeline from a source
|
|
272
272
|
* such as Amazon S3. Like stages, you do not work with actions directly in most cases, but
|
|
273
273
|
* you do define and interact with actions when working with pipeline operations such as
|
|
274
274
|
* <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid
|
|
275
275
|
* action categories are:</p>
|
|
276
|
-
*
|
|
276
|
+
* <ul>
|
|
277
277
|
* <li>
|
|
278
|
-
*
|
|
278
|
+
* <p>Source</p>
|
|
279
279
|
* </li>
|
|
280
280
|
* <li>
|
|
281
|
-
*
|
|
281
|
+
* <p>Build</p>
|
|
282
282
|
* </li>
|
|
283
283
|
* <li>
|
|
284
|
-
*
|
|
284
|
+
* <p>Test</p>
|
|
285
285
|
* </li>
|
|
286
286
|
* <li>
|
|
287
|
-
*
|
|
287
|
+
* <p>Deploy</p>
|
|
288
288
|
* </li>
|
|
289
289
|
* <li>
|
|
290
|
-
*
|
|
290
|
+
* <p>Approval</p>
|
|
291
291
|
* </li>
|
|
292
292
|
* <li>
|
|
293
|
-
*
|
|
293
|
+
* <p>Invoke</p>
|
|
294
294
|
* </li>
|
|
295
295
|
* </ul>
|
|
296
|
-
*
|
|
296
|
+
* <p>Pipelines also include <i>transitions</i>, which allow the transition
|
|
297
297
|
* of artifacts from one stage to the next in a pipeline after the actions in one stage
|
|
298
298
|
* complete.</p>
|
|
299
|
-
*
|
|
300
|
-
*
|
|
299
|
+
* <p>You can work with transitions by calling:</p>
|
|
300
|
+
* <ul>
|
|
301
301
|
* <li>
|
|
302
|
-
*
|
|
303
|
-
*
|
|
302
|
+
* <p>
|
|
303
|
+
* <a>DisableStageTransition</a>, which prevents artifacts from
|
|
304
304
|
* transitioning to the next stage in a pipeline.</p>
|
|
305
305
|
* </li>
|
|
306
306
|
* <li>
|
|
307
|
-
*
|
|
308
|
-
*
|
|
307
|
+
* <p>
|
|
308
|
+
* <a>EnableStageTransition</a>, which enables transition of artifacts
|
|
309
309
|
* between stages in a pipeline. </p>
|
|
310
310
|
* </li>
|
|
311
311
|
* </ul>
|
|
312
|
-
*
|
|
313
|
-
* <b>Using the API to integrate with
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
* with
|
|
317
|
-
* 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
|
|
318
318
|
* items:</p>
|
|
319
|
-
*
|
|
319
|
+
* <p>
|
|
320
320
|
* <b>Jobs</b>, which are instances of an action. For
|
|
321
321
|
* example, a job for a source action might import a revision of an artifact from a source. </p>
|
|
322
|
-
*
|
|
323
|
-
*
|
|
322
|
+
* <p>You can work with jobs by calling:</p>
|
|
323
|
+
* <ul>
|
|
324
324
|
* <li>
|
|
325
|
-
*
|
|
326
|
-
*
|
|
325
|
+
* <p>
|
|
326
|
+
* <a>AcknowledgeJob</a>, which confirms whether a job worker has
|
|
327
327
|
* received the specified job.</p>
|
|
328
328
|
* </li>
|
|
329
329
|
* <li>
|
|
330
|
-
*
|
|
331
|
-
*
|
|
330
|
+
* <p>
|
|
331
|
+
* <a>GetJobDetails</a>, which returns the details of a job.</p>
|
|
332
332
|
* </li>
|
|
333
333
|
* <li>
|
|
334
|
-
*
|
|
335
|
-
*
|
|
334
|
+
* <p>
|
|
335
|
+
* <a>PollForJobs</a>, which determines whether there are any jobs to
|
|
336
336
|
* act on.</p>
|
|
337
337
|
* </li>
|
|
338
338
|
* <li>
|
|
339
|
-
*
|
|
340
|
-
*
|
|
339
|
+
* <p>
|
|
340
|
+
* <a>PutJobFailureResult</a>, which provides details of a job failure.
|
|
341
341
|
* </p>
|
|
342
342
|
* </li>
|
|
343
343
|
* <li>
|
|
344
|
-
*
|
|
345
|
-
*
|
|
344
|
+
* <p>
|
|
345
|
+
* <a>PutJobSuccessResult</a>, which provides details of a job
|
|
346
346
|
* success.</p>
|
|
347
347
|
* </li>
|
|
348
348
|
* </ul>
|
|
349
|
-
*
|
|
349
|
+
* <p>
|
|
350
350
|
* <b>Third party jobs</b>, which are instances of an action
|
|
351
|
-
* created by a partner action and integrated into
|
|
352
|
-
* created by members of the
|
|
353
|
-
*
|
|
354
|
-
*
|
|
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>
|
|
355
355
|
* <li>
|
|
356
|
-
*
|
|
357
|
-
*
|
|
356
|
+
* <p>
|
|
357
|
+
* <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
|
|
358
358
|
* has received the specified job.</p>
|
|
359
359
|
* </li>
|
|
360
360
|
* <li>
|
|
361
|
-
*
|
|
362
|
-
*
|
|
361
|
+
* <p>
|
|
362
|
+
* <a>GetThirdPartyJobDetails</a>, which requests the details of a job
|
|
363
363
|
* for a partner action.</p>
|
|
364
364
|
* </li>
|
|
365
365
|
* <li>
|
|
366
|
-
*
|
|
367
|
-
*
|
|
366
|
+
* <p>
|
|
367
|
+
* <a>PollForThirdPartyJobs</a>, which determines whether there are any
|
|
368
368
|
* jobs to act on. </p>
|
|
369
369
|
* </li>
|
|
370
370
|
* <li>
|
|
371
|
-
*
|
|
372
|
-
*
|
|
371
|
+
* <p>
|
|
372
|
+
* <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
|
|
373
373
|
* failure.</p>
|
|
374
374
|
* </li>
|
|
375
375
|
* <li>
|
|
376
|
-
*
|
|
377
|
-
*
|
|
376
|
+
* <p>
|
|
377
|
+
* <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
|
|
378
378
|
* success.</p>
|
|
379
379
|
* </li>
|
|
380
380
|
* </ul>
|
|
@@ -392,4 +392,3 @@ export declare class CodePipelineClient extends __Client<__HttpHandlerOptions, S
|
|
|
392
392
|
*/
|
|
393
393
|
destroy(): void;
|
|
394
394
|
}
|
|
395
|
-
export {};
|
|
@@ -3,6 +3,10 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { CodePipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodePipelineClient";
|
|
5
5
|
import { AcknowledgeJobInput, AcknowledgeJobOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
6
10
|
/**
|
|
7
11
|
* @public
|
|
8
12
|
*
|
|
@@ -34,7 +38,7 @@ export interface AcknowledgeJobCommandOutput extends AcknowledgeJobOutput, __Met
|
|
|
34
38
|
* const command = new AcknowledgeJobCommand(input);
|
|
35
39
|
* const response = await client.send(command);
|
|
36
40
|
* // { // AcknowledgeJobOutput
|
|
37
|
-
* // status: "
|
|
41
|
+
* // status: "Created" || "Queued" || "Dispatched" || "InProgress" || "TimedOut" || "Succeeded" || "Failed",
|
|
38
42
|
* // };
|
|
39
43
|
*
|
|
40
44
|
* ```
|