@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.
Files changed (41) hide show
  1. package/README.md +12 -13
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/protocols/Aws_json1_1.js +1 -0
  4. package/dist-es/endpoint/ruleset.js +3 -3
  5. package/dist-es/protocols/Aws_json1_1.js +1 -0
  6. package/dist-types/CodePipeline.d.ts +83 -84
  7. package/dist-types/CodePipelineClient.d.ts +83 -84
  8. package/dist-types/commands/AcknowledgeJobCommand.d.ts +1 -1
  9. package/dist-types/commands/AcknowledgeThirdPartyJobCommand.d.ts +1 -1
  10. package/dist-types/commands/CreateCustomActionTypeCommand.d.ts +8 -8
  11. package/dist-types/commands/CreatePipelineCommand.d.ts +18 -18
  12. package/dist-types/commands/DeleteCustomActionTypeCommand.d.ts +3 -3
  13. package/dist-types/commands/DeleteWebhookCommand.d.ts +1 -2
  14. package/dist-types/commands/DeregisterWebhookWithThirdPartyCommand.d.ts +3 -3
  15. package/dist-types/commands/DisableStageTransitionCommand.d.ts +1 -1
  16. package/dist-types/commands/EnableStageTransitionCommand.d.ts +1 -1
  17. package/dist-types/commands/GetActionTypeCommand.d.ts +3 -3
  18. package/dist-types/commands/GetJobDetailsCommand.d.ts +11 -11
  19. package/dist-types/commands/GetPipelineCommand.d.ts +8 -7
  20. package/dist-types/commands/GetPipelineExecutionCommand.d.ts +1 -1
  21. package/dist-types/commands/GetPipelineStateCommand.d.ts +5 -5
  22. package/dist-types/commands/GetThirdPartyJobDetailsCommand.d.ts +11 -11
  23. package/dist-types/commands/ListActionExecutionsCommand.d.ts +3 -3
  24. package/dist-types/commands/ListActionTypesCommand.d.ts +5 -5
  25. package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +2 -2
  26. package/dist-types/commands/ListWebhooksCommand.d.ts +4 -4
  27. package/dist-types/commands/PollForJobsCommand.d.ts +16 -16
  28. package/dist-types/commands/PollForThirdPartyJobsCommand.d.ts +7 -7
  29. package/dist-types/commands/PutActionRevisionCommand.d.ts +2 -1
  30. package/dist-types/commands/PutApprovalResultCommand.d.ts +2 -2
  31. package/dist-types/commands/PutJobFailureResultCommand.d.ts +1 -1
  32. package/dist-types/commands/PutThirdPartyJobFailureResultCommand.d.ts +1 -1
  33. package/dist-types/commands/PutWebhookCommand.d.ts +12 -11
  34. package/dist-types/commands/RetryStageExecutionCommand.d.ts +4 -3
  35. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateActionTypeCommand.d.ts +2 -2
  37. package/dist-types/commands/UpdatePipelineCommand.d.ts +16 -16
  38. package/dist-types/index.d.ts +83 -84
  39. package/dist-types/models/models_0.d.ts +195 -178
  40. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  41. package/package.json +1 -1
