UNPKG

94.8 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CodePipeline extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CodePipeline.Types.ClientConfiguration)
13 config: Config & CodePipeline.Types.ClientConfiguration;
14 /**
15 * Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
16 */
17 acknowledgeJob(params: CodePipeline.Types.AcknowledgeJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
18 /**
19 * Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
20 */
21 acknowledgeJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
22 /**
23 * Confirms a job worker has received the specified job. Used for partner actions only.
24 */
25 acknowledgeThirdPartyJob(params: CodePipeline.Types.AcknowledgeThirdPartyJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
26 /**
27 * Confirms a job worker has received the specified job. Used for partner actions only.
28 */
29 acknowledgeThirdPartyJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
30 /**
31 * Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
32 */
33 createCustomActionType(params: CodePipeline.Types.CreateCustomActionTypeInput, callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
34 /**
35 * Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
36 */
37 createCustomActionType(callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
38 /**
39 * Creates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
40 */
41 createPipeline(params: CodePipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
42 /**
43 * Creates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
44 */
45 createPipeline(callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
46 /**
47 * Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
48 */
49 deleteCustomActionType(params: CodePipeline.Types.DeleteCustomActionTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
52 */
53 deleteCustomActionType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Deletes the specified pipeline.
56 */
57 deletePipeline(params: CodePipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * Deletes the specified pipeline.
60 */
61 deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
64 */
65 deleteWebhook(params: CodePipeline.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
66 /**
67 * Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
68 */
69 deleteWebhook(callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
70 /**
71 * Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
72 */
73 deregisterWebhookWithThirdParty(params: CodePipeline.Types.DeregisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
74 /**
75 * Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
76 */
77 deregisterWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
78 /**
79 * Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
80 */
81 disableStageTransition(params: CodePipeline.Types.DisableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
84 */
85 disableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Enables artifacts in a pipeline to transition to a stage in a pipeline.
88 */
89 enableStageTransition(params: CodePipeline.Types.EnableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90 /**
91 * Enables artifacts in a pipeline to transition to a stage in a pipeline.
92 */
93 enableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94 /**
95 * Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
96 */
97 getJobDetails(params: CodePipeline.Types.GetJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
98 /**
99 * Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
100 */
101 getJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
102 /**
103 * Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
104 */
105 getPipeline(params: CodePipeline.Types.GetPipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
106 /**
107 * Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
108 */
109 getPipeline(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
110 /**
111 * Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
112 */
113 getPipelineExecution(params: CodePipeline.Types.GetPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
114 /**
115 * Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
116 */
117 getPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
118 /**
119 * Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
120 */
121 getPipelineState(params: CodePipeline.Types.GetPipelineStateInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
122 /**
123 * Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
124 */
125 getPipelineState(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
126 /**
127 * Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
128 */
129 getThirdPartyJobDetails(params: CodePipeline.Types.GetThirdPartyJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
130 /**
131 * Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
132 */
133 getThirdPartyJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
134 /**
135 * Lists the action executions that have occurred in a pipeline.
136 */
137 listActionExecutions(params: CodePipeline.Types.ListActionExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
138 /**
139 * Lists the action executions that have occurred in a pipeline.
140 */
141 listActionExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
142 /**
143 * Gets a summary of all AWS CodePipeline action types associated with your account.
144 */
145 listActionTypes(params: CodePipeline.Types.ListActionTypesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
146 /**
147 * Gets a summary of all AWS CodePipeline action types associated with your account.
148 */
149 listActionTypes(callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
150 /**
151 * Gets a summary of the most recent executions for a pipeline.
152 */
153 listPipelineExecutions(params: CodePipeline.Types.ListPipelineExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
154 /**
155 * Gets a summary of the most recent executions for a pipeline.
156 */
157 listPipelineExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
158 /**
159 * Gets a summary of all of the pipelines associated with your account.
160 */
161 listPipelines(params: CodePipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
162 /**
163 * Gets a summary of all of the pipelines associated with your account.
164 */
165 listPipelines(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
166 /**
167 * Gets the set of key-value pairs (metadata) that are used to manage the resource.
168 */
169 listTagsForResource(params: CodePipeline.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
170 /**
171 * Gets the set of key-value pairs (metadata) that are used to manage the resource.
172 */
173 listTagsForResource(callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
174 /**
175 * Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
176 */
177 listWebhooks(params: CodePipeline.Types.ListWebhooksInput, callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
178 /**
179 * Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
180 */
181 listWebhooks(callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
182 /**
183 * Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
184 */
185 pollForJobs(params: CodePipeline.Types.PollForJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
186 /**
187 * Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
188 */
189 pollForJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
190 /**
191 * Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
192 */
193 pollForThirdPartyJobs(params: CodePipeline.Types.PollForThirdPartyJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
194 /**
195 * Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
196 */
197 pollForThirdPartyJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
198 /**
199 * Provides information to AWS CodePipeline about new revisions to a source.
200 */
201 putActionRevision(params: CodePipeline.Types.PutActionRevisionInput, callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
202 /**
203 * Provides information to AWS CodePipeline about new revisions to a source.
204 */
205 putActionRevision(callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
206 /**
207 * Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
208 */
209 putApprovalResult(params: CodePipeline.Types.PutApprovalResultInput, callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
210 /**
211 * Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
212 */
213 putApprovalResult(callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
214 /**
215 * Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
216 */
217 putJobFailureResult(params: CodePipeline.Types.PutJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218 /**
219 * Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
220 */
221 putJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222 /**
223 * Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
224 */
225 putJobSuccessResult(params: CodePipeline.Types.PutJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
226 /**
227 * Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
228 */
229 putJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
230 /**
231 * Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
232 */
233 putThirdPartyJobFailureResult(params: CodePipeline.Types.PutThirdPartyJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
234 /**
235 * Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
236 */
237 putThirdPartyJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
238 /**
239 * Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
240 */
241 putThirdPartyJobSuccessResult(params: CodePipeline.Types.PutThirdPartyJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
242 /**
243 * Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
244 */
245 putThirdPartyJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
246 /**
247 * Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
248 */
249 putWebhook(params: CodePipeline.Types.PutWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
250 /**
251 * Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
252 */
253 putWebhook(callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
254 /**
255 * Configures a connection between the webhook that was created and the external tool with events to be detected.
256 */
257 registerWebhookWithThirdParty(params: CodePipeline.Types.RegisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
258 /**
259 * Configures a connection between the webhook that was created and the external tool with events to be detected.
260 */
261 registerWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
262 /**
263 * Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
264 */
265 retryStageExecution(params: CodePipeline.Types.RetryStageExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
266 /**
267 * Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
268 */
269 retryStageExecution(callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
270 /**
271 * Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
272 */
273 startPipelineExecution(params: CodePipeline.Types.StartPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
274 /**
275 * Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
276 */
277 startPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
278 /**
279 * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
280 */
281 tagResource(params: CodePipeline.Types.TagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
282 /**
283 * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
284 */
285 tagResource(callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
286 /**
287 * Removes tags from an AWS resource.
288 */
289 untagResource(params: CodePipeline.Types.UntagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
290 /**
291 * Removes tags from an AWS resource.
292 */
293 untagResource(callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
294 /**
295 * Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
296 */
297 updatePipeline(params: CodePipeline.Types.UpdatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
298 /**
299 * Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
300 */
301 updatePipeline(callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
302}
303declare namespace CodePipeline {
304 export type AWSRegionName = string;
305 export interface AWSSessionCredentials {
306 /**
307 * The access key for the session.
308 */
309 accessKeyId: AccessKeyId;
310 /**
311 * The secret access key for the session.
312 */
313 secretAccessKey: SecretAccessKey;
314 /**
315 * The token for the session.
316 */
317 sessionToken: SessionToken;
318 }
319 export type AccessKeyId = string;
320 export type AccountId = string;
321 export interface AcknowledgeJobInput {
322 /**
323 * The unique system-generated ID of the job for which you want to confirm receipt.
324 */
325 jobId: JobId;
326 /**
327 * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
328 */
329 nonce: Nonce;
330 }
331 export interface AcknowledgeJobOutput {
332 /**
333 * Whether the job worker has received the specified job.
334 */
335 status?: JobStatus;
336 }
337 export interface AcknowledgeThirdPartyJobInput {
338 /**
339 * The unique system-generated ID of the job.
340 */
341 jobId: ThirdPartyJobId;
342 /**
343 * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
344 */
345 nonce: Nonce;
346 /**
347 * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
348 */
349 clientToken: ClientToken;
350 }
351 export interface AcknowledgeThirdPartyJobOutput {
352 /**
353 * The status information for the third party job, if any.
354 */
355 status?: JobStatus;
356 }
357 export type ActionCategory = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|string;
358 export interface ActionConfiguration {
359 /**
360 * The configuration data for the action.
361 */
362 configuration?: ActionConfigurationMap;
363 }
364 export type ActionConfigurationKey = string;
365 export type ActionConfigurationMap = {[key: string]: ActionConfigurationValue};
366 export interface ActionConfigurationProperty {
367 /**
368 * The name of the action configuration property.
369 */
370 name: ActionConfigurationKey;
371 /**
372 * Whether the configuration property is a required value.
373 */
374 required: Boolean;
375 /**
376 * Whether the configuration property is a key.
377 */
378 key: Boolean;
379 /**
380 * Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
381 */
382 secret: Boolean;
383 /**
384 * Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
385 */
386 queryable?: Boolean;
387 /**
388 * The description of the action configuration property that is displayed to users.
389 */
390 description?: Description;
391 /**
392 * The type of the configuration property.
393 */
394 type?: ActionConfigurationPropertyType;
395 }
396 export type ActionConfigurationPropertyList = ActionConfigurationProperty[];
397 export type ActionConfigurationPropertyType = "String"|"Number"|"Boolean"|string;
398 export type ActionConfigurationQueryableValue = string;
399 export type ActionConfigurationValue = string;
400 export interface ActionContext {
401 /**
402 * The name of the action in the context of a job.
403 */
404 name?: ActionName;
405 /**
406 * The system-generated unique ID that corresponds to an action's execution.
407 */
408 actionExecutionId?: ActionExecutionId;
409 }
410 export interface ActionDeclaration {
411 /**
412 * The action declaration's name.
413 */
414 name: ActionName;
415 /**
416 * Specifies the action type and the provider of the action.
417 */
418 actionTypeId: ActionTypeId;
419 /**
420 * The order in which actions are run.
421 */
422 runOrder?: ActionRunOrder;
423 /**
424 * The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide. The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: JSON: "Configuration" : { Key : Value },
425 */
426 configuration?: ActionConfigurationMap;
427 /**
428 * The name or ID of the result of the action declaration, such as a test or build artifact.
429 */
430 outputArtifacts?: OutputArtifactList;
431 /**
432 * The name or ID of the artifact consumed by the action, such as a test or build artifact.
433 */
434 inputArtifacts?: InputArtifactList;
435 /**
436 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
437 */
438 roleArn?: RoleArn;
439 /**
440 * The action declaration's AWS Region, such as us-east-1.
441 */
442 region?: AWSRegionName;
443 }
444 export interface ActionExecution {
445 /**
446 * The status of the action, or for a completed action, the last status of the action.
447 */
448 status?: ActionExecutionStatus;
449 /**
450 * A summary of the run of the action.
451 */
452 summary?: ExecutionSummary;
453 /**
454 * The last status change of the action.
455 */
456 lastStatusChange?: Timestamp;
457 /**
458 * The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.
459 */
460 token?: ActionExecutionToken;
461 /**
462 * The ARN of the user who last changed the pipeline.
463 */
464 lastUpdatedBy?: LastUpdatedBy;
465 /**
466 * The external ID of the run of the action.
467 */
468 externalExecutionId?: ExecutionId;
469 /**
470 * The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
471 */
472 externalExecutionUrl?: Url;
473 /**
474 * A percentage of completeness of the action as it runs.
475 */
476 percentComplete?: Percentage;
477 /**
478 * The details of an error returned by a URL external to AWS.
479 */
480 errorDetails?: ErrorDetails;
481 }
482 export interface ActionExecutionDetail {
483 /**
484 * The pipeline execution ID for the action execution.
485 */
486 pipelineExecutionId?: PipelineExecutionId;
487 /**
488 * The action execution ID.
489 */
490 actionExecutionId?: ActionExecutionId;
491 /**
492 * The version of the pipeline where the action was run.
493 */
494 pipelineVersion?: PipelineVersion;
495 /**
496 * The name of the stage that contains the action.
497 */
498 stageName?: StageName;
499 /**
500 * The name of the action.
501 */
502 actionName?: ActionName;
503 /**
504 * The start time of the action execution.
505 */
506 startTime?: Timestamp;
507 /**
508 * The last update time of the action execution.
509 */
510 lastUpdateTime?: Timestamp;
511 /**
512 * The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
513 */
514 status?: ActionExecutionStatus;
515 /**
516 * Input details for the action execution, such as role ARN, Region, and input artifacts.
517 */
518 input?: ActionExecutionInput;
519 /**
520 * Output details for the action execution, such as the action execution result.
521 */
522 output?: ActionExecutionOutput;
523 }
524 export type ActionExecutionDetailList = ActionExecutionDetail[];
525 export interface ActionExecutionFilter {
526 /**
527 * The pipeline execution ID used to filter action execution history.
528 */
529 pipelineExecutionId?: PipelineExecutionId;
530 }
531 export type ActionExecutionId = string;
532 export interface ActionExecutionInput {
533 actionTypeId?: ActionTypeId;
534 /**
535 * Configuration data for an action execution.
536 */
537 configuration?: ActionConfigurationMap;
538 /**
539 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
540 */
541 roleArn?: RoleArn;
542 /**
543 * The AWS Region for the action, such as us-east-1.
544 */
545 region?: AWSRegionName;
546 /**
547 * Details of input artifacts of the action that correspond to the action execution.
548 */
549 inputArtifacts?: ArtifactDetailList;
550 }
551 export interface ActionExecutionOutput {
552 /**
553 * Details of output artifacts of the action that correspond to the action execution.
554 */
555 outputArtifacts?: ArtifactDetailList;
556 /**
557 * Execution result information listed in the output details for an action execution.
558 */
559 executionResult?: ActionExecutionResult;
560 }
561 export interface ActionExecutionResult {
562 /**
563 * The action provider's external ID for the action execution.
564 */
565 externalExecutionId?: ExternalExecutionId;
566 /**
567 * The action provider's summary for the action execution.
568 */
569 externalExecutionSummary?: ExternalExecutionSummary;
570 /**
571 * The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
572 */
573 externalExecutionUrl?: Url;
574 }
575 export type ActionExecutionStatus = "InProgress"|"Succeeded"|"Failed"|string;
576 export type ActionExecutionToken = string;
577 export type ActionName = string;
578 export type ActionOwner = "AWS"|"ThirdParty"|"Custom"|string;
579 export type ActionProvider = string;
580 export interface ActionRevision {
581 /**
582 * The system-generated unique ID that identifies the revision number of the action.
583 */
584 revisionId: Revision;
585 /**
586 * The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
587 */
588 revisionChangeId: RevisionChangeIdentifier;
589 /**
590 * The date and time when the most recent version of the action was created, in timestamp format.
591 */
592 created: Timestamp;
593 }
594 export type ActionRunOrder = number;
595 export interface ActionState {
596 /**
597 * The name of the action.
598 */
599 actionName?: ActionName;
600 /**
601 * Represents information about the version (or revision) of an action.
602 */
603 currentRevision?: ActionRevision;
604 /**
605 * Represents information about the run of an action.
606 */
607 latestExecution?: ActionExecution;
608 /**
609 * A URL link for more information about the state of the action, such as a deployment group details page.
610 */
611 entityUrl?: Url;
612 /**
613 * A URL link for more information about the revision, such as a commit details page.
614 */
615 revisionUrl?: Url;
616 }
617 export type ActionStateList = ActionState[];
618 export interface ActionType {
619 /**
620 * Represents information about an action type.
621 */
622 id: ActionTypeId;
623 /**
624 * The settings for the action type.
625 */
626 settings?: ActionTypeSettings;
627 /**
628 * The configuration properties for the action type.
629 */
630 actionConfigurationProperties?: ActionConfigurationPropertyList;
631 /**
632 * The details of the input artifact for the action, such as its commit ID.
633 */
634 inputArtifactDetails: ArtifactDetails;
635 /**
636 * The details of the output artifact of the action, such as its commit ID.
637 */
638 outputArtifactDetails: ArtifactDetails;
639 }
640 export interface ActionTypeId {
641 /**
642 * A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
643 */
644 category: ActionCategory;
645 /**
646 * The creator of the action being called.
647 */
648 owner: ActionOwner;
649 /**
650 * The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
651 */
652 provider: ActionProvider;
653 /**
654 * A string that describes the action version.
655 */
656 version: Version;
657 }
658 export type ActionTypeList = ActionType[];
659 export interface ActionTypeSettings {
660 /**
661 * The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
662 */
663 thirdPartyConfigurationUrl?: Url;
664 /**
665 * The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
666 */
667 entityUrlTemplate?: UrlTemplate;
668 /**
669 * The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
670 */
671 executionUrlTemplate?: UrlTemplate;
672 /**
673 * The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
674 */
675 revisionUrlTemplate?: UrlTemplate;
676 }
677 export interface ApprovalResult {
678 /**
679 * The summary of the current status of the approval request.
680 */
681 summary: ApprovalSummary;
682 /**
683 * The response submitted by a reviewer assigned to an approval action request.
684 */
685 status: ApprovalStatus;
686 }
687 export type ApprovalStatus = "Approved"|"Rejected"|string;
688 export type ApprovalSummary = string;
689 export type ApprovalToken = string;
690 export interface Artifact {
691 /**
692 * The artifact's name.
693 */
694 name?: ArtifactName;
695 /**
696 * The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
697 */
698 revision?: Revision;
699 /**
700 * The location of an artifact.
701 */
702 location?: ArtifactLocation;
703 }
704 export interface ArtifactDetail {
705 /**
706 * The artifact object name for the action execution.
707 */
708 name?: ArtifactName;
709 /**
710 * The Amazon S3 artifact location for the action execution.
711 */
712 s3location?: S3Location;
713 }
714 export type ArtifactDetailList = ArtifactDetail[];
715 export interface ArtifactDetails {
716 /**
717 * The minimum number of artifacts allowed for the action type.
718 */
719 minimumCount: MinimumArtifactCount;
720 /**
721 * The maximum number of artifacts allowed for the action type.
722 */
723 maximumCount: MaximumArtifactCount;
724 }
725 export type ArtifactList = Artifact[];
726 export interface ArtifactLocation {
727 /**
728 * The type of artifact in the location.
729 */
730 type?: ArtifactLocationType;
731 /**
732 * The Amazon S3 bucket that contains the artifact.
733 */
734 s3Location?: S3ArtifactLocation;
735 }
736 export type ArtifactLocationType = "S3"|string;
737 export type ArtifactName = string;
738 export interface ArtifactRevision {
739 /**
740 * The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
741 */
742 name?: ArtifactName;
743 /**
744 * The revision ID of the artifact.
745 */
746 revisionId?: Revision;
747 /**
748 * An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
749 */
750 revisionChangeIdentifier?: RevisionChangeIdentifier;
751 /**
752 * Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
753 */
754 revisionSummary?: RevisionSummary;
755 /**
756 * The date and time when the most recent revision of the artifact was created, in timestamp format.
757 */
758 created?: Timestamp;
759 /**
760 * The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
761 */
762 revisionUrl?: Url;
763 }
764 export type ArtifactRevisionList = ArtifactRevision[];
765 export interface ArtifactStore {
766 /**
767 * The type of the artifact store, such as S3.
768 */
769 type: ArtifactStoreType;
770 /**
771 * The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
772 */
773 location: ArtifactStoreLocation;
774 /**
775 * The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
776 */
777 encryptionKey?: EncryptionKey;
778 }
779 export type ArtifactStoreLocation = string;
780 export type ArtifactStoreMap = {[key: string]: ArtifactStore};
781 export type ArtifactStoreType = "S3"|string;
782 export interface BlockerDeclaration {
783 /**
784 * Reserved for future use.
785 */
786 name: BlockerName;
787 /**
788 * Reserved for future use.
789 */
790 type: BlockerType;
791 }
792 export type BlockerName = string;
793 export type BlockerType = "Schedule"|string;
794 export type Boolean = boolean;
795 export type ClientId = string;
796 export type ClientRequestToken = string;
797 export type ClientToken = string;
798 export type Code = string;
799 export type ContinuationToken = string;
800 export interface CreateCustomActionTypeInput {
801 /**
802 * The category of the custom action, such as a build action or a test action. Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.
803 */
804 category: ActionCategory;
805 /**
806 * The provider of the service used in the custom action, such as AWS CodeDeploy.
807 */
808 provider: ActionProvider;
809 /**
810 * The version identifier of the custom action.
811 */
812 version: Version;
813 /**
814 * URLs that provide users information about this custom action.
815 */
816 settings?: ActionTypeSettings;
817 /**
818 * The configuration properties for the custom action. You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
819 */
820 configurationProperties?: ActionConfigurationPropertyList;
821 /**
822 * The details of the input artifact for the action, such as its commit ID.
823 */
824 inputArtifactDetails: ArtifactDetails;
825 /**
826 * The details of the output artifact of the action, such as its commit ID.
827 */
828 outputArtifactDetails: ArtifactDetails;
829 /**
830 * The tags for the custom action.
831 */
832 tags?: TagList;
833 }
834 export interface CreateCustomActionTypeOutput {
835 /**
836 * Returns information about the details of an action type.
837 */
838 actionType: ActionType;
839 /**
840 * Specifies the tags applied to the custom action.
841 */
842 tags?: TagList;
843 }
844 export interface CreatePipelineInput {
845 /**
846 * Represents the structure of actions and stages to be performed in the pipeline.
847 */
848 pipeline: PipelineDeclaration;
849 /**
850 * The tags for the pipeline.
851 */
852 tags?: TagList;
853 }
854 export interface CreatePipelineOutput {
855 /**
856 * Represents the structure of actions and stages to be performed in the pipeline.
857 */
858 pipeline?: PipelineDeclaration;
859 /**
860 * Specifies the tags applied to the pipeline.
861 */
862 tags?: TagList;
863 }
864 export interface CurrentRevision {
865 /**
866 * The revision ID of the current version of an artifact.
867 */
868 revision: Revision;
869 /**
870 * The change identifier for the current revision.
871 */
872 changeIdentifier: RevisionChangeIdentifier;
873 /**
874 * The date and time when the most recent revision of the artifact was created, in timestamp format.
875 */
876 created?: Time;
877 /**
878 * The summary of the most recent revision of the artifact.
879 */
880 revisionSummary?: RevisionSummary;
881 }
882 export interface DeleteCustomActionTypeInput {
883 /**
884 * The category of the custom action that you want to delete, such as source or deploy.
885 */
886 category: ActionCategory;
887 /**
888 * The provider of the service used in the custom action, such as AWS CodeDeploy.
889 */
890 provider: ActionProvider;
891 /**
892 * The version of the custom action to delete.
893 */
894 version: Version;
895 }
896 export interface DeletePipelineInput {
897 /**
898 * The name of the pipeline to be deleted.
899 */
900 name: PipelineName;
901 }
902 export interface DeleteWebhookInput {
903 /**
904 * The name of the webhook you want to delete.
905 */
906 name: WebhookName;
907 }
908 export interface DeleteWebhookOutput {
909 }
910 export interface DeregisterWebhookWithThirdPartyInput {
911 /**
912 * The name of the webhook you want to deregister.
913 */
914 webhookName?: WebhookName;
915 }
916 export interface DeregisterWebhookWithThirdPartyOutput {
917 }
918 export type Description = string;
919 export interface DisableStageTransitionInput {
920 /**
921 * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
922 */
923 pipelineName: PipelineName;
924 /**
925 * The name of the stage where you want to disable the inbound or outbound transition of artifacts.
926 */
927 stageName: StageName;
928 /**
929 * Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
930 */
931 transitionType: StageTransitionType;
932 /**
933 * The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
934 */
935 reason: DisabledReason;
936 }
937 export type DisabledReason = string;
938 export interface EnableStageTransitionInput {
939 /**
940 * The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
941 */
942 pipelineName: PipelineName;
943 /**
944 * The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
945 */
946 stageName: StageName;
947 /**
948 * Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
949 */
950 transitionType: StageTransitionType;
951 }
952 export type Enabled = boolean;
953 export interface EncryptionKey {
954 /**
955 * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
956 */
957 id: EncryptionKeyId;
958 /**
959 * The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
960 */
961 type: EncryptionKeyType;
962 }
963 export type EncryptionKeyId = string;
964 export type EncryptionKeyType = "KMS"|string;
965 export interface ErrorDetails {
966 /**
967 * The system ID or number code of the error.
968 */
969 code?: Code;
970 /**
971 * The text of the error message.
972 */
973 message?: Message;
974 }
975 export interface ExecutionDetails {
976 /**
977 * The summary of the current status of the actions.
978 */
979 summary?: ExecutionSummary;
980 /**
981 * The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
982 */
983 externalExecutionId?: ExecutionId;
984 /**
985 * The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
986 */
987 percentComplete?: Percentage;
988 }
989 export type ExecutionId = string;
990 export type ExecutionSummary = string;
991 export interface ExecutionTrigger {
992 /**
993 * The type of change-detection method, command, or user interaction that started a pipeline execution.
994 */
995 triggerType?: TriggerType;
996 /**
997 * Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
998 */
999 triggerDetail?: TriggerDetail;
1000 }
1001 export type ExternalExecutionId = string;
1002 export type ExternalExecutionSummary = string;
1003 export interface FailureDetails {
1004 /**
1005 * The type of the failure.
1006 */
1007 type: FailureType;
1008 /**
1009 * The message about the failure.
1010 */
1011 message: Message;
1012 /**
1013 * The external ID of the run of the action that failed.
1014 */
1015 externalExecutionId?: ExecutionId;
1016 }
1017 export type FailureType = "JobFailed"|"ConfigurationError"|"PermissionError"|"RevisionOutOfSync"|"RevisionUnavailable"|"SystemUnavailable"|string;
1018 export interface GetJobDetailsInput {
1019 /**
1020 * The unique system-generated ID for the job.
1021 */
1022 jobId: JobId;
1023 }
1024 export interface GetJobDetailsOutput {
1025 /**
1026 * The details of the job. If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
1027 */
1028 jobDetails?: JobDetails;
1029 }
1030 export interface GetPipelineExecutionInput {
1031 /**
1032 * The name of the pipeline about which you want to get execution details.
1033 */
1034 pipelineName: PipelineName;
1035 /**
1036 * The ID of the pipeline execution about which you want to get execution details.
1037 */
1038 pipelineExecutionId: PipelineExecutionId;
1039 }
1040 export interface GetPipelineExecutionOutput {
1041 /**
1042 * Represents information about the execution of a pipeline.
1043 */
1044 pipelineExecution?: PipelineExecution;
1045 }
1046 export interface GetPipelineInput {
1047 /**
1048 * The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.
1049 */
1050 name: PipelineName;
1051 /**
1052 * The version number of the pipeline. If you do not specify a version, defaults to the current version.
1053 */
1054 version?: PipelineVersion;
1055 }
1056 export interface GetPipelineOutput {
1057 /**
1058 * Represents the structure of actions and stages to be performed in the pipeline.
1059 */
1060 pipeline?: PipelineDeclaration;
1061 /**
1062 * Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
1063 */
1064 metadata?: PipelineMetadata;
1065 }
1066 export interface GetPipelineStateInput {
1067 /**
1068 * The name of the pipeline about which you want to get information.
1069 */
1070 name: PipelineName;
1071 }
1072 export interface GetPipelineStateOutput {
1073 /**
1074 * The name of the pipeline for which you want to get the state.
1075 */
1076 pipelineName?: PipelineName;
1077 /**
1078 * The version number of the pipeline. A newly created pipeline is always assigned a version number of 1.
1079 */
1080 pipelineVersion?: PipelineVersion;
1081 /**
1082 * A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
1083 */
1084 stageStates?: StageStateList;
1085 /**
1086 * The date and time the pipeline was created, in timestamp format.
1087 */
1088 created?: Timestamp;
1089 /**
1090 * The date and time the pipeline was last updated, in timestamp format.
1091 */
1092 updated?: Timestamp;
1093 }
1094 export interface GetThirdPartyJobDetailsInput {
1095 /**
1096 * The unique system-generated ID used for identifying the job.
1097 */
1098 jobId: ThirdPartyJobId;
1099 /**
1100 * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
1101 */
1102 clientToken: ClientToken;
1103 }
1104 export interface GetThirdPartyJobDetailsOutput {
1105 /**
1106 * The details of the job, including any protected values defined for the job.
1107 */
1108 jobDetails?: ThirdPartyJobDetails;
1109 }
1110 export interface InputArtifact {
1111 /**
1112 * The name of the artifact to be worked on (for example, "My App"). The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
1113 */
1114 name: ArtifactName;
1115 }
1116 export type InputArtifactList = InputArtifact[];
1117 export interface Job {
1118 /**
1119 * The unique system-generated ID of the job.
1120 */
1121 id?: JobId;
1122 /**
1123 * Other data about a job.
1124 */
1125 data?: JobData;
1126 /**
1127 * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
1128 */
1129 nonce?: Nonce;
1130 /**
1131 * The ID of the AWS account to use when performing the job.
1132 */
1133 accountId?: AccountId;
1134 }
1135 export interface JobData {
1136 /**
1137 * Represents information about an action type.
1138 */
1139 actionTypeId?: ActionTypeId;
1140 /**
1141 * Represents information about an action configuration.
1142 */
1143 actionConfiguration?: ActionConfiguration;
1144 /**
1145 * Represents information about a pipeline to a job worker. Includes pipelineArn and pipelineExecutionId for custom jobs.
1146 */
1147 pipelineContext?: PipelineContext;
1148 /**
1149 * The artifact supplied to the job.
1150 */
1151 inputArtifacts?: ArtifactList;
1152 /**
1153 * The output of the job.
1154 */
1155 outputArtifacts?: ArtifactList;
1156 /**
1157 * Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
1158 */
1159 artifactCredentials?: AWSSessionCredentials;
1160 /**
1161 * A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
1162 */
1163 continuationToken?: ContinuationToken;
1164 /**
1165 * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
1166 */
1167 encryptionKey?: EncryptionKey;
1168 }
1169 export interface JobDetails {
1170 /**
1171 * The unique system-generated ID of the job.
1172 */
1173 id?: JobId;
1174 /**
1175 * Represents other information about a job required for a job worker to complete the job.
1176 */
1177 data?: JobData;
1178 /**
1179 * The AWS account ID associated with the job.
1180 */
1181 accountId?: AccountId;
1182 }
1183 export type JobId = string;
1184 export type JobList = Job[];
1185 export type JobStatus = "Created"|"Queued"|"Dispatched"|"InProgress"|"TimedOut"|"Succeeded"|"Failed"|string;
1186 export type JsonPath = string;
1187 export type LastChangedAt = Date;
1188 export type LastChangedBy = string;
1189 export type LastUpdatedBy = string;
1190 export interface ListActionExecutionsInput {
1191 /**
1192 * The name of the pipeline for which you want to list action execution history.
1193 */
1194 pipelineName: PipelineName;
1195 /**
1196 * Input information used to filter action execution history.
1197 */
1198 filter?: ActionExecutionFilter;
1199 /**
1200 * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. Detailed execution history is available for executions run on or after February 21, 2019.
1201 */
1202 maxResults?: MaxResults;
1203 /**
1204 * The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
1205 */
1206 nextToken?: NextToken;
1207 }
1208 export interface ListActionExecutionsOutput {
1209 /**
1210 * The details for a list of recent executions, such as action execution ID.
1211 */
1212 actionExecutionDetails?: ActionExecutionDetailList;
1213 /**
1214 * If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.
1215 */
1216 nextToken?: NextToken;
1217 }
1218 export interface ListActionTypesInput {
1219 /**
1220 * Filters the list of action types to those created by a specified entity.
1221 */
1222 actionOwnerFilter?: ActionOwner;
1223 /**
1224 * An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
1225 */
1226 nextToken?: NextToken;
1227 }
1228 export interface ListActionTypesOutput {
1229 /**
1230 * Provides details of the action types.
1231 */
1232 actionTypes: ActionTypeList;
1233 /**
1234 * If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.
1235 */
1236 nextToken?: NextToken;
1237 }
1238 export interface ListPipelineExecutionsInput {
1239 /**
1240 * The name of the pipeline for which you want to get execution summary information.
1241 */
1242 pipelineName: PipelineName;
1243 /**
1244 * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
1245 */
1246 maxResults?: MaxResults;
1247 /**
1248 * The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
1249 */
1250 nextToken?: NextToken;
1251 }
1252 export interface ListPipelineExecutionsOutput {
1253 /**
1254 * A list of executions in the history of a pipeline.
1255 */
1256 pipelineExecutionSummaries?: PipelineExecutionSummaryList;
1257 /**
1258 * A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
1259 */
1260 nextToken?: NextToken;
1261 }
1262 export interface ListPipelinesInput {
1263 /**
1264 * An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
1265 */
1266 nextToken?: NextToken;
1267 }
1268 export interface ListPipelinesOutput {
1269 /**
1270 * The list of pipelines.
1271 */
1272 pipelines?: PipelineList;
1273 /**
1274 * If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
1275 */
1276 nextToken?: NextToken;
1277 }
1278 export interface ListTagsForResourceInput {
1279 /**
1280 * The Amazon Resource Name (ARN) of the resource to get tags for.
1281 */
1282 resourceArn: ResourceArn;
1283 /**
1284 * The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
1285 */
1286 nextToken?: NextToken;
1287 /**
1288 * The maximum number of results to return in a single call.
1289 */
1290 maxResults?: MaxResults;
1291 }
1292 export interface ListTagsForResourceOutput {
1293 /**
1294 * The tags for the resource.
1295 */
1296 tags?: TagList;
1297 /**
1298 * If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
1299 */
1300 nextToken?: NextToken;
1301 }
1302 export interface ListWebhookItem {
1303 /**
1304 * The detail returned for each webhook, such as the webhook authentication type and filter rules.
1305 */
1306 definition: WebhookDefinition;
1307 /**
1308 * A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
1309 */
1310 url: WebhookUrl;
1311 /**
1312 * The text of the error message about the webhook.
1313 */
1314 errorMessage?: WebhookErrorMessage;
1315 /**
1316 * The number code of the error.
1317 */
1318 errorCode?: WebhookErrorCode;
1319 /**
1320 * The date and time a webhook was last successfully triggered, in timestamp format.
1321 */
1322 lastTriggered?: WebhookLastTriggered;
1323 /**
1324 * The Amazon Resource Name (ARN) of the webhook.
1325 */
1326 arn?: WebhookArn;
1327 /**
1328 * Specifies the tags applied to the webhook.
1329 */
1330 tags?: TagList;
1331 }
1332 export interface ListWebhooksInput {
1333 /**
1334 * The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
1335 */
1336 NextToken?: NextToken;
1337 /**
1338 * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
1339 */
1340 MaxResults?: MaxResults;
1341 }
1342 export interface ListWebhooksOutput {
1343 /**
1344 * The JSON detail returned for each webhook in the list output for the ListWebhooks call.
1345 */
1346 webhooks?: WebhookList;
1347 /**
1348 * If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.
1349 */
1350 NextToken?: NextToken;
1351 }
1352 export type MatchEquals = string;
1353 export type MaxBatchSize = number;
1354 export type MaxResults = number;
1355 export type MaximumArtifactCount = number;
1356 export type Message = string;
1357 export type MinimumArtifactCount = number;
1358 export type NextToken = string;
1359 export type Nonce = string;
1360 export interface OutputArtifact {
1361 /**
1362 * The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
1363 */
1364 name: ArtifactName;
1365 }
1366 export type OutputArtifactList = OutputArtifact[];
1367 export type Percentage = number;
1368 export type PipelineArn = string;
1369 export interface PipelineContext {
1370 /**
1371 * The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
1372 */
1373 pipelineName?: PipelineName;
1374 /**
1375 * The stage of the pipeline.
1376 */
1377 stage?: StageContext;
1378 /**
1379 * The context of an action to a job worker in the stage of a pipeline.
1380 */
1381 action?: ActionContext;
1382 /**
1383 * The Amazon Resource Name (ARN) of the pipeline.
1384 */
1385 pipelineArn?: PipelineArn;
1386 /**
1387 * The execution ID of the pipeline.
1388 */
1389 pipelineExecutionId?: PipelineExecutionId;
1390 }
1391 export interface PipelineDeclaration {
1392 /**
1393 * The name of the action to be performed.
1394 */
1395 name: PipelineName;
1396 /**
1397 * The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
1398 */
1399 roleArn: RoleArn;
1400 /**
1401 * Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
1402 */
1403 artifactStore?: ArtifactStore;
1404 /**
1405 * A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
1406 */
1407 artifactStores?: ArtifactStoreMap;
1408 /**
1409 * The stage in which to perform the action.
1410 */
1411 stages: PipelineStageDeclarationList;
1412 /**
1413 * The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
1414 */
1415 version?: PipelineVersion;
1416 }
1417 export interface PipelineExecution {
1418 /**
1419 * The name of the pipeline that was executed.
1420 */
1421 pipelineName?: PipelineName;
1422 /**
1423 * The version number of the pipeline that was executed.
1424 */
1425 pipelineVersion?: PipelineVersion;
1426 /**
1427 * The ID of the pipeline execution.
1428 */
1429 pipelineExecutionId?: PipelineExecutionId;
1430 /**
1431 * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. Failed: The pipeline execution was not completed successfully.
1432 */
1433 status?: PipelineExecutionStatus;
1434 /**
1435 * A list of ArtifactRevision objects included in a pipeline execution.
1436 */
1437 artifactRevisions?: ArtifactRevisionList;
1438 }
1439 export type PipelineExecutionId = string;
1440 export type PipelineExecutionStatus = "InProgress"|"Succeeded"|"Superseded"|"Failed"|string;
1441 export interface PipelineExecutionSummary {
1442 /**
1443 * The ID of the pipeline execution.
1444 */
1445 pipelineExecutionId?: PipelineExecutionId;
1446 /**
1447 * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. Failed: The pipeline execution was not completed successfully.
1448 */
1449 status?: PipelineExecutionStatus;
1450 /**
1451 * The date and time when the pipeline execution began, in timestamp format.
1452 */
1453 startTime?: Timestamp;
1454 /**
1455 * The date and time of the last change to the pipeline execution, in timestamp format.
1456 */
1457 lastUpdateTime?: Timestamp;
1458 /**
1459 * A list of the source artifact revisions that initiated a pipeline execution.
1460 */
1461 sourceRevisions?: SourceRevisionList;
1462 /**
1463 * The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
1464 */
1465 trigger?: ExecutionTrigger;
1466 }
1467 export type PipelineExecutionSummaryList = PipelineExecutionSummary[];
1468 export type PipelineList = PipelineSummary[];
1469 export interface PipelineMetadata {
1470 /**
1471 * The Amazon Resource Name (ARN) of the pipeline.
1472 */
1473 pipelineArn?: PipelineArn;
1474 /**
1475 * The date and time the pipeline was created, in timestamp format.
1476 */
1477 created?: Timestamp;
1478 /**
1479 * The date and time the pipeline was last updated, in timestamp format.
1480 */
1481 updated?: Timestamp;
1482 }
1483 export type PipelineName = string;
1484 export type PipelineStageDeclarationList = StageDeclaration[];
1485 export interface PipelineSummary {
1486 /**
1487 * The name of the pipeline.
1488 */
1489 name?: PipelineName;
1490 /**
1491 * The version number of the pipeline.
1492 */
1493 version?: PipelineVersion;
1494 /**
1495 * The date and time the pipeline was created, in timestamp format.
1496 */
1497 created?: Timestamp;
1498 /**
1499 * The date and time of the last update to the pipeline, in timestamp format.
1500 */
1501 updated?: Timestamp;
1502 }
1503 export type PipelineVersion = number;
1504 export interface PollForJobsInput {
1505 /**
1506 * Represents information about an action type.
1507 */
1508 actionTypeId: ActionTypeId;
1509 /**
1510 * The maximum number of jobs to return in a poll for jobs call.
1511 */
1512 maxBatchSize?: MaxBatchSize;
1513 /**
1514 * A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.
1515 */
1516 queryParam?: QueryParamMap;
1517 }
1518 export interface PollForJobsOutput {
1519 /**
1520 * Information about the jobs to take action on.
1521 */
1522 jobs?: JobList;
1523 }
1524 export interface PollForThirdPartyJobsInput {
1525 /**
1526 * Represents information about an action type.
1527 */
1528 actionTypeId: ActionTypeId;
1529 /**
1530 * The maximum number of jobs to return in a poll for jobs call.
1531 */
1532 maxBatchSize?: MaxBatchSize;
1533 }
1534 export interface PollForThirdPartyJobsOutput {
1535 /**
1536 * Information about the jobs to take action on.
1537 */
1538 jobs?: ThirdPartyJobList;
1539 }
1540 export interface PutActionRevisionInput {
1541 /**
1542 * The name of the pipeline that starts processing the revision to the source.
1543 */
1544 pipelineName: PipelineName;
1545 /**
1546 * The name of the stage that contains the action that acts on the revision.
1547 */
1548 stageName: StageName;
1549 /**
1550 * The name of the action that processes the revision.
1551 */
1552 actionName: ActionName;
1553 /**
1554 * Represents information about the version (or revision) of an action.
1555 */
1556 actionRevision: ActionRevision;
1557 }
1558 export interface PutActionRevisionOutput {
1559 /**
1560 * Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
1561 */
1562 newRevision?: Boolean;
1563 /**
1564 * The ID of the current workflow state of the pipeline.
1565 */
1566 pipelineExecutionId?: PipelineExecutionId;
1567 }
1568 export interface PutApprovalResultInput {
1569 /**
1570 * The name of the pipeline that contains the action.
1571 */
1572 pipelineName: PipelineName;
1573 /**
1574 * The name of the stage that contains the action.
1575 */
1576 stageName: StageName;
1577 /**
1578 * The name of the action for which approval is requested.
1579 */
1580 actionName: ActionName;
1581 /**
1582 * Represents information about the result of the approval request.
1583 */
1584 result: ApprovalResult;
1585 /**
1586 * The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
1587 */
1588 token: ApprovalToken;
1589 }
1590 export interface PutApprovalResultOutput {
1591 /**
1592 * The timestamp showing when the approval or rejection was submitted.
1593 */
1594 approvedAt?: Timestamp;
1595 }
1596 export interface PutJobFailureResultInput {
1597 /**
1598 * The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
1599 */
1600 jobId: JobId;
1601 /**
1602 * The details about the failure of a job.
1603 */
1604 failureDetails: FailureDetails;
1605 }
1606 export interface PutJobSuccessResultInput {
1607 /**
1608 * The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
1609 */
1610 jobId: JobId;
1611 /**
1612 * The ID of the current revision of the artifact successfully worked on by the job.
1613 */
1614 currentRevision?: CurrentRevision;
1615 /**
1616 * A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
1617 */
1618 continuationToken?: ContinuationToken;
1619 /**
1620 * The execution details of the successful job, such as the actions taken by the job worker.
1621 */
1622 executionDetails?: ExecutionDetails;
1623 }
1624 export interface PutThirdPartyJobFailureResultInput {
1625 /**
1626 * The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
1627 */
1628 jobId: ThirdPartyJobId;
1629 /**
1630 * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
1631 */
1632 clientToken: ClientToken;
1633 /**
1634 * Represents information about failure details.
1635 */
1636 failureDetails: FailureDetails;
1637 }
1638 export interface PutThirdPartyJobSuccessResultInput {
1639 /**
1640 * The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
1641 */
1642 jobId: ThirdPartyJobId;
1643 /**
1644 * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
1645 */
1646 clientToken: ClientToken;
1647 /**
1648 * Represents information about a current revision.
1649 */
1650 currentRevision?: CurrentRevision;
1651 /**
1652 * A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
1653 */
1654 continuationToken?: ContinuationToken;
1655 /**
1656 * The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
1657 */
1658 executionDetails?: ExecutionDetails;
1659 }
1660 export interface PutWebhookInput {
1661 /**
1662 * The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.
1663 */
1664 webhook: WebhookDefinition;
1665 /**
1666 * The tags for the webhook.
1667 */
1668 tags?: TagList;
1669 }
1670 export interface PutWebhookOutput {
1671 /**
1672 * The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
1673 */
1674 webhook?: ListWebhookItem;
1675 }
1676 export type QueryParamMap = {[key: string]: ActionConfigurationQueryableValue};
1677 export interface RegisterWebhookWithThirdPartyInput {
1678 /**
1679 * The name of an existing webhook created with PutWebhook to register with a supported third party.
1680 */
1681 webhookName?: WebhookName;
1682 }
1683 export interface RegisterWebhookWithThirdPartyOutput {
1684 }
1685 export type ResourceArn = string;
1686 export interface RetryStageExecutionInput {
1687 /**
1688 * The name of the pipeline that contains the failed stage.
1689 */
1690 pipelineName: PipelineName;
1691 /**
1692 * The name of the failed stage to be retried.
1693 */
1694 stageName: StageName;
1695 /**
1696 * The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
1697 */
1698 pipelineExecutionId: PipelineExecutionId;
1699 /**
1700 * The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
1701 */
1702 retryMode: StageRetryMode;
1703 }
1704 export interface RetryStageExecutionOutput {
1705 /**
1706 * The ID of the current workflow execution in the failed stage.
1707 */
1708 pipelineExecutionId?: PipelineExecutionId;
1709 }
1710 export type Revision = string;
1711 export type RevisionChangeIdentifier = string;
1712 export type RevisionSummary = string;
1713 export type RoleArn = string;
1714 export interface S3ArtifactLocation {
1715 /**
1716 * The name of the Amazon S3 bucket.
1717 */
1718 bucketName: S3BucketName;
1719 /**
1720 * The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
1721 */
1722 objectKey: S3ObjectKey;
1723 }
1724 export type S3Bucket = string;
1725 export type S3BucketName = string;
1726 export type S3Key = string;
1727 export interface S3Location {
1728 /**
1729 * The Amazon S3 artifact bucket for an action's artifacts.
1730 */
1731 bucket?: S3Bucket;
1732 /**
1733 * The artifact name.
1734 */
1735 key?: S3Key;
1736 }
1737 export type S3ObjectKey = string;
1738 export type SecretAccessKey = string;
1739 export type SessionToken = string;
1740 export interface SourceRevision {
1741 /**
1742 * The name of the action that processed the revision to the source artifact.
1743 */
1744 actionName: ActionName;
1745 /**
1746 * The system-generated unique ID that identifies the revision number of the artifact.
1747 */
1748 revisionId?: Revision;
1749 /**
1750 * Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
1751 */
1752 revisionSummary?: RevisionSummary;
1753 /**
1754 * The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
1755 */
1756 revisionUrl?: Url;
1757 }
1758 export type SourceRevisionList = SourceRevision[];
1759 export type StageActionDeclarationList = ActionDeclaration[];
1760 export type StageBlockerDeclarationList = BlockerDeclaration[];
1761 export interface StageContext {
1762 /**
1763 * The name of the stage.
1764 */
1765 name?: StageName;
1766 }
1767 export interface StageDeclaration {
1768 /**
1769 * The name of the stage.
1770 */
1771 name: StageName;
1772 /**
1773 * Reserved for future use.
1774 */
1775 blockers?: StageBlockerDeclarationList;
1776 /**
1777 * The actions included in a stage.
1778 */
1779 actions: StageActionDeclarationList;
1780 }
1781 export interface StageExecution {
1782 /**
1783 * The ID of the pipeline execution associated with the stage.
1784 */
1785 pipelineExecutionId: PipelineExecutionId;
1786 /**
1787 * The status of the stage, or for a completed stage, the last status of the stage.
1788 */
1789 status: StageExecutionStatus;
1790 }
1791 export type StageExecutionStatus = "InProgress"|"Failed"|"Succeeded"|string;
1792 export type StageName = string;
1793 export type StageRetryMode = "FAILED_ACTIONS"|string;
1794 export interface StageState {
1795 /**
1796 * The name of the stage.
1797 */
1798 stageName?: StageName;
1799 /**
1800 * The state of the inbound transition, which is either enabled or disabled.
1801 */
1802 inboundTransitionState?: TransitionState;
1803 /**
1804 * The state of the stage.
1805 */
1806 actionStates?: ActionStateList;
1807 /**
1808 * Information about the latest execution in the stage, including its ID and status.
1809 */
1810 latestExecution?: StageExecution;
1811 }
1812 export type StageStateList = StageState[];
1813 export type StageTransitionType = "Inbound"|"Outbound"|string;
1814 export interface StartPipelineExecutionInput {
1815 /**
1816 * The name of the pipeline to start.
1817 */
1818 name: PipelineName;
1819 /**
1820 * The system-generated unique ID used to identify a unique execution request.
1821 */
1822 clientRequestToken?: ClientRequestToken;
1823 }
1824 export interface StartPipelineExecutionOutput {
1825 /**
1826 * The unique system-generated ID of the pipeline execution that was started.
1827 */
1828 pipelineExecutionId?: PipelineExecutionId;
1829 }
1830 export interface Tag {
1831 /**
1832 * The tag's key.
1833 */
1834 key: TagKey;
1835 /**
1836 * The tag's value.
1837 */
1838 value: TagValue;
1839 }
1840 export type TagKey = string;
1841 export type TagKeyList = TagKey[];
1842 export type TagList = Tag[];
1843 export interface TagResourceInput {
1844 /**
1845 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
1846 */
1847 resourceArn: ResourceArn;
1848 /**
1849 * The tags you want to modify or add to the resource.
1850 */
1851 tags: TagList;
1852 }
1853 export interface TagResourceOutput {
1854 }
1855 export type TagValue = string;
1856 export interface ThirdPartyJob {
1857 /**
1858 * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
1859 */
1860 clientId?: ClientId;
1861 /**
1862 * The identifier used to identify the job in AWS CodePipeline.
1863 */
1864 jobId?: JobId;
1865 }
1866 export interface ThirdPartyJobData {
1867 /**
1868 * Represents information about an action type.
1869 */
1870 actionTypeId?: ActionTypeId;
1871 /**
1872 * Represents information about an action configuration.
1873 */
1874 actionConfiguration?: ActionConfiguration;
1875 /**
1876 * Represents information about a pipeline to a job worker. Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
1877 */
1878 pipelineContext?: PipelineContext;
1879 /**
1880 * The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
1881 */
1882 inputArtifacts?: ArtifactList;
1883 /**
1884 * The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
1885 */
1886 outputArtifacts?: ArtifactList;
1887 /**
1888 * Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
1889 */
1890 artifactCredentials?: AWSSessionCredentials;
1891 /**
1892 * A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
1893 */
1894 continuationToken?: ContinuationToken;
1895 /**
1896 * The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
1897 */
1898 encryptionKey?: EncryptionKey;
1899 }
1900 export interface ThirdPartyJobDetails {
1901 /**
1902 * The identifier used to identify the job details in AWS CodePipeline.
1903 */
1904 id?: ThirdPartyJobId;
1905 /**
1906 * The data to be returned by the third party job worker.
1907 */
1908 data?: ThirdPartyJobData;
1909 /**
1910 * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
1911 */
1912 nonce?: Nonce;
1913 }
1914 export type ThirdPartyJobId = string;
1915 export type ThirdPartyJobList = ThirdPartyJob[];
1916 export type Time = Date;
1917 export type Timestamp = Date;
1918 export interface TransitionState {
1919 /**
1920 * Whether the transition between stages is enabled (true) or disabled (false).
1921 */
1922 enabled?: Enabled;
1923 /**
1924 * The ID of the user who last changed the transition state.
1925 */
1926 lastChangedBy?: LastChangedBy;
1927 /**
1928 * The timestamp when the transition state was last changed.
1929 */
1930 lastChangedAt?: LastChangedAt;
1931 /**
1932 * The user-specified reason why the transition between two stages of a pipeline was disabled.
1933 */
1934 disabledReason?: DisabledReason;
1935 }
1936 export type TriggerDetail = string;
1937 export type TriggerType = "CreatePipeline"|"StartPipelineExecution"|"PollForSourceChanges"|"Webhook"|"CloudWatchEvent"|"PutActionRevision"|string;
1938 export interface UntagResourceInput {
1939 /**
1940 * The Amazon Resource Name (ARN) of the resource to remove tags from.
1941 */
1942 resourceArn: ResourceArn;
1943 /**
1944 * The list of keys for the tags to be removed from the resource.
1945 */
1946 tagKeys: TagKeyList;
1947 }
1948 export interface UntagResourceOutput {
1949 }
1950 export interface UpdatePipelineInput {
1951 /**
1952 * The name of the pipeline to be updated.
1953 */
1954 pipeline: PipelineDeclaration;
1955 }
1956 export interface UpdatePipelineOutput {
1957 /**
1958 * The structure of the updated pipeline.
1959 */
1960 pipeline?: PipelineDeclaration;
1961 }
1962 export type Url = string;
1963 export type UrlTemplate = string;
1964 export type Version = string;
1965 export type WebhookArn = string;
1966 export interface WebhookAuthConfiguration {
1967 /**
1968 * The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
1969 */
1970 AllowedIPRange?: WebhookAuthConfigurationAllowedIPRange;
1971 /**
1972 * The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
1973 */
1974 SecretToken?: WebhookAuthConfigurationSecretToken;
1975 }
1976 export type WebhookAuthConfigurationAllowedIPRange = string;
1977 export type WebhookAuthConfigurationSecretToken = string;
1978 export type WebhookAuthenticationType = "GITHUB_HMAC"|"IP"|"UNAUTHENTICATED"|string;
1979 export interface WebhookDefinition {
1980 /**
1981 * The name of the webhook.
1982 */
1983 name: WebhookName;
1984 /**
1985 * The name of the pipeline you want to connect to the webhook.
1986 */
1987 targetPipeline: PipelineName;
1988 /**
1989 * The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
1990 */
1991 targetAction: ActionName;
1992 /**
1993 * A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
1994 */
1995 filters: WebhookFilters;
1996 /**
1997 * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website. IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
1998 */
1999 authentication: WebhookAuthenticationType;
2000 /**
2001 * Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
2002 */
2003 authenticationConfiguration: WebhookAuthConfiguration;
2004 }
2005 export type WebhookErrorCode = string;
2006 export type WebhookErrorMessage = string;
2007 export interface WebhookFilterRule {
2008 /**
2009 * A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
2010 */
2011 jsonPath: JsonPath;
2012 /**
2013 * The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
2014 */
2015 matchEquals?: MatchEquals;
2016 }
2017 export type WebhookFilters = WebhookFilterRule[];
2018 export type WebhookLastTriggered = Date;
2019 export type WebhookList = ListWebhookItem[];
2020 export type WebhookName = string;
2021 export type WebhookUrl = string;
2022 /**
2023 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2024 */
2025 export type apiVersion = "2015-07-09"|"latest"|string;
2026 export interface ClientApiVersions {
2027 /**
2028 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2029 */
2030 apiVersion?: apiVersion;
2031 }
2032 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2033 /**
2034 * Contains interfaces for use with the CodePipeline client.
2035 */
2036 export import Types = CodePipeline;
2037}
2038export = CodePipeline;