UNPKG

99.2 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 S3 bucket used to store artifacts for the pipeline, if the action requires access to that 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 * Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
280 */
281 stopPipelineExecution(params: CodePipeline.Types.StopPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StopPipelineExecutionOutput) => void): Request<CodePipeline.Types.StopPipelineExecutionOutput, AWSError>;
282 /**
283 * Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
284 */
285 stopPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StopPipelineExecutionOutput) => void): Request<CodePipeline.Types.StopPipelineExecutionOutput, AWSError>;
286 /**
287 * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
288 */
289 tagResource(params: CodePipeline.Types.TagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
290 /**
291 * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
292 */
293 tagResource(callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
294 /**
295 * Removes tags from an AWS resource.
296 */
297 untagResource(params: CodePipeline.Types.UntagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
298 /**
299 * Removes tags from an AWS resource.
300 */
301 untagResource(callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
302 /**
303 * 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.
304 */
305 updatePipeline(params: CodePipeline.Types.UpdatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
306 /**
307 * 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.
308 */
309 updatePipeline(callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
310}
311declare namespace CodePipeline {
312 export type AWSRegionName = string;
313 export interface AWSSessionCredentials {
314 /**
315 * The access key for the session.
316 */
317 accessKeyId: AccessKeyId;
318 /**
319 * The secret access key for the session.
320 */
321 secretAccessKey: SecretAccessKey;
322 /**
323 * The token for the session.
324 */
325 sessionToken: SessionToken;
326 }
327 export type AccessKeyId = string;
328 export type AccountId = string;
329 export interface AcknowledgeJobInput {
330 /**
331 * The unique system-generated ID of the job for which you want to confirm receipt.
332 */
333 jobId: JobId;
334 /**
335 * 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.
336 */
337 nonce: Nonce;
338 }
339 export interface AcknowledgeJobOutput {
340 /**
341 * Whether the job worker has received the specified job.
342 */
343 status?: JobStatus;
344 }
345 export interface AcknowledgeThirdPartyJobInput {
346 /**
347 * The unique system-generated ID of the job.
348 */
349 jobId: ThirdPartyJobId;
350 /**
351 * 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.
352 */
353 nonce: Nonce;
354 /**
355 * 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.
356 */
357 clientToken: ClientToken;
358 }
359 export interface AcknowledgeThirdPartyJobOutput {
360 /**
361 * The status information for the third party job, if any.
362 */
363 status?: JobStatus;
364 }
365 export type ActionCategory = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|string;
366 export interface ActionConfiguration {
367 /**
368 * The configuration data for the action.
369 */
370 configuration?: ActionConfigurationMap;
371 }
372 export type ActionConfigurationKey = string;
373 export type ActionConfigurationMap = {[key: string]: ActionConfigurationValue};
374 export interface ActionConfigurationProperty {
375 /**
376 * The name of the action configuration property.
377 */
378 name: ActionConfigurationKey;
379 /**
380 * Whether the configuration property is a required value.
381 */
382 required: Boolean;
383 /**
384 * Whether the configuration property is a key.
385 */
386 key: Boolean;
387 /**
388 * 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.
389 */
390 secret: Boolean;
391 /**
392 * 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.
393 */
394 queryable?: Boolean;
395 /**
396 * The description of the action configuration property that is displayed to users.
397 */
398 description?: Description;
399 /**
400 * The type of the configuration property.
401 */
402 type?: ActionConfigurationPropertyType;
403 }
404 export type ActionConfigurationPropertyList = ActionConfigurationProperty[];
405 export type ActionConfigurationPropertyType = "String"|"Number"|"Boolean"|string;
406 export type ActionConfigurationQueryableValue = string;
407 export type ActionConfigurationValue = string;
408 export interface ActionContext {
409 /**
410 * The name of the action in the context of a job.
411 */
412 name?: ActionName;
413 /**
414 * The system-generated unique ID that corresponds to an action's execution.
415 */
416 actionExecutionId?: ActionExecutionId;
417 }
418 export interface ActionDeclaration {
419 /**
420 * The action declaration's name.
421 */
422 name: ActionName;
423 /**
424 * Specifies the action type and the provider of the action.
425 */
426 actionTypeId: ActionTypeId;
427 /**
428 * The order in which actions are run.
429 */
430 runOrder?: ActionRunOrder;
431 /**
432 * 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 },
433 */
434 configuration?: ActionConfigurationMap;
435 /**
436 * The name or ID of the result of the action declaration, such as a test or build artifact.
437 */
438 outputArtifacts?: OutputArtifactList;
439 /**
440 * The name or ID of the artifact consumed by the action, such as a test or build artifact.
441 */
442 inputArtifacts?: InputArtifactList;
443 /**
444 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
445 */
446 roleArn?: RoleArn;
447 /**
448 * The action declaration's AWS Region, such as us-east-1.
449 */
450 region?: AWSRegionName;
451 /**
452 * The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
453 */
454 namespace?: ActionNamespace;
455 }
456 export interface ActionExecution {
457 /**
458 * The status of the action, or for a completed action, the last status of the action.
459 */
460 status?: ActionExecutionStatus;
461 /**
462 * A summary of the run of the action.
463 */
464 summary?: ExecutionSummary;
465 /**
466 * The last status change of the action.
467 */
468 lastStatusChange?: Timestamp;
469 /**
470 * 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.
471 */
472 token?: ActionExecutionToken;
473 /**
474 * The ARN of the user who last changed the pipeline.
475 */
476 lastUpdatedBy?: LastUpdatedBy;
477 /**
478 * The external ID of the run of the action.
479 */
480 externalExecutionId?: ExecutionId;
481 /**
482 * The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
483 */
484 externalExecutionUrl?: Url;
485 /**
486 * A percentage of completeness of the action as it runs.
487 */
488 percentComplete?: Percentage;
489 /**
490 * The details of an error returned by a URL external to AWS.
491 */
492 errorDetails?: ErrorDetails;
493 }
494 export interface ActionExecutionDetail {
495 /**
496 * The pipeline execution ID for the action execution.
497 */
498 pipelineExecutionId?: PipelineExecutionId;
499 /**
500 * The action execution ID.
501 */
502 actionExecutionId?: ActionExecutionId;
503 /**
504 * The version of the pipeline where the action was run.
505 */
506 pipelineVersion?: PipelineVersion;
507 /**
508 * The name of the stage that contains the action.
509 */
510 stageName?: StageName;
511 /**
512 * The name of the action.
513 */
514 actionName?: ActionName;
515 /**
516 * The start time of the action execution.
517 */
518 startTime?: Timestamp;
519 /**
520 * The last update time of the action execution.
521 */
522 lastUpdateTime?: Timestamp;
523 /**
524 * The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
525 */
526 status?: ActionExecutionStatus;
527 /**
528 * Input details for the action execution, such as role ARN, Region, and input artifacts.
529 */
530 input?: ActionExecutionInput;
531 /**
532 * Output details for the action execution, such as the action execution result.
533 */
534 output?: ActionExecutionOutput;
535 }
536 export type ActionExecutionDetailList = ActionExecutionDetail[];
537 export interface ActionExecutionFilter {
538 /**
539 * The pipeline execution ID used to filter action execution history.
540 */
541 pipelineExecutionId?: PipelineExecutionId;
542 }
543 export type ActionExecutionId = string;
544 export interface ActionExecutionInput {
545 actionTypeId?: ActionTypeId;
546 /**
547 * Configuration data for an action execution.
548 */
549 configuration?: ActionConfigurationMap;
550 /**
551 * Configuration data for an action execution with all variable references replaced with their real values for the execution.
552 */
553 resolvedConfiguration?: ResolvedActionConfigurationMap;
554 /**
555 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
556 */
557 roleArn?: RoleArn;
558 /**
559 * The AWS Region for the action, such as us-east-1.
560 */
561 region?: AWSRegionName;
562 /**
563 * Details of input artifacts of the action that correspond to the action execution.
564 */
565 inputArtifacts?: ArtifactDetailList;
566 /**
567 * The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
568 */
569 namespace?: ActionNamespace;
570 }
571 export interface ActionExecutionOutput {
572 /**
573 * Details of output artifacts of the action that correspond to the action execution.
574 */
575 outputArtifacts?: ArtifactDetailList;
576 /**
577 * Execution result information listed in the output details for an action execution.
578 */
579 executionResult?: ActionExecutionResult;
580 /**
581 * The outputVariables field shows the key-value pairs that were output as part of that execution.
582 */
583 outputVariables?: OutputVariablesMap;
584 }
585 export interface ActionExecutionResult {
586 /**
587 * The action provider's external ID for the action execution.
588 */
589 externalExecutionId?: ExternalExecutionId;
590 /**
591 * The action provider's summary for the action execution.
592 */
593 externalExecutionSummary?: ExternalExecutionSummary;
594 /**
595 * The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
596 */
597 externalExecutionUrl?: Url;
598 }
599 export type ActionExecutionStatus = "InProgress"|"Abandoned"|"Succeeded"|"Failed"|string;
600 export type ActionExecutionToken = string;
601 export type ActionName = string;
602 export type ActionNamespace = string;
603 export type ActionOwner = "AWS"|"ThirdParty"|"Custom"|string;
604 export type ActionProvider = string;
605 export interface ActionRevision {
606 /**
607 * The system-generated unique ID that identifies the revision number of the action.
608 */
609 revisionId: Revision;
610 /**
611 * The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
612 */
613 revisionChangeId: RevisionChangeIdentifier;
614 /**
615 * The date and time when the most recent version of the action was created, in timestamp format.
616 */
617 created: Timestamp;
618 }
619 export type ActionRunOrder = number;
620 export interface ActionState {
621 /**
622 * The name of the action.
623 */
624 actionName?: ActionName;
625 /**
626 * Represents information about the version (or revision) of an action.
627 */
628 currentRevision?: ActionRevision;
629 /**
630 * Represents information about the run of an action.
631 */
632 latestExecution?: ActionExecution;
633 /**
634 * A URL link for more information about the state of the action, such as a deployment group details page.
635 */
636 entityUrl?: Url;
637 /**
638 * A URL link for more information about the revision, such as a commit details page.
639 */
640 revisionUrl?: Url;
641 }
642 export type ActionStateList = ActionState[];
643 export interface ActionType {
644 /**
645 * Represents information about an action type.
646 */
647 id: ActionTypeId;
648 /**
649 * The settings for the action type.
650 */
651 settings?: ActionTypeSettings;
652 /**
653 * The configuration properties for the action type.
654 */
655 actionConfigurationProperties?: ActionConfigurationPropertyList;
656 /**
657 * The details of the input artifact for the action, such as its commit ID.
658 */
659 inputArtifactDetails: ArtifactDetails;
660 /**
661 * The details of the output artifact of the action, such as its commit ID.
662 */
663 outputArtifactDetails: ArtifactDetails;
664 }
665 export interface ActionTypeId {
666 /**
667 * 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.
668 */
669 category: ActionCategory;
670 /**
671 * The creator of the action being called.
672 */
673 owner: ActionOwner;
674 /**
675 * 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.
676 */
677 provider: ActionProvider;
678 /**
679 * A string that describes the action version.
680 */
681 version: Version;
682 }
683 export type ActionTypeList = ActionType[];
684 export interface ActionTypeSettings {
685 /**
686 * 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.
687 */
688 thirdPartyConfigurationUrl?: Url;
689 /**
690 * 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.
691 */
692 entityUrlTemplate?: UrlTemplate;
693 /**
694 * 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.
695 */
696 executionUrlTemplate?: UrlTemplate;
697 /**
698 * 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.
699 */
700 revisionUrlTemplate?: UrlTemplate;
701 }
702 export interface ApprovalResult {
703 /**
704 * The summary of the current status of the approval request.
705 */
706 summary: ApprovalSummary;
707 /**
708 * The response submitted by a reviewer assigned to an approval action request.
709 */
710 status: ApprovalStatus;
711 }
712 export type ApprovalStatus = "Approved"|"Rejected"|string;
713 export type ApprovalSummary = string;
714 export type ApprovalToken = string;
715 export interface Artifact {
716 /**
717 * The artifact's name.
718 */
719 name?: ArtifactName;
720 /**
721 * The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
722 */
723 revision?: Revision;
724 /**
725 * The location of an artifact.
726 */
727 location?: ArtifactLocation;
728 }
729 export interface ArtifactDetail {
730 /**
731 * The artifact object name for the action execution.
732 */
733 name?: ArtifactName;
734 /**
735 * The Amazon S3 artifact location for the action execution.
736 */
737 s3location?: S3Location;
738 }
739 export type ArtifactDetailList = ArtifactDetail[];
740 export interface ArtifactDetails {
741 /**
742 * The minimum number of artifacts allowed for the action type.
743 */
744 minimumCount: MinimumArtifactCount;
745 /**
746 * The maximum number of artifacts allowed for the action type.
747 */
748 maximumCount: MaximumArtifactCount;
749 }
750 export type ArtifactList = Artifact[];
751 export interface ArtifactLocation {
752 /**
753 * The type of artifact in the location.
754 */
755 type?: ArtifactLocationType;
756 /**
757 * The S3 bucket that contains the artifact.
758 */
759 s3Location?: S3ArtifactLocation;
760 }
761 export type ArtifactLocationType = "S3"|string;
762 export type ArtifactName = string;
763 export interface ArtifactRevision {
764 /**
765 * The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
766 */
767 name?: ArtifactName;
768 /**
769 * The revision ID of the artifact.
770 */
771 revisionId?: Revision;
772 /**
773 * An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
774 */
775 revisionChangeIdentifier?: RevisionChangeIdentifier;
776 /**
777 * 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.
778 */
779 revisionSummary?: RevisionSummary;
780 /**
781 * The date and time when the most recent revision of the artifact was created, in timestamp format.
782 */
783 created?: Timestamp;
784 /**
785 * 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.
786 */
787 revisionUrl?: Url;
788 }
789 export type ArtifactRevisionList = ArtifactRevision[];
790 export interface ArtifactStore {
791 /**
792 * The type of the artifact store, such as S3.
793 */
794 type: ArtifactStoreType;
795 /**
796 * The 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 S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
797 */
798 location: ArtifactStoreLocation;
799 /**
800 * 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.
801 */
802 encryptionKey?: EncryptionKey;
803 }
804 export type ArtifactStoreLocation = string;
805 export type ArtifactStoreMap = {[key: string]: ArtifactStore};
806 export type ArtifactStoreType = "S3"|string;
807 export interface BlockerDeclaration {
808 /**
809 * Reserved for future use.
810 */
811 name: BlockerName;
812 /**
813 * Reserved for future use.
814 */
815 type: BlockerType;
816 }
817 export type BlockerName = string;
818 export type BlockerType = "Schedule"|string;
819 export type Boolean = boolean;
820 export type ClientId = string;
821 export type ClientRequestToken = string;
822 export type ClientToken = string;
823 export type Code = string;
824 export type ContinuationToken = string;
825 export interface CreateCustomActionTypeInput {
826 /**
827 * 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.
828 */
829 category: ActionCategory;
830 /**
831 * The provider of the service used in the custom action, such as AWS CodeDeploy.
832 */
833 provider: ActionProvider;
834 /**
835 * The version identifier of the custom action.
836 */
837 version: Version;
838 /**
839 * URLs that provide users information about this custom action.
840 */
841 settings?: ActionTypeSettings;
842 /**
843 * 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.
844 */
845 configurationProperties?: ActionConfigurationPropertyList;
846 /**
847 * The details of the input artifact for the action, such as its commit ID.
848 */
849 inputArtifactDetails: ArtifactDetails;
850 /**
851 * The details of the output artifact of the action, such as its commit ID.
852 */
853 outputArtifactDetails: ArtifactDetails;
854 /**
855 * The tags for the custom action.
856 */
857 tags?: TagList;
858 }
859 export interface CreateCustomActionTypeOutput {
860 /**
861 * Returns information about the details of an action type.
862 */
863 actionType: ActionType;
864 /**
865 * Specifies the tags applied to the custom action.
866 */
867 tags?: TagList;
868 }
869 export interface CreatePipelineInput {
870 /**
871 * Represents the structure of actions and stages to be performed in the pipeline.
872 */
873 pipeline: PipelineDeclaration;
874 /**
875 * The tags for the pipeline.
876 */
877 tags?: TagList;
878 }
879 export interface CreatePipelineOutput {
880 /**
881 * Represents the structure of actions and stages to be performed in the pipeline.
882 */
883 pipeline?: PipelineDeclaration;
884 /**
885 * Specifies the tags applied to the pipeline.
886 */
887 tags?: TagList;
888 }
889 export interface CurrentRevision {
890 /**
891 * The revision ID of the current version of an artifact.
892 */
893 revision: Revision;
894 /**
895 * The change identifier for the current revision.
896 */
897 changeIdentifier: RevisionChangeIdentifier;
898 /**
899 * The date and time when the most recent revision of the artifact was created, in timestamp format.
900 */
901 created?: Time;
902 /**
903 * The summary of the most recent revision of the artifact.
904 */
905 revisionSummary?: RevisionSummary;
906 }
907 export interface DeleteCustomActionTypeInput {
908 /**
909 * The category of the custom action that you want to delete, such as source or deploy.
910 */
911 category: ActionCategory;
912 /**
913 * The provider of the service used in the custom action, such as AWS CodeDeploy.
914 */
915 provider: ActionProvider;
916 /**
917 * The version of the custom action to delete.
918 */
919 version: Version;
920 }
921 export interface DeletePipelineInput {
922 /**
923 * The name of the pipeline to be deleted.
924 */
925 name: PipelineName;
926 }
927 export interface DeleteWebhookInput {
928 /**
929 * The name of the webhook you want to delete.
930 */
931 name: WebhookName;
932 }
933 export interface DeleteWebhookOutput {
934 }
935 export interface DeregisterWebhookWithThirdPartyInput {
936 /**
937 * The name of the webhook you want to deregister.
938 */
939 webhookName?: WebhookName;
940 }
941 export interface DeregisterWebhookWithThirdPartyOutput {
942 }
943 export type Description = string;
944 export interface DisableStageTransitionInput {
945 /**
946 * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
947 */
948 pipelineName: PipelineName;
949 /**
950 * The name of the stage where you want to disable the inbound or outbound transition of artifacts.
951 */
952 stageName: StageName;
953 /**
954 * 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).
955 */
956 transitionType: StageTransitionType;
957 /**
958 * 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.
959 */
960 reason: DisabledReason;
961 }
962 export type DisabledReason = string;
963 export interface EnableStageTransitionInput {
964 /**
965 * The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
966 */
967 pipelineName: PipelineName;
968 /**
969 * 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).
970 */
971 stageName: StageName;
972 /**
973 * 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).
974 */
975 transitionType: StageTransitionType;
976 }
977 export type Enabled = boolean;
978 export interface EncryptionKey {
979 /**
980 * 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.
981 */
982 id: EncryptionKeyId;
983 /**
984 * 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'.
985 */
986 type: EncryptionKeyType;
987 }
988 export type EncryptionKeyId = string;
989 export type EncryptionKeyType = "KMS"|string;
990 export interface ErrorDetails {
991 /**
992 * The system ID or number code of the error.
993 */
994 code?: Code;
995 /**
996 * The text of the error message.
997 */
998 message?: Message;
999 }
1000 export interface ExecutionDetails {
1001 /**
1002 * The summary of the current status of the actions.
1003 */
1004 summary?: ExecutionSummary;
1005 /**
1006 * The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
1007 */
1008 externalExecutionId?: ExecutionId;
1009 /**
1010 * The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
1011 */
1012 percentComplete?: Percentage;
1013 }
1014 export type ExecutionId = string;
1015 export type ExecutionSummary = string;
1016 export interface ExecutionTrigger {
1017 /**
1018 * The type of change-detection method, command, or user interaction that started a pipeline execution.
1019 */
1020 triggerType?: TriggerType;
1021 /**
1022 * 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.
1023 */
1024 triggerDetail?: TriggerDetail;
1025 }
1026 export type ExternalExecutionId = string;
1027 export type ExternalExecutionSummary = string;
1028 export interface FailureDetails {
1029 /**
1030 * The type of the failure.
1031 */
1032 type: FailureType;
1033 /**
1034 * The message about the failure.
1035 */
1036 message: Message;
1037 /**
1038 * The external ID of the run of the action that failed.
1039 */
1040 externalExecutionId?: ExecutionId;
1041 }
1042 export type FailureType = "JobFailed"|"ConfigurationError"|"PermissionError"|"RevisionOutOfSync"|"RevisionUnavailable"|"SystemUnavailable"|string;
1043 export interface GetJobDetailsInput {
1044 /**
1045 * The unique system-generated ID for the job.
1046 */
1047 jobId: JobId;
1048 }
1049 export interface GetJobDetailsOutput {
1050 /**
1051 * The details of the job. If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
1052 */
1053 jobDetails?: JobDetails;
1054 }
1055 export interface GetPipelineExecutionInput {
1056 /**
1057 * The name of the pipeline about which you want to get execution details.
1058 */
1059 pipelineName: PipelineName;
1060 /**
1061 * The ID of the pipeline execution about which you want to get execution details.
1062 */
1063 pipelineExecutionId: PipelineExecutionId;
1064 }
1065 export interface GetPipelineExecutionOutput {
1066 /**
1067 * Represents information about the execution of a pipeline.
1068 */
1069 pipelineExecution?: PipelineExecution;
1070 }
1071 export interface GetPipelineInput {
1072 /**
1073 * The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.
1074 */
1075 name: PipelineName;
1076 /**
1077 * The version number of the pipeline. If you do not specify a version, defaults to the current version.
1078 */
1079 version?: PipelineVersion;
1080 }
1081 export interface GetPipelineOutput {
1082 /**
1083 * Represents the structure of actions and stages to be performed in the pipeline.
1084 */
1085 pipeline?: PipelineDeclaration;
1086 /**
1087 * Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
1088 */
1089 metadata?: PipelineMetadata;
1090 }
1091 export interface GetPipelineStateInput {
1092 /**
1093 * The name of the pipeline about which you want to get information.
1094 */
1095 name: PipelineName;
1096 }
1097 export interface GetPipelineStateOutput {
1098 /**
1099 * The name of the pipeline for which you want to get the state.
1100 */
1101 pipelineName?: PipelineName;
1102 /**
1103 * The version number of the pipeline. A newly created pipeline is always assigned a version number of 1.
1104 */
1105 pipelineVersion?: PipelineVersion;
1106 /**
1107 * A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
1108 */
1109 stageStates?: StageStateList;
1110 /**
1111 * The date and time the pipeline was created, in timestamp format.
1112 */
1113 created?: Timestamp;
1114 /**
1115 * The date and time the pipeline was last updated, in timestamp format.
1116 */
1117 updated?: Timestamp;
1118 }
1119 export interface GetThirdPartyJobDetailsInput {
1120 /**
1121 * The unique system-generated ID used for identifying the job.
1122 */
1123 jobId: ThirdPartyJobId;
1124 /**
1125 * 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.
1126 */
1127 clientToken: ClientToken;
1128 }
1129 export interface GetThirdPartyJobDetailsOutput {
1130 /**
1131 * The details of the job, including any protected values defined for the job.
1132 */
1133 jobDetails?: ThirdPartyJobDetails;
1134 }
1135 export interface InputArtifact {
1136 /**
1137 * 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.
1138 */
1139 name: ArtifactName;
1140 }
1141 export type InputArtifactList = InputArtifact[];
1142 export interface Job {
1143 /**
1144 * The unique system-generated ID of the job.
1145 */
1146 id?: JobId;
1147 /**
1148 * Other data about a job.
1149 */
1150 data?: JobData;
1151 /**
1152 * 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.
1153 */
1154 nonce?: Nonce;
1155 /**
1156 * The ID of the AWS account to use when performing the job.
1157 */
1158 accountId?: AccountId;
1159 }
1160 export interface JobData {
1161 /**
1162 * Represents information about an action type.
1163 */
1164 actionTypeId?: ActionTypeId;
1165 /**
1166 * Represents information about an action configuration.
1167 */
1168 actionConfiguration?: ActionConfiguration;
1169 /**
1170 * Represents information about a pipeline to a job worker. Includes pipelineArn and pipelineExecutionId for custom jobs.
1171 */
1172 pipelineContext?: PipelineContext;
1173 /**
1174 * The artifact supplied to the job.
1175 */
1176 inputArtifacts?: ArtifactList;
1177 /**
1178 * The output of the job.
1179 */
1180 outputArtifacts?: ArtifactList;
1181 /**
1182 * 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 S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
1183 */
1184 artifactCredentials?: AWSSessionCredentials;
1185 /**
1186 * A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
1187 */
1188 continuationToken?: ContinuationToken;
1189 /**
1190 * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
1191 */
1192 encryptionKey?: EncryptionKey;
1193 }
1194 export interface JobDetails {
1195 /**
1196 * The unique system-generated ID of the job.
1197 */
1198 id?: JobId;
1199 /**
1200 * Represents other information about a job required for a job worker to complete the job.
1201 */
1202 data?: JobData;
1203 /**
1204 * The AWS account ID associated with the job.
1205 */
1206 accountId?: AccountId;
1207 }
1208 export type JobId = string;
1209 export type JobList = Job[];
1210 export type JobStatus = "Created"|"Queued"|"Dispatched"|"InProgress"|"TimedOut"|"Succeeded"|"Failed"|string;
1211 export type JsonPath = string;
1212 export type LastChangedAt = Date;
1213 export type LastChangedBy = string;
1214 export type LastUpdatedBy = string;
1215 export interface ListActionExecutionsInput {
1216 /**
1217 * The name of the pipeline for which you want to list action execution history.
1218 */
1219 pipelineName: PipelineName;
1220 /**
1221 * Input information used to filter action execution history.
1222 */
1223 filter?: ActionExecutionFilter;
1224 /**
1225 * 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.
1226 */
1227 maxResults?: MaxResults;
1228 /**
1229 * 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.
1230 */
1231 nextToken?: NextToken;
1232 }
1233 export interface ListActionExecutionsOutput {
1234 /**
1235 * The details for a list of recent executions, such as action execution ID.
1236 */
1237 actionExecutionDetails?: ActionExecutionDetailList;
1238 /**
1239 * 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.
1240 */
1241 nextToken?: NextToken;
1242 }
1243 export interface ListActionTypesInput {
1244 /**
1245 * Filters the list of action types to those created by a specified entity.
1246 */
1247 actionOwnerFilter?: ActionOwner;
1248 /**
1249 * 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.
1250 */
1251 nextToken?: NextToken;
1252 }
1253 export interface ListActionTypesOutput {
1254 /**
1255 * Provides details of the action types.
1256 */
1257 actionTypes: ActionTypeList;
1258 /**
1259 * 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.
1260 */
1261 nextToken?: NextToken;
1262 }
1263 export interface ListPipelineExecutionsInput {
1264 /**
1265 * The name of the pipeline for which you want to get execution summary information.
1266 */
1267 pipelineName: PipelineName;
1268 /**
1269 * 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.
1270 */
1271 maxResults?: MaxResults;
1272 /**
1273 * 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.
1274 */
1275 nextToken?: NextToken;
1276 }
1277 export interface ListPipelineExecutionsOutput {
1278 /**
1279 * A list of executions in the history of a pipeline.
1280 */
1281 pipelineExecutionSummaries?: PipelineExecutionSummaryList;
1282 /**
1283 * 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.
1284 */
1285 nextToken?: NextToken;
1286 }
1287 export interface ListPipelinesInput {
1288 /**
1289 * 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.
1290 */
1291 nextToken?: NextToken;
1292 }
1293 export interface ListPipelinesOutput {
1294 /**
1295 * The list of pipelines.
1296 */
1297 pipelines?: PipelineList;
1298 /**
1299 * 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.
1300 */
1301 nextToken?: NextToken;
1302 }
1303 export interface ListTagsForResourceInput {
1304 /**
1305 * The Amazon Resource Name (ARN) of the resource to get tags for.
1306 */
1307 resourceArn: ResourceArn;
1308 /**
1309 * 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.
1310 */
1311 nextToken?: NextToken;
1312 /**
1313 * The maximum number of results to return in a single call.
1314 */
1315 maxResults?: MaxResults;
1316 }
1317 export interface ListTagsForResourceOutput {
1318 /**
1319 * The tags for the resource.
1320 */
1321 tags?: TagList;
1322 /**
1323 * 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.
1324 */
1325 nextToken?: NextToken;
1326 }
1327 export interface ListWebhookItem {
1328 /**
1329 * The detail returned for each webhook, such as the webhook authentication type and filter rules.
1330 */
1331 definition: WebhookDefinition;
1332 /**
1333 * 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.
1334 */
1335 url: WebhookUrl;
1336 /**
1337 * The text of the error message about the webhook.
1338 */
1339 errorMessage?: WebhookErrorMessage;
1340 /**
1341 * The number code of the error.
1342 */
1343 errorCode?: WebhookErrorCode;
1344 /**
1345 * The date and time a webhook was last successfully triggered, in timestamp format.
1346 */
1347 lastTriggered?: WebhookLastTriggered;
1348 /**
1349 * The Amazon Resource Name (ARN) of the webhook.
1350 */
1351 arn?: WebhookArn;
1352 /**
1353 * Specifies the tags applied to the webhook.
1354 */
1355 tags?: TagList;
1356 }
1357 export interface ListWebhooksInput {
1358 /**
1359 * The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
1360 */
1361 NextToken?: NextToken;
1362 /**
1363 * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
1364 */
1365 MaxResults?: MaxResults;
1366 }
1367 export interface ListWebhooksOutput {
1368 /**
1369 * The JSON detail returned for each webhook in the list output for the ListWebhooks call.
1370 */
1371 webhooks?: WebhookList;
1372 /**
1373 * 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.
1374 */
1375 NextToken?: NextToken;
1376 }
1377 export type MatchEquals = string;
1378 export type MaxBatchSize = number;
1379 export type MaxResults = number;
1380 export type MaximumArtifactCount = number;
1381 export type Message = string;
1382 export type MinimumArtifactCount = number;
1383 export type NextToken = string;
1384 export type Nonce = string;
1385 export interface OutputArtifact {
1386 /**
1387 * 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.
1388 */
1389 name: ArtifactName;
1390 }
1391 export type OutputArtifactList = OutputArtifact[];
1392 export type OutputVariablesKey = string;
1393 export type OutputVariablesMap = {[key: string]: OutputVariablesValue};
1394 export type OutputVariablesValue = string;
1395 export type Percentage = number;
1396 export type PipelineArn = string;
1397 export interface PipelineContext {
1398 /**
1399 * 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.
1400 */
1401 pipelineName?: PipelineName;
1402 /**
1403 * The stage of the pipeline.
1404 */
1405 stage?: StageContext;
1406 /**
1407 * The context of an action to a job worker in the stage of a pipeline.
1408 */
1409 action?: ActionContext;
1410 /**
1411 * The Amazon Resource Name (ARN) of the pipeline.
1412 */
1413 pipelineArn?: PipelineArn;
1414 /**
1415 * The execution ID of the pipeline.
1416 */
1417 pipelineExecutionId?: PipelineExecutionId;
1418 }
1419 export interface PipelineDeclaration {
1420 /**
1421 * The name of the action to be performed.
1422 */
1423 name: PipelineName;
1424 /**
1425 * 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.
1426 */
1427 roleArn: RoleArn;
1428 /**
1429 * Represents information about the 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.
1430 */
1431 artifactStore?: ArtifactStore;
1432 /**
1433 * 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.
1434 */
1435 artifactStores?: ArtifactStoreMap;
1436 /**
1437 * The stage in which to perform the action.
1438 */
1439 stages: PipelineStageDeclarationList;
1440 /**
1441 * 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.
1442 */
1443 version?: PipelineVersion;
1444 }
1445 export interface PipelineExecution {
1446 /**
1447 * The name of the pipeline with the specified pipeline execution.
1448 */
1449 pipelineName?: PipelineName;
1450 /**
1451 * The version number of the pipeline with the specified pipeline execution.
1452 */
1453 pipelineVersion?: PipelineVersion;
1454 /**
1455 * The ID of the pipeline execution.
1456 */
1457 pipelineExecutionId?: PipelineExecutionId;
1458 /**
1459 * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. 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. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully.
1460 */
1461 status?: PipelineExecutionStatus;
1462 /**
1463 * A list of ArtifactRevision objects included in a pipeline execution.
1464 */
1465 artifactRevisions?: ArtifactRevisionList;
1466 }
1467 export type PipelineExecutionId = string;
1468 export type PipelineExecutionStatus = "InProgress"|"Stopped"|"Stopping"|"Succeeded"|"Superseded"|"Failed"|string;
1469 export interface PipelineExecutionSummary {
1470 /**
1471 * The ID of the pipeline execution.
1472 */
1473 pipelineExecutionId?: PipelineExecutionId;
1474 /**
1475 * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. 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. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully.
1476 */
1477 status?: PipelineExecutionStatus;
1478 /**
1479 * The date and time when the pipeline execution began, in timestamp format.
1480 */
1481 startTime?: Timestamp;
1482 /**
1483 * The date and time of the last change to the pipeline execution, in timestamp format.
1484 */
1485 lastUpdateTime?: Timestamp;
1486 /**
1487 * A list of the source artifact revisions that initiated a pipeline execution.
1488 */
1489 sourceRevisions?: SourceRevisionList;
1490 /**
1491 * The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
1492 */
1493 trigger?: ExecutionTrigger;
1494 /**
1495 * The interaction that stopped a pipeline execution.
1496 */
1497 stopTrigger?: StopExecutionTrigger;
1498 }
1499 export type PipelineExecutionSummaryList = PipelineExecutionSummary[];
1500 export type PipelineList = PipelineSummary[];
1501 export interface PipelineMetadata {
1502 /**
1503 * The Amazon Resource Name (ARN) of the pipeline.
1504 */
1505 pipelineArn?: PipelineArn;
1506 /**
1507 * The date and time the pipeline was created, in timestamp format.
1508 */
1509 created?: Timestamp;
1510 /**
1511 * The date and time the pipeline was last updated, in timestamp format.
1512 */
1513 updated?: Timestamp;
1514 }
1515 export type PipelineName = string;
1516 export type PipelineStageDeclarationList = StageDeclaration[];
1517 export interface PipelineSummary {
1518 /**
1519 * The name of the pipeline.
1520 */
1521 name?: PipelineName;
1522 /**
1523 * The version number of the pipeline.
1524 */
1525 version?: PipelineVersion;
1526 /**
1527 * The date and time the pipeline was created, in timestamp format.
1528 */
1529 created?: Timestamp;
1530 /**
1531 * The date and time of the last update to the pipeline, in timestamp format.
1532 */
1533 updated?: Timestamp;
1534 }
1535 export type PipelineVersion = number;
1536 export interface PollForJobsInput {
1537 /**
1538 * Represents information about an action type.
1539 */
1540 actionTypeId: ActionTypeId;
1541 /**
1542 * The maximum number of jobs to return in a poll for jobs call.
1543 */
1544 maxBatchSize?: MaxBatchSize;
1545 /**
1546 * 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.
1547 */
1548 queryParam?: QueryParamMap;
1549 }
1550 export interface PollForJobsOutput {
1551 /**
1552 * Information about the jobs to take action on.
1553 */
1554 jobs?: JobList;
1555 }
1556 export interface PollForThirdPartyJobsInput {
1557 /**
1558 * Represents information about an action type.
1559 */
1560 actionTypeId: ActionTypeId;
1561 /**
1562 * The maximum number of jobs to return in a poll for jobs call.
1563 */
1564 maxBatchSize?: MaxBatchSize;
1565 }
1566 export interface PollForThirdPartyJobsOutput {
1567 /**
1568 * Information about the jobs to take action on.
1569 */
1570 jobs?: ThirdPartyJobList;
1571 }
1572 export interface PutActionRevisionInput {
1573 /**
1574 * The name of the pipeline that starts processing the revision to the source.
1575 */
1576 pipelineName: PipelineName;
1577 /**
1578 * The name of the stage that contains the action that acts on the revision.
1579 */
1580 stageName: StageName;
1581 /**
1582 * The name of the action that processes the revision.
1583 */
1584 actionName: ActionName;
1585 /**
1586 * Represents information about the version (or revision) of an action.
1587 */
1588 actionRevision: ActionRevision;
1589 }
1590 export interface PutActionRevisionOutput {
1591 /**
1592 * Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
1593 */
1594 newRevision?: Boolean;
1595 /**
1596 * The ID of the current workflow state of the pipeline.
1597 */
1598 pipelineExecutionId?: PipelineExecutionId;
1599 }
1600 export interface PutApprovalResultInput {
1601 /**
1602 * The name of the pipeline that contains the action.
1603 */
1604 pipelineName: PipelineName;
1605 /**
1606 * The name of the stage that contains the action.
1607 */
1608 stageName: StageName;
1609 /**
1610 * The name of the action for which approval is requested.
1611 */
1612 actionName: ActionName;
1613 /**
1614 * Represents information about the result of the approval request.
1615 */
1616 result: ApprovalResult;
1617 /**
1618 * 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.
1619 */
1620 token: ApprovalToken;
1621 }
1622 export interface PutApprovalResultOutput {
1623 /**
1624 * The timestamp showing when the approval or rejection was submitted.
1625 */
1626 approvedAt?: Timestamp;
1627 }
1628 export interface PutJobFailureResultInput {
1629 /**
1630 * The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
1631 */
1632 jobId: JobId;
1633 /**
1634 * The details about the failure of a job.
1635 */
1636 failureDetails: FailureDetails;
1637 }
1638 export interface PutJobSuccessResultInput {
1639 /**
1640 * The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
1641 */
1642 jobId: JobId;
1643 /**
1644 * The ID of the current revision of the artifact successfully worked on by the job.
1645 */
1646 currentRevision?: CurrentRevision;
1647 /**
1648 * 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.
1649 */
1650 continuationToken?: ContinuationToken;
1651 /**
1652 * The execution details of the successful job, such as the actions taken by the job worker.
1653 */
1654 executionDetails?: ExecutionDetails;
1655 /**
1656 * Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.
1657 */
1658 outputVariables?: OutputVariablesMap;
1659 }
1660 export interface PutThirdPartyJobFailureResultInput {
1661 /**
1662 * The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
1663 */
1664 jobId: ThirdPartyJobId;
1665 /**
1666 * 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.
1667 */
1668 clientToken: ClientToken;
1669 /**
1670 * Represents information about failure details.
1671 */
1672 failureDetails: FailureDetails;
1673 }
1674 export interface PutThirdPartyJobSuccessResultInput {
1675 /**
1676 * The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
1677 */
1678 jobId: ThirdPartyJobId;
1679 /**
1680 * 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.
1681 */
1682 clientToken: ClientToken;
1683 /**
1684 * Represents information about a current revision.
1685 */
1686 currentRevision?: CurrentRevision;
1687 /**
1688 * 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.
1689 */
1690 continuationToken?: ContinuationToken;
1691 /**
1692 * The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
1693 */
1694 executionDetails?: ExecutionDetails;
1695 }
1696 export interface PutWebhookInput {
1697 /**
1698 * 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.
1699 */
1700 webhook: WebhookDefinition;
1701 /**
1702 * The tags for the webhook.
1703 */
1704 tags?: TagList;
1705 }
1706 export interface PutWebhookOutput {
1707 /**
1708 * The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
1709 */
1710 webhook?: ListWebhookItem;
1711 }
1712 export type QueryParamMap = {[key: string]: ActionConfigurationQueryableValue};
1713 export interface RegisterWebhookWithThirdPartyInput {
1714 /**
1715 * The name of an existing webhook created with PutWebhook to register with a supported third party.
1716 */
1717 webhookName?: WebhookName;
1718 }
1719 export interface RegisterWebhookWithThirdPartyOutput {
1720 }
1721 export type ResolvedActionConfigurationMap = {[key: string]: String};
1722 export type ResourceArn = string;
1723 export interface RetryStageExecutionInput {
1724 /**
1725 * The name of the pipeline that contains the failed stage.
1726 */
1727 pipelineName: PipelineName;
1728 /**
1729 * The name of the failed stage to be retried.
1730 */
1731 stageName: StageName;
1732 /**
1733 * 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
1734 */
1735 pipelineExecutionId: PipelineExecutionId;
1736 /**
1737 * The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
1738 */
1739 retryMode: StageRetryMode;
1740 }
1741 export interface RetryStageExecutionOutput {
1742 /**
1743 * The ID of the current workflow execution in the failed stage.
1744 */
1745 pipelineExecutionId?: PipelineExecutionId;
1746 }
1747 export type Revision = string;
1748 export type RevisionChangeIdentifier = string;
1749 export type RevisionSummary = string;
1750 export type RoleArn = string;
1751 export interface S3ArtifactLocation {
1752 /**
1753 * The name of the S3 bucket.
1754 */
1755 bucketName: S3BucketName;
1756 /**
1757 * The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
1758 */
1759 objectKey: S3ObjectKey;
1760 }
1761 export type S3Bucket = string;
1762 export type S3BucketName = string;
1763 export type S3Key = string;
1764 export interface S3Location {
1765 /**
1766 * The Amazon S3 artifact bucket for an action's artifacts.
1767 */
1768 bucket?: S3Bucket;
1769 /**
1770 * The artifact name.
1771 */
1772 key?: S3Key;
1773 }
1774 export type S3ObjectKey = string;
1775 export type SecretAccessKey = string;
1776 export type SessionToken = string;
1777 export interface SourceRevision {
1778 /**
1779 * The name of the action that processed the revision to the source artifact.
1780 */
1781 actionName: ActionName;
1782 /**
1783 * The system-generated unique ID that identifies the revision number of the artifact.
1784 */
1785 revisionId?: Revision;
1786 /**
1787 * 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.
1788 */
1789 revisionSummary?: RevisionSummary;
1790 /**
1791 * 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.
1792 */
1793 revisionUrl?: Url;
1794 }
1795 export type SourceRevisionList = SourceRevision[];
1796 export type StageActionDeclarationList = ActionDeclaration[];
1797 export type StageBlockerDeclarationList = BlockerDeclaration[];
1798 export interface StageContext {
1799 /**
1800 * The name of the stage.
1801 */
1802 name?: StageName;
1803 }
1804 export interface StageDeclaration {
1805 /**
1806 * The name of the stage.
1807 */
1808 name: StageName;
1809 /**
1810 * Reserved for future use.
1811 */
1812 blockers?: StageBlockerDeclarationList;
1813 /**
1814 * The actions included in a stage.
1815 */
1816 actions: StageActionDeclarationList;
1817 }
1818 export interface StageExecution {
1819 /**
1820 * The ID of the pipeline execution associated with the stage.
1821 */
1822 pipelineExecutionId: PipelineExecutionId;
1823 /**
1824 * The status of the stage, or for a completed stage, the last status of the stage.
1825 */
1826 status: StageExecutionStatus;
1827 }
1828 export type StageExecutionStatus = "InProgress"|"Failed"|"Stopped"|"Stopping"|"Succeeded"|string;
1829 export type StageName = string;
1830 export type StageRetryMode = "FAILED_ACTIONS"|string;
1831 export interface StageState {
1832 /**
1833 * The name of the stage.
1834 */
1835 stageName?: StageName;
1836 /**
1837 * The state of the inbound transition, which is either enabled or disabled.
1838 */
1839 inboundTransitionState?: TransitionState;
1840 /**
1841 * The state of the stage.
1842 */
1843 actionStates?: ActionStateList;
1844 /**
1845 * Information about the latest execution in the stage, including its ID and status.
1846 */
1847 latestExecution?: StageExecution;
1848 }
1849 export type StageStateList = StageState[];
1850 export type StageTransitionType = "Inbound"|"Outbound"|string;
1851 export interface StartPipelineExecutionInput {
1852 /**
1853 * The name of the pipeline to start.
1854 */
1855 name: PipelineName;
1856 /**
1857 * The system-generated unique ID used to identify a unique execution request.
1858 */
1859 clientRequestToken?: ClientRequestToken;
1860 }
1861 export interface StartPipelineExecutionOutput {
1862 /**
1863 * The unique system-generated ID of the pipeline execution that was started.
1864 */
1865 pipelineExecutionId?: PipelineExecutionId;
1866 }
1867 export interface StopExecutionTrigger {
1868 /**
1869 * The user-specified reason the pipeline was stopped.
1870 */
1871 reason?: StopPipelineExecutionReason;
1872 }
1873 export interface StopPipelineExecutionInput {
1874 /**
1875 * The name of the pipeline to stop.
1876 */
1877 pipelineName: PipelineName;
1878 /**
1879 * The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
1880 */
1881 pipelineExecutionId: PipelineExecutionId;
1882 /**
1883 * Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions. This option can lead to failed or out-of-sequence tasks.
1884 */
1885 abandon?: Boolean;
1886 /**
1887 * Use this option to enter comments, such as the reason the pipeline was stopped.
1888 */
1889 reason?: StopPipelineExecutionReason;
1890 }
1891 export interface StopPipelineExecutionOutput {
1892 /**
1893 * The unique system-generated ID of the pipeline execution that was stopped.
1894 */
1895 pipelineExecutionId?: PipelineExecutionId;
1896 }
1897 export type StopPipelineExecutionReason = string;
1898 export type String = string;
1899 export interface Tag {
1900 /**
1901 * The tag's key.
1902 */
1903 key: TagKey;
1904 /**
1905 * The tag's value.
1906 */
1907 value: TagValue;
1908 }
1909 export type TagKey = string;
1910 export type TagKeyList = TagKey[];
1911 export type TagList = Tag[];
1912 export interface TagResourceInput {
1913 /**
1914 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
1915 */
1916 resourceArn: ResourceArn;
1917 /**
1918 * The tags you want to modify or add to the resource.
1919 */
1920 tags: TagList;
1921 }
1922 export interface TagResourceOutput {
1923 }
1924 export type TagValue = string;
1925 export interface ThirdPartyJob {
1926 /**
1927 * 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.
1928 */
1929 clientId?: ClientId;
1930 /**
1931 * The identifier used to identify the job in AWS CodePipeline.
1932 */
1933 jobId?: JobId;
1934 }
1935 export interface ThirdPartyJobData {
1936 /**
1937 * Represents information about an action type.
1938 */
1939 actionTypeId?: ActionTypeId;
1940 /**
1941 * Represents information about an action configuration.
1942 */
1943 actionConfiguration?: ActionConfiguration;
1944 /**
1945 * Represents information about a pipeline to a job worker. Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
1946 */
1947 pipelineContext?: PipelineContext;
1948 /**
1949 * 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.
1950 */
1951 inputArtifacts?: ArtifactList;
1952 /**
1953 * 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.
1954 */
1955 outputArtifacts?: ArtifactList;
1956 /**
1957 * 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 S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
1958 */
1959 artifactCredentials?: AWSSessionCredentials;
1960 /**
1961 * A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
1962 */
1963 continuationToken?: ContinuationToken;
1964 /**
1965 * 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.
1966 */
1967 encryptionKey?: EncryptionKey;
1968 }
1969 export interface ThirdPartyJobDetails {
1970 /**
1971 * The identifier used to identify the job details in AWS CodePipeline.
1972 */
1973 id?: ThirdPartyJobId;
1974 /**
1975 * The data to be returned by the third party job worker.
1976 */
1977 data?: ThirdPartyJobData;
1978 /**
1979 * 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.
1980 */
1981 nonce?: Nonce;
1982 }
1983 export type ThirdPartyJobId = string;
1984 export type ThirdPartyJobList = ThirdPartyJob[];
1985 export type Time = Date;
1986 export type Timestamp = Date;
1987 export interface TransitionState {
1988 /**
1989 * Whether the transition between stages is enabled (true) or disabled (false).
1990 */
1991 enabled?: Enabled;
1992 /**
1993 * The ID of the user who last changed the transition state.
1994 */
1995 lastChangedBy?: LastChangedBy;
1996 /**
1997 * The timestamp when the transition state was last changed.
1998 */
1999 lastChangedAt?: LastChangedAt;
2000 /**
2001 * The user-specified reason why the transition between two stages of a pipeline was disabled.
2002 */
2003 disabledReason?: DisabledReason;
2004 }
2005 export type TriggerDetail = string;
2006 export type TriggerType = "CreatePipeline"|"StartPipelineExecution"|"PollForSourceChanges"|"Webhook"|"CloudWatchEvent"|"PutActionRevision"|string;
2007 export interface UntagResourceInput {
2008 /**
2009 * The Amazon Resource Name (ARN) of the resource to remove tags from.
2010 */
2011 resourceArn: ResourceArn;
2012 /**
2013 * The list of keys for the tags to be removed from the resource.
2014 */
2015 tagKeys: TagKeyList;
2016 }
2017 export interface UntagResourceOutput {
2018 }
2019 export interface UpdatePipelineInput {
2020 /**
2021 * The name of the pipeline to be updated.
2022 */
2023 pipeline: PipelineDeclaration;
2024 }
2025 export interface UpdatePipelineOutput {
2026 /**
2027 * The structure of the updated pipeline.
2028 */
2029 pipeline?: PipelineDeclaration;
2030 }
2031 export type Url = string;
2032 export type UrlTemplate = string;
2033 export type Version = string;
2034 export type WebhookArn = string;
2035 export interface WebhookAuthConfiguration {
2036 /**
2037 * 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.
2038 */
2039 AllowedIPRange?: WebhookAuthConfigurationAllowedIPRange;
2040 /**
2041 * The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
2042 */
2043 SecretToken?: WebhookAuthConfigurationSecretToken;
2044 }
2045 export type WebhookAuthConfigurationAllowedIPRange = string;
2046 export type WebhookAuthConfigurationSecretToken = string;
2047 export type WebhookAuthenticationType = "GITHUB_HMAC"|"IP"|"UNAUTHENTICATED"|string;
2048 export interface WebhookDefinition {
2049 /**
2050 * The name of the webhook.
2051 */
2052 name: WebhookName;
2053 /**
2054 * The name of the pipeline you want to connect to the webhook.
2055 */
2056 targetPipeline: PipelineName;
2057 /**
2058 * 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.
2059 */
2060 targetAction: ActionName;
2061 /**
2062 * 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.
2063 */
2064 filters: WebhookFilters;
2065 /**
2066 * 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.
2067 */
2068 authentication: WebhookAuthenticationType;
2069 /**
2070 * 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.
2071 */
2072 authenticationConfiguration: WebhookAuthConfiguration;
2073 }
2074 export type WebhookErrorCode = string;
2075 export type WebhookErrorMessage = string;
2076 export interface WebhookFilterRule {
2077 /**
2078 * 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.
2079 */
2080 jsonPath: JsonPath;
2081 /**
2082 * 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.
2083 */
2084 matchEquals?: MatchEquals;
2085 }
2086 export type WebhookFilters = WebhookFilterRule[];
2087 export type WebhookLastTriggered = Date;
2088 export type WebhookList = ListWebhookItem[];
2089 export type WebhookName = string;
2090 export type WebhookUrl = string;
2091 /**
2092 * 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.
2093 */
2094 export type apiVersion = "2015-07-09"|"latest"|string;
2095 export interface ClientApiVersions {
2096 /**
2097 * 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.
2098 */
2099 apiVersion?: apiVersion;
2100 }
2101 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2102 /**
2103 * Contains interfaces for use with the CodePipeline client.
2104 */
2105 export import Types = CodePipeline;
2106}
2107export = CodePipeline;