package/dist-types/index.d.ts CHANGED
@@ -1,196 +1,195 @@
1
1
  /**
2
- * <fullname>AWS CodePipeline</fullname>
3
- * <p>
2
+ * <fullname>CodePipeline</fullname>
3
+ * <p>
4
4
  * <b>Overview</b>
5
- * </p>
6
- * <p>This is the AWS CodePipeline API Reference. This guide provides descriptions of the
7
- * actions and data types for AWS CodePipeline. Some functionality for your pipeline can
8
- * only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">AWS
9
- * CodePipeline User Guide</a>.</p>
10
- * <p>You can use the AWS CodePipeline API to work with pipelines, stages, actions, and
11
- * transitions.</p>
12
- * <p>
5
+ * </p>
6
+ * <p>This is the CodePipeline API Reference. This guide provides descriptions
7
+ * of the actions and data types for CodePipeline. Some functionality for your
8
+ * 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>
9
+ * <p>You can use the CodePipeline API to work with pipelines, stages, actions,
10
+ * and transitions.</p>
11
+ * <p>
13
12
  * <i>Pipelines</i> are models of automated release processes. Each pipeline
14
13
  * is uniquely named, and consists of stages, actions, and transitions. </p>
15
- * <p>You can work with pipelines by calling:</p>
16
- * <ul>
14
+ * <p>You can work with pipelines by calling:</p>
15
+ * <ul>
17
16
  * <li>
18
- * <p>
19
- * <a>CreatePipeline</a>, which creates a uniquely named
17
+ * <p>
18
+ * <a>CreatePipeline</a>, which creates a uniquely named
20
19
  * pipeline.</p>
21
20
  * </li>
22
21
  * <li>
23
- * <p>
24
- * <a>DeletePipeline</a>, which deletes the specified
22
+ * <p>
23
+ * <a>DeletePipeline</a>, which deletes the specified
25
24
  * pipeline.</p>
26
25
  * </li>
27
26
  * <li>
28
- * <p>
29
- * <a>GetPipeline</a>, which returns information about the pipeline
27
+ * <p>
28
+ * <a>GetPipeline</a>, which returns information about the pipeline
30
29
  * structure and pipeline metadata, including the pipeline Amazon Resource Name
31
30
  * (ARN).</p>
32
31
  * </li>
33
32
  * <li>
34
- * <p>
35
- * <a>GetPipelineExecution</a>, which returns information about a
33
+ * <p>
34
+ * <a>GetPipelineExecution</a>, which returns information about a
36
35
  * specific execution of a pipeline.</p>
37
36
  * </li>
38
37
  * <li>
39
- * <p>
40
- * <a>GetPipelineState</a>, which returns information about the current
38
+ * <p>
39
+ * <a>GetPipelineState</a>, which returns information about the current
41
40
  * state of the stages and actions of a pipeline.</p>
42
41
  * </li>
43
42
  * <li>
44
- * <p>
43
+ * <p>
45
44
  * <a>ListActionExecutions</a>, which returns action-level details
46
45
  * for past executions. The details include full stage and action-level details,
47
46
  * including individual action duration, status, any errors that occurred during
48
47
  * the execution, and input and output artifact location details.</p>
49
48
  * </li>
50
49
  * <li>
51
- * <p>
52
- * <a>ListPipelines</a>, which gets a summary of all of the pipelines
50
+ * <p>
51
+ * <a>ListPipelines</a>, which gets a summary of all of the pipelines
53
52
  * associated with your account.</p>
54
53
  * </li>
55
54
  * <li>
56
- * <p>
57
- * <a>ListPipelineExecutions</a>, which gets a summary of the most
55
+ * <p>
56
+ * <a>ListPipelineExecutions</a>, which gets a summary of the most
58
57
  * recent executions for a pipeline.</p>
59
58
  * </li>
60
59
  * <li>
61
- * <p>
62
- * <a>StartPipelineExecution</a>, which runs the most recent revision of
60
+ * <p>
61
+ * <a>StartPipelineExecution</a>, which runs the most recent revision of
63
62
  * an artifact through the pipeline.</p>
64
63
  * </li>
65
64
  * <li>
66
- * <p>
67
- * <a>StopPipelineExecution</a>, which stops the specified pipeline
65
+ * <p>
66
+ * <a>StopPipelineExecution</a>, which stops the specified pipeline
68
67
  * execution from continuing through the pipeline.</p>
69
68
  * </li>
70
69
  * <li>
71
- * <p>
72
- * <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
70
+ * <p>
71
+ * <a>UpdatePipeline</a>, which updates a pipeline with edits or changes
73
72
  * to the structure of the pipeline.</p>
74
73
  * </li>
75
74
  * </ul>
76
- * <p>Pipelines include <i>stages</i>. Each stage contains one or more
75
+ * <p>Pipelines include <i>stages</i>. Each stage contains one or more
77
76
  * actions that must complete before the next stage begins. A stage results in success or
78
77
  * failure. If a stage fails, the pipeline stops at that stage and remains stopped until
79
78
  * either a new version of an artifact appears in the source location, or a user takes
80
79
  * 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
81
80
  * status of stages in the pipeline, or <a>GetPipeline</a>, which returns the
82
81
  * entire structure of the pipeline, including the stages of that pipeline. For more
83
- * information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">AWS CodePipeline
82
+ * information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline
84
83
  * Pipeline Structure Reference</a>.</p>
85
- * <p>Pipeline stages include <i>actions</i> that are categorized into
84
+ * <p>Pipeline stages include <i>actions</i> that are categorized into
86
85
  * categories such as source or build actions performed in a stage of a pipeline. For
87
86
  * example, you can use a source action to import artifacts into a pipeline from a source
88
87
  * such as Amazon S3. Like stages, you do not work with actions directly in most cases, but
89
88
  * you do define and interact with actions when working with pipeline operations such as
90
89
  * <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid
91
90
  * action categories are:</p>
92
- * <ul>
91
+ * <ul>
93
92
  * <li>
94
- * <p>Source</p>
93
+ * <p>Source</p>
95
94
  * </li>
96
95
  * <li>
97
- * <p>Build</p>
96
+ * <p>Build</p>
98
97
  * </li>
99
98
  * <li>
100
- * <p>Test</p>
99
+ * <p>Test</p>
101
100
  * </li>
102
101
  * <li>
103
- * <p>Deploy</p>
102
+ * <p>Deploy</p>
104
103
  * </li>
105
104
  * <li>
106
- * <p>Approval</p>
105
+ * <p>Approval</p>
107
106
  * </li>
108
107
  * <li>
109
- * <p>Invoke</p>
108
+ * <p>Invoke</p>
110
109
  * </li>
111
110
  * </ul>
112
- * <p>Pipelines also include <i>transitions</i>, which allow the transition
111
+ * <p>Pipelines also include <i>transitions</i>, which allow the transition
113
112
  * of artifacts from one stage to the next in a pipeline after the actions in one stage
114
113
  * complete.</p>
115
- * <p>You can work with transitions by calling:</p>
116
- * <ul>
114
+ * <p>You can work with transitions by calling:</p>
115
+ * <ul>
117
116
  * <li>
118
- * <p>
119
- * <a>DisableStageTransition</a>, which prevents artifacts from
117
+ * <p>
118
+ * <a>DisableStageTransition</a>, which prevents artifacts from
120
119
  * transitioning to the next stage in a pipeline.</p>
121
120
  * </li>
122
121
  * <li>
123
- * <p>
124
- * <a>EnableStageTransition</a>, which enables transition of artifacts
122
+ * <p>
123
+ * <a>EnableStageTransition</a>, which enables transition of artifacts
125
124
  * between stages in a pipeline. </p>
126
125
  * </li>
127
126
  * </ul>
128
- * <p>
129
- * <b>Using the API to integrate with AWS CodePipeline</b>
130
- * </p>
131
- * <p>For third-party integrators or developers who want to create their own integrations
132
- * with AWS CodePipeline, the expected sequence varies from the standard API user. To
133
- * integrate with AWS CodePipeline, developers need to work with the following
127
+ * <p>
128
+ * <b>Using the API to integrate with CodePipeline</b>
129
+ * </p>
130
+ * <p>For third-party integrators or developers who want to create their own integrations
131
+ * with CodePipeline, the expected sequence varies from the standard API user. To
132
+ * integrate with CodePipeline, developers need to work with the following
134
133
  * items:</p>
135
- * <p>
134
+ * <p>
136
135
  * <b>Jobs</b>, which are instances of an action. For
137
136
  * example, a job for a source action might import a revision of an artifact from a source. </p>
138
- * <p>You can work with jobs by calling:</p>
139
- * <ul>
137
+ * <p>You can work with jobs by calling:</p>
138
+ * <ul>
140
139
  * <li>
141
- * <p>
142
- * <a>AcknowledgeJob</a>, which confirms whether a job worker has
140
+ * <p>
141
+ * <a>AcknowledgeJob</a>, which confirms whether a job worker has
143
142
  * received the specified job.</p>
144
143
  * </li>
145
144
  * <li>
146
- * <p>
147
- * <a>GetJobDetails</a>, which returns the details of a job.</p>
145
+ * <p>
146
+ * <a>GetJobDetails</a>, which returns the details of a job.</p>
148
147
  * </li>
149
148
  * <li>
150
- * <p>
151
- * <a>PollForJobs</a>, which determines whether there are any jobs to
149
+ * <p>
150
+ * <a>PollForJobs</a>, which determines whether there are any jobs to
152
151
  * act on.</p>
153
152
  * </li>
154
153
  * <li>
155
- * <p>
156
- * <a>PutJobFailureResult</a>, which provides details of a job failure.
154
+ * <p>
155
+ * <a>PutJobFailureResult</a>, which provides details of a job failure.
157
156
  * </p>
158
157
  * </li>
159
158
  * <li>
160
- * <p>
161
- * <a>PutJobSuccessResult</a>, which provides details of a job
159
+ * <p>
160
+ * <a>PutJobSuccessResult</a>, which provides details of a job
162
161
  * success.</p>
163
162
  * </li>
164
163
  * </ul>
165
- * <p>
164
+ * <p>
166
165
  * <b>Third party jobs</b>, which are instances of an action
167
- * created by a partner action and integrated into AWS CodePipeline. Partner actions are
168
- * created by members of the AWS Partner Network.</p>
169
- * <p>You can work with third party jobs by calling:</p>
170
- * <ul>
166
+ * created by a partner action and integrated into CodePipeline. Partner actions are
167
+ * created by members of the Amazon Web Services Partner Network.</p>
168
+ * <p>You can work with third party jobs by calling:</p>
169
+ * <ul>
171
170
  * <li>
172
- * <p>
173
- * <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
171
+ * <p>
172
+ * <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker
174
173
  * has received the specified job.</p>
175
174
  * </li>
176
175
  * <li>
177
- * <p>
178
- * <a>GetThirdPartyJobDetails</a>, which requests the details of a job
176
+ * <p>
177
+ * <a>GetThirdPartyJobDetails</a>, which requests the details of a job
179
178
  * for a partner action.</p>
180
179
  * </li>
181
180
  * <li>
182
- * <p>
183
- * <a>PollForThirdPartyJobs</a>, which determines whether there are any
181
+ * <p>
182
+ * <a>PollForThirdPartyJobs</a>, which determines whether there are any
184
183
  * jobs to act on. </p>
185
184
  * </li>
186
185
  * <li>
187
- * <p>
188
- * <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
186
+ * <p>
187
+ * <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
189
188
  * failure.</p>
190
189
  * </li>
191
190
  * <li>
192
- * <p>
193
- * <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
191
+ * <p>
192
+ * <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job
194
193
  * success.</p>
195
194
  * </li>
196
195
  * </ul>