UNPKG

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