@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
package/README.md
CHANGED
|
@@ -6,17 +6,16 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript CodePipeline Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<fullname>
|
|
9
|
+
<fullname>CodePipeline</fullname>
|
|
10
10
|
|
|
11
11
|
<p>
|
|
12
12
|
<b>Overview</b>
|
|
13
13
|
</p>
|
|
14
|
-
<p>This is the
|
|
15
|
-
actions and data types for
|
|
16
|
-
only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">
|
|
17
|
-
CodePipeline
|
|
18
|
-
|
|
19
|
-
transitions.</p>
|
|
14
|
+
<p>This is the CodePipeline API Reference. This guide provides descriptions
|
|
15
|
+
of the actions and data types for CodePipeline. Some functionality for your
|
|
16
|
+
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>
|
|
17
|
+
<p>You can use the CodePipeline API to work with pipelines, stages, actions,
|
|
18
|
+
and transitions.</p>
|
|
20
19
|
<p>
|
|
21
20
|
<i>Pipelines</i> are models of automated release processes. Each pipeline
|
|
22
21
|
is uniquely named, and consists of stages, actions, and transitions. </p>
|
|
@@ -88,7 +87,7 @@ either a new version of an artifact appears in the source location, or a user ta
|
|
|
88
87
|
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
|
|
89
88
|
status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
|
|
90
89
|
entire structure of the pipeline, including the stages of that pipeline. For more
|
|
91
|
-
information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">
|
|
90
|
+
information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline
|
|
92
91
|
Pipeline Structure Reference</a>.</p>
|
|
93
92
|
<p>Pipeline stages include <i>actions</i> that are categorized into
|
|
94
93
|
categories such as source or build actions performed in a stage of a pipeline. For
|
|
@@ -134,11 +133,11 @@ between stages in a pipeline. </p>
|
|
|
134
133
|
</li>
|
|
135
134
|
</ul>
|
|
136
135
|
<p>
|
|
137
|
-
<b>Using the API to integrate with
|
|
136
|
+
<b>Using the API to integrate with CodePipeline</b>
|
|
138
137
|
</p>
|
|
139
138
|
<p>For third-party integrators or developers who want to create their own integrations
|
|
140
|
-
with
|
|
141
|
-
integrate with
|
|
139
|
+
with CodePipeline, the expected sequence varies from the standard API user. To
|
|
140
|
+
integrate with CodePipeline, developers need to work with the following
|
|
142
141
|
items:</p>
|
|
143
142
|
<p>
|
|
144
143
|
<b>Jobs</b>, which are instances of an action. For
|
|
@@ -172,8 +171,8 @@ success.</p>
|
|
|
172
171
|
</ul>
|
|
173
172
|
<p>
|
|
174
173
|
<b>Third party jobs</b>, which are instances of an action
|
|
175
|
-
created by a partner action and integrated into
|
|
176
|
-
created by members of the
|
|
174
|
+
created by a partner action and integrated into CodePipeline. Partner actions are
|
|
175
|
+
created by members of the Amazon Web Services Partner Network.</p>
|
|
177
176
|
<p>You can work with third party jobs by calling:</p>
|
|
178
177
|
<ul>
|
|
179
178
|
<li>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://codepipeline.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -2394,6 +2394,7 @@ const de_PipelineMetadata = (output, context) => {
|
|
|
2394
2394
|
return (0, smithy_client_1.take)(output, {
|
|
2395
2395
|
created: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
2396
2396
|
pipelineArn: smithy_client_1.expectString,
|
|
2397
|
+
pollingDisabledAt: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
2397
2398
|
updated: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
2398
2399
|
});
|
|
2399
2400
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://codepipeline.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://codepipeline.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -2312,6 +2312,7 @@ const de_PipelineMetadata = (output, context) => {
|
|
|
2312
2312
|
return take(output, {
|
|
2313
2313
|
created: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
2314
2314
|
pipelineArn: __expectString,
|
|
2315
|
+
pollingDisabledAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
2315
2316
|
updated: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
2316
2317
|
});
|
|
2317
2318
|
};
|
|
@@ -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>
|