UNPKG

115 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class CodeDeploy extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: CodeDeploy.Types.ClientConfiguration)
14 config: Config & CodeDeploy.Types.ClientConfiguration;
15 /**
16 * Adds tags to on-premises instances.
17 */
18 addTagsToOnPremisesInstances(params: CodeDeploy.Types.AddTagsToOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
19 /**
20 * Adds tags to on-premises instances.
21 */
22 addTagsToOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
23 /**
24 * Gets information about one or more application revisions.
25 */
26 batchGetApplicationRevisions(params: CodeDeploy.Types.BatchGetApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>;
27 /**
28 * Gets information about one or more application revisions.
29 */
30 batchGetApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>;
31 /**
32 * Gets information about one or more applications.
33 */
34 batchGetApplications(params: CodeDeploy.Types.BatchGetApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>;
35 /**
36 * Gets information about one or more applications.
37 */
38 batchGetApplications(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>;
39 /**
40 * Gets information about one or more deployment groups.
41 */
42 batchGetDeploymentGroups(params: CodeDeploy.Types.BatchGetDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>;
43 /**
44 * Gets information about one or more deployment groups.
45 */
46 batchGetDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>;
47 /**
48 * This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms.
49 */
50 batchGetDeploymentInstances(params: CodeDeploy.Types.BatchGetDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>;
51 /**
52 * This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms.
53 */
54 batchGetDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>;
55 /**
56 * Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The type of targets returned depends on the deployment's compute platform: EC2/On-premises: Information about EC2 instance targets. AWS Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets.
57 */
58 batchGetDeploymentTargets(params: CodeDeploy.Types.BatchGetDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentTargetsOutput, AWSError>;
59 /**
60 * Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The type of targets returned depends on the deployment's compute platform: EC2/On-premises: Information about EC2 instance targets. AWS Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets.
61 */
62 batchGetDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentTargetsOutput, AWSError>;
63 /**
64 * Gets information about one or more deployments.
65 */
66 batchGetDeployments(params: CodeDeploy.Types.BatchGetDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>;
67 /**
68 * Gets information about one or more deployments.
69 */
70 batchGetDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>;
71 /**
72 * Gets information about one or more on-premises instances.
73 */
74 batchGetOnPremisesInstances(params: CodeDeploy.Types.BatchGetOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>;
75 /**
76 * Gets information about one or more on-premises instances.
77 */
78 batchGetOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>;
79 /**
80 * For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
81 */
82 continueDeployment(params: CodeDeploy.Types.ContinueDeploymentInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
83 /**
84 * For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
85 */
86 continueDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
87 /**
88 * Creates an application.
89 */
90 createApplication(params: CodeDeploy.Types.CreateApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>;
91 /**
92 * Creates an application.
93 */
94 createApplication(callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>;
95 /**
96 * Deploys an application revision through the specified deployment group.
97 */
98 createDeployment(params: CodeDeploy.Types.CreateDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>;
99 /**
100 * Deploys an application revision through the specified deployment group.
101 */
102 createDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>;
103 /**
104 * Creates a deployment configuration.
105 */
106 createDeploymentConfig(params: CodeDeploy.Types.CreateDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>;
107 /**
108 * Creates a deployment configuration.
109 */
110 createDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>;
111 /**
112 * Creates a deployment group to which application revisions are deployed.
113 */
114 createDeploymentGroup(params: CodeDeploy.Types.CreateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>;
115 /**
116 * Creates a deployment group to which application revisions are deployed.
117 */
118 createDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>;
119 /**
120 * Deletes an application.
121 */
122 deleteApplication(params: CodeDeploy.Types.DeleteApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
123 /**
124 * Deletes an application.
125 */
126 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
127 /**
128 * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
129 */
130 deleteDeploymentConfig(params: CodeDeploy.Types.DeleteDeploymentConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
131 /**
132 * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
133 */
134 deleteDeploymentConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
135 /**
136 * Deletes a deployment group.
137 */
138 deleteDeploymentGroup(params: CodeDeploy.Types.DeleteDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>;
139 /**
140 * Deletes a deployment group.
141 */
142 deleteDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>;
143 /**
144 * Deletes a GitHub account connection.
145 */
146 deleteGitHubAccountToken(params: CodeDeploy.Types.DeleteGitHubAccountTokenInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request<CodeDeploy.Types.DeleteGitHubAccountTokenOutput, AWSError>;
147 /**
148 * Deletes a GitHub account connection.
149 */
150 deleteGitHubAccountToken(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request<CodeDeploy.Types.DeleteGitHubAccountTokenOutput, AWSError>;
151 /**
152 * Deregisters an on-premises instance.
153 */
154 deregisterOnPremisesInstance(params: CodeDeploy.Types.DeregisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
155 /**
156 * Deregisters an on-premises instance.
157 */
158 deregisterOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
159 /**
160 * Gets information about an application.
161 */
162 getApplication(params: CodeDeploy.Types.GetApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>;
163 /**
164 * Gets information about an application.
165 */
166 getApplication(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>;
167 /**
168 * Gets information about an application revision.
169 */
170 getApplicationRevision(params: CodeDeploy.Types.GetApplicationRevisionInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>;
171 /**
172 * Gets information about an application revision.
173 */
174 getApplicationRevision(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>;
175 /**
176 * Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.
177 */
178 getDeployment(params: CodeDeploy.Types.GetDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
179 /**
180 * Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.
181 */
182 getDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
183 /**
184 * Gets information about a deployment configuration.
185 */
186 getDeploymentConfig(params: CodeDeploy.Types.GetDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>;
187 /**
188 * Gets information about a deployment configuration.
189 */
190 getDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>;
191 /**
192 * Gets information about a deployment group.
193 */
194 getDeploymentGroup(params: CodeDeploy.Types.GetDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>;
195 /**
196 * Gets information about a deployment group.
197 */
198 getDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>;
199 /**
200 * Gets information about an instance as part of a deployment.
201 */
202 getDeploymentInstance(params: CodeDeploy.Types.GetDeploymentInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>;
203 /**
204 * Gets information about an instance as part of a deployment.
205 */
206 getDeploymentInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>;
207 /**
208 * Returns information about a deployment target.
209 */
210 getDeploymentTarget(params: CodeDeploy.Types.GetDeploymentTargetInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request<CodeDeploy.Types.GetDeploymentTargetOutput, AWSError>;
211 /**
212 * Returns information about a deployment target.
213 */
214 getDeploymentTarget(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request<CodeDeploy.Types.GetDeploymentTargetOutput, AWSError>;
215 /**
216 * Gets information about an on-premises instance.
217 */
218 getOnPremisesInstance(params: CodeDeploy.Types.GetOnPremisesInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>;
219 /**
220 * Gets information about an on-premises instance.
221 */
222 getOnPremisesInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>;
223 /**
224 * Lists information about revisions for an application.
225 */
226 listApplicationRevisions(params: CodeDeploy.Types.ListApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>;
227 /**
228 * Lists information about revisions for an application.
229 */
230 listApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>;
231 /**
232 * Lists the applications registered with the IAM user or AWS account.
233 */
234 listApplications(params: CodeDeploy.Types.ListApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>;
235 /**
236 * Lists the applications registered with the IAM user or AWS account.
237 */
238 listApplications(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>;
239 /**
240 * Lists the deployment configurations with the IAM user or AWS account.
241 */
242 listDeploymentConfigs(params: CodeDeploy.Types.ListDeploymentConfigsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>;
243 /**
244 * Lists the deployment configurations with the IAM user or AWS account.
245 */
246 listDeploymentConfigs(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>;
247 /**
248 * Lists the deployment groups for an application registered with the IAM user or AWS account.
249 */
250 listDeploymentGroups(params: CodeDeploy.Types.ListDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>;
251 /**
252 * Lists the deployment groups for an application registered with the IAM user or AWS account.
253 */
254 listDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>;
255 /**
256 * The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. Lists the instance for a deployment associated with the IAM user or AWS account.
257 */
258 listDeploymentInstances(params: CodeDeploy.Types.ListDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>;
259 /**
260 * The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. Lists the instance for a deployment associated with the IAM user or AWS account.
261 */
262 listDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>;
263 /**
264 * Returns an array of target IDs that are associated a deployment.
265 */
266 listDeploymentTargets(params: CodeDeploy.Types.ListDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.ListDeploymentTargetsOutput, AWSError>;
267 /**
268 * Returns an array of target IDs that are associated a deployment.
269 */
270 listDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.ListDeploymentTargetsOutput, AWSError>;
271 /**
272 * Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.
273 */
274 listDeployments(params: CodeDeploy.Types.ListDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>;
275 /**
276 * Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.
277 */
278 listDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>;
279 /**
280 * Lists the names of stored connections to GitHub accounts.
281 */
282 listGitHubAccountTokenNames(params: CodeDeploy.Types.ListGitHubAccountTokenNamesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request<CodeDeploy.Types.ListGitHubAccountTokenNamesOutput, AWSError>;
283 /**
284 * Lists the names of stored connections to GitHub accounts.
285 */
286 listGitHubAccountTokenNames(callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request<CodeDeploy.Types.ListGitHubAccountTokenNamesOutput, AWSError>;
287 /**
288 * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
289 */
290 listOnPremisesInstances(params: CodeDeploy.Types.ListOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>;
291 /**
292 * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
293 */
294 listOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>;
295 /**
296 * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
297 */
298 putLifecycleEventHookExecutionStatus(params: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusInput, callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
299 /**
300 * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
301 */
302 putLifecycleEventHookExecutionStatus(callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
303 /**
304 * Registers with AWS CodeDeploy a revision for the specified application.
305 */
306 registerApplicationRevision(params: CodeDeploy.Types.RegisterApplicationRevisionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
307 /**
308 * Registers with AWS CodeDeploy a revision for the specified application.
309 */
310 registerApplicationRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
311 /**
312 * Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
313 */
314 registerOnPremisesInstance(params: CodeDeploy.Types.RegisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
315 /**
316 * Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
317 */
318 registerOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
319 /**
320 * Removes one or more tags from one or more on-premises instances.
321 */
322 removeTagsFromOnPremisesInstances(params: CodeDeploy.Types.RemoveTagsFromOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
323 /**
324 * Removes one or more tags from one or more on-premises instances.
325 */
326 removeTagsFromOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
327 /**
328 * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
329 */
330 skipWaitTimeForInstanceTermination(params: CodeDeploy.Types.SkipWaitTimeForInstanceTerminationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
331 /**
332 * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
333 */
334 skipWaitTimeForInstanceTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
335 /**
336 * Attempts to stop an ongoing deployment.
337 */
338 stopDeployment(params: CodeDeploy.Types.StopDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
339 /**
340 * Attempts to stop an ongoing deployment.
341 */
342 stopDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
343 /**
344 * Changes the name of an application.
345 */
346 updateApplication(params: CodeDeploy.Types.UpdateApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
347 /**
348 * Changes the name of an application.
349 */
350 updateApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
351 /**
352 * Changes information about a deployment group.
353 */
354 updateDeploymentGroup(params: CodeDeploy.Types.UpdateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
355 /**
356 * Changes information about a deployment group.
357 */
358 updateDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
359 /**
360 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
361 */
362 waitFor(state: "deploymentSuccessful", params: CodeDeploy.Types.GetDeploymentInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
363 /**
364 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
365 */
366 waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
367}
368declare namespace CodeDeploy {
369 export interface AddTagsToOnPremisesInstancesInput {
370 /**
371 * The tag key-value pairs to add to the on-premises instances. Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
372 */
373 tags: TagList;
374 /**
375 * The names of the on-premises instances to which to add tags.
376 */
377 instanceNames: InstanceNameList;
378 }
379 export type AdditionalDeploymentStatusInfo = string;
380 export interface Alarm {
381 /**
382 * The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
383 */
384 name?: AlarmName;
385 }
386 export interface AlarmConfiguration {
387 /**
388 * Indicates whether the alarm configuration is enabled.
389 */
390 enabled?: Boolean;
391 /**
392 * Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false. true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
393 */
394 ignorePollAlarmFailure?: Boolean;
395 /**
396 * A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.
397 */
398 alarms?: AlarmList;
399 }
400 export type AlarmList = Alarm[];
401 export type AlarmName = string;
402 export interface AppSpecContent {
403 /**
404 * The YAML-formatted or JSON-formatted revision string. For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.
405 */
406 content?: RawStringContent;
407 /**
408 * The SHA256 hash value of the revision content.
409 */
410 sha256?: RawStringSha256;
411 }
412 export type ApplicationId = string;
413 export interface ApplicationInfo {
414 /**
415 * The application ID.
416 */
417 applicationId?: ApplicationId;
418 /**
419 * The application name.
420 */
421 applicationName?: ApplicationName;
422 /**
423 * The time at which the application was created.
424 */
425 createTime?: Timestamp;
426 /**
427 * True if the user has authenticated with GitHub for the specified application. Otherwise, false.
428 */
429 linkedToGitHub?: Boolean;
430 /**
431 * The name for a connection to a GitHub account.
432 */
433 gitHubAccountName?: GitHubAccountTokenName;
434 /**
435 * The destination platform type for deployment of the application (Lambda or Server).
436 */
437 computePlatform?: ComputePlatform;
438 }
439 export type ApplicationName = string;
440 export type ApplicationRevisionSortBy = "registerTime"|"firstUsedTime"|"lastUsedTime"|string;
441 export type ApplicationsInfoList = ApplicationInfo[];
442 export type ApplicationsList = ApplicationName[];
443 export interface AutoRollbackConfiguration {
444 /**
445 * Indicates whether a defined automatic rollback configuration is currently enabled.
446 */
447 enabled?: Boolean;
448 /**
449 * The event type or types that trigger a rollback.
450 */
451 events?: AutoRollbackEventsList;
452 }
453 export type AutoRollbackEvent = "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"|string;
454 export type AutoRollbackEventsList = AutoRollbackEvent[];
455 export interface AutoScalingGroup {
456 /**
457 * The Auto Scaling group name.
458 */
459 name?: AutoScalingGroupName;
460 /**
461 * An Auto Scaling lifecycle event hook name.
462 */
463 hook?: AutoScalingGroupHook;
464 }
465 export type AutoScalingGroupHook = string;
466 export type AutoScalingGroupList = AutoScalingGroup[];
467 export type AutoScalingGroupName = string;
468 export type AutoScalingGroupNameList = AutoScalingGroupName[];
469 export interface BatchGetApplicationRevisionsInput {
470 /**
471 * The name of an AWS CodeDeploy application about which to get revision information.
472 */
473 applicationName: ApplicationName;
474 /**
475 * Information to get about the application revisions, including type and location.
476 */
477 revisions: RevisionLocationList;
478 }
479 export interface BatchGetApplicationRevisionsOutput {
480 /**
481 * The name of the application that corresponds to the revisions.
482 */
483 applicationName?: ApplicationName;
484 /**
485 * Information about errors that might have occurred during the API call.
486 */
487 errorMessage?: ErrorMessage;
488 /**
489 * Additional information about the revisions, including the type and location.
490 */
491 revisions?: RevisionInfoList;
492 }
493 export interface BatchGetApplicationsInput {
494 /**
495 * A list of application names separated by spaces.
496 */
497 applicationNames: ApplicationsList;
498 }
499 export interface BatchGetApplicationsOutput {
500 /**
501 * Information about the applications.
502 */
503 applicationsInfo?: ApplicationsInfoList;
504 }
505 export interface BatchGetDeploymentGroupsInput {
506 /**
507 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
508 */
509 applicationName: ApplicationName;
510 /**
511 * The names of the deployment groups.
512 */
513 deploymentGroupNames: DeploymentGroupsList;
514 }
515 export interface BatchGetDeploymentGroupsOutput {
516 /**
517 * Information about the deployment groups.
518 */
519 deploymentGroupsInfo?: DeploymentGroupInfoList;
520 /**
521 * Information about errors that might have occurred during the API call.
522 */
523 errorMessage?: ErrorMessage;
524 }
525 export interface BatchGetDeploymentInstancesInput {
526 /**
527 * The unique ID of a deployment.
528 */
529 deploymentId: DeploymentId;
530 /**
531 * The unique IDs of instances used in the deployment.
532 */
533 instanceIds: InstancesList;
534 }
535 export interface BatchGetDeploymentInstancesOutput {
536 /**
537 * Information about the instance.
538 */
539 instancesSummary?: InstanceSummaryList;
540 /**
541 * Information about errors that might have occurred during the API call.
542 */
543 errorMessage?: ErrorMessage;
544 }
545 export interface BatchGetDeploymentTargetsInput {
546 /**
547 * The unique ID of a deployment.
548 */
549 deploymentId?: DeploymentId;
550 /**
551 * The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget. For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget. For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format &lt;clustername&gt;:&lt;servicename&gt;. Their target type is ecsTarget.
552 */
553 targetIds?: TargetIdList;
554 }
555 export interface BatchGetDeploymentTargetsOutput {
556 /**
557 * A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. EC2/On-premises: Each target object is an EC2 or on-premises instance. AWS Lambda: The target object is a specific version of an AWS Lambda function. Amazon ECS: The target object is an Amazon ECS service.
558 */
559 deploymentTargets?: DeploymentTargetList;
560 }
561 export interface BatchGetDeploymentsInput {
562 /**
563 * A list of deployment IDs, separated by spaces.
564 */
565 deploymentIds: DeploymentsList;
566 }
567 export interface BatchGetDeploymentsOutput {
568 /**
569 * Information about the deployments.
570 */
571 deploymentsInfo?: DeploymentsInfoList;
572 }
573 export interface BatchGetOnPremisesInstancesInput {
574 /**
575 * The names of the on-premises instances about which to get information.
576 */
577 instanceNames: InstanceNameList;
578 }
579 export interface BatchGetOnPremisesInstancesOutput {
580 /**
581 * Information about the on-premises instances.
582 */
583 instanceInfos?: InstanceInfoList;
584 }
585 export interface BlueGreenDeploymentConfiguration {
586 /**
587 * Information about whether to terminate instances in the original fleet during a blue/green deployment.
588 */
589 terminateBlueInstancesOnDeploymentSuccess?: BlueInstanceTerminationOption;
590 /**
591 * Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
592 */
593 deploymentReadyOption?: DeploymentReadyOption;
594 /**
595 * Information about how instances are provisioned for a replacement environment in a blue/green deployment.
596 */
597 greenFleetProvisioningOption?: GreenFleetProvisioningOption;
598 }
599 export interface BlueInstanceTerminationOption {
600 /**
601 * The action to take on instances in the original environment after a successful blue/green deployment. TERMINATE: Instances are terminated after a specified wait time. KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.
602 */
603 action?: InstanceAction;
604 /**
605 * The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. The maximum setting is 2880 minutes (2 days).
606 */
607 terminationWaitTimeInMinutes?: Duration;
608 }
609 export type Boolean = boolean;
610 export type BundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON"|string;
611 export type CommitId = string;
612 export type ComputePlatform = "Server"|"Lambda"|"ECS"|string;
613 export interface ContinueDeploymentInput {
614 /**
615 * The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
616 */
617 deploymentId?: DeploymentId;
618 /**
619 * The status of the deployment's waiting period. READY_WAIT indicates the deployment is ready to start shifting traffic. TERMINATION_WAIT indicates the traffic is shifted, but the original target is not terminated.
620 */
621 deploymentWaitType?: DeploymentWaitType;
622 }
623 export interface CreateApplicationInput {
624 /**
625 * The name of the application. This name must be unique with the applicable IAM user or AWS account.
626 */
627 applicationName: ApplicationName;
628 /**
629 * The destination platform type for the deployment (Lambda or Server).
630 */
631 computePlatform?: ComputePlatform;
632 }
633 export interface CreateApplicationOutput {
634 /**
635 * A unique application ID.
636 */
637 applicationId?: ApplicationId;
638 }
639 export interface CreateDeploymentConfigInput {
640 /**
641 * The name of the deployment configuration to create.
642 */
643 deploymentConfigName: DeploymentConfigName;
644 /**
645 * The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. The type parameter takes either of the following values: HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value. FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances. The value parameter takes an integer. For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
646 */
647 minimumHealthyHosts?: MinimumHealthyHosts;
648 /**
649 * The configuration that specifies how the deployment traffic is routed.
650 */
651 trafficRoutingConfig?: TrafficRoutingConfig;
652 /**
653 * The destination platform type for the deployment (Lambda or Server&gt;).
654 */
655 computePlatform?: ComputePlatform;
656 }
657 export interface CreateDeploymentConfigOutput {
658 /**
659 * A unique deployment configuration ID.
660 */
661 deploymentConfigId?: DeploymentConfigId;
662 }
663 export interface CreateDeploymentGroupInput {
664 /**
665 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
666 */
667 applicationName: ApplicationName;
668 /**
669 * The name of a new deployment group for the specified application.
670 */
671 deploymentGroupName: DeploymentGroupName;
672 /**
673 * If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group. For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide.
674 */
675 deploymentConfigName?: DeploymentConfigName;
676 /**
677 * The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
678 */
679 ec2TagFilters?: EC2TagFilterList;
680 /**
681 * The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.
682 */
683 onPremisesInstanceTagFilters?: TagFilterList;
684 /**
685 * A list of associated Amazon EC2 Auto Scaling groups.
686 */
687 autoScalingGroups?: AutoScalingGroupNameList;
688 /**
689 * A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
690 */
691 serviceRoleArn: Role;
692 /**
693 * Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.
694 */
695 triggerConfigurations?: TriggerConfigList;
696 /**
697 * Information to add about Amazon CloudWatch alarms when the deployment group is created.
698 */
699 alarmConfiguration?: AlarmConfiguration;
700 /**
701 * Configuration information for an automatic rollback that is added when a deployment group is created.
702 */
703 autoRollbackConfiguration?: AutoRollbackConfiguration;
704 /**
705 * Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
706 */
707 deploymentStyle?: DeploymentStyle;
708 /**
709 * Information about blue/green deployment options for a deployment group.
710 */
711 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
712 /**
713 * Information about the load balancer used in a deployment.
714 */
715 loadBalancerInfo?: LoadBalancerInfo;
716 /**
717 * Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
718 */
719 ec2TagSet?: EC2TagSet;
720 /**
721 * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format &lt;clustername&gt;:&lt;servicename&gt;.
722 */
723 ecsServices?: ECSServiceList;
724 /**
725 * Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
726 */
727 onPremisesTagSet?: OnPremisesTagSet;
728 }
729 export interface CreateDeploymentGroupOutput {
730 /**
731 * A unique deployment group ID.
732 */
733 deploymentGroupId?: DeploymentGroupId;
734 }
735 export interface CreateDeploymentInput {
736 /**
737 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
738 */
739 applicationName: ApplicationName;
740 /**
741 * The name of the deployment group.
742 */
743 deploymentGroupName?: DeploymentGroupName;
744 /**
745 * The type and location of the revision to deploy.
746 */
747 revision?: RevisionLocation;
748 /**
749 * The name of a deployment configuration associated with the IAM user or AWS account. If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
750 */
751 deploymentConfigName?: DeploymentConfigName;
752 /**
753 * A comment about the deployment.
754 */
755 description?: Description;
756 /**
757 * If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
758 */
759 ignoreApplicationStopFailures?: Boolean;
760 /**
761 * Information about the instances that belong to the replacement environment in a blue/green deployment.
762 */
763 targetInstances?: TargetInstances;
764 /**
765 * Configuration information for an automatic rollback that is added when a deployment is created.
766 */
767 autoRollbackConfiguration?: AutoRollbackConfiguration;
768 /**
769 * Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
770 */
771 updateOutdatedInstancesOnly?: Boolean;
772 /**
773 * Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. The fileExistsBehavior parameter takes any of the following values: DISALLOW: The deployment fails. This is also the default behavior if no option is specified. OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance. RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
774 */
775 fileExistsBehavior?: FileExistsBehavior;
776 }
777 export interface CreateDeploymentOutput {
778 /**
779 * The unique ID of a deployment.
780 */
781 deploymentId?: DeploymentId;
782 }
783 export interface DeleteApplicationInput {
784 /**
785 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
786 */
787 applicationName: ApplicationName;
788 }
789 export interface DeleteDeploymentConfigInput {
790 /**
791 * The name of a deployment configuration associated with the IAM user or AWS account.
792 */
793 deploymentConfigName: DeploymentConfigName;
794 }
795 export interface DeleteDeploymentGroupInput {
796 /**
797 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
798 */
799 applicationName: ApplicationName;
800 /**
801 * The name of a deployment group for the specified application.
802 */
803 deploymentGroupName: DeploymentGroupName;
804 }
805 export interface DeleteDeploymentGroupOutput {
806 /**
807 * If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
808 */
809 hooksNotCleanedUp?: AutoScalingGroupList;
810 }
811 export interface DeleteGitHubAccountTokenInput {
812 /**
813 * The name of the GitHub account connection to delete.
814 */
815 tokenName?: GitHubAccountTokenName;
816 }
817 export interface DeleteGitHubAccountTokenOutput {
818 /**
819 * The name of the GitHub account connection that was deleted.
820 */
821 tokenName?: GitHubAccountTokenName;
822 }
823 export type DeploymentConfigId = string;
824 export interface DeploymentConfigInfo {
825 /**
826 * The deployment configuration ID.
827 */
828 deploymentConfigId?: DeploymentConfigId;
829 /**
830 * The deployment configuration name.
831 */
832 deploymentConfigName?: DeploymentConfigName;
833 /**
834 * Information about the number or percentage of minimum healthy instance.
835 */
836 minimumHealthyHosts?: MinimumHealthyHosts;
837 /**
838 * The time at which the deployment configuration was created.
839 */
840 createTime?: Timestamp;
841 /**
842 * The destination platform type for the deployment (Lambda or Server).
843 */
844 computePlatform?: ComputePlatform;
845 /**
846 * The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute platform can specify this.
847 */
848 trafficRoutingConfig?: TrafficRoutingConfig;
849 }
850 export type DeploymentConfigName = string;
851 export type DeploymentConfigsList = DeploymentConfigName[];
852 export type DeploymentCreator = "user"|"autoscaling"|"codeDeployRollback"|string;
853 export type DeploymentGroupId = string;
854 export interface DeploymentGroupInfo {
855 /**
856 * The application name.
857 */
858 applicationName?: ApplicationName;
859 /**
860 * The deployment group ID.
861 */
862 deploymentGroupId?: DeploymentGroupId;
863 /**
864 * The deployment group name.
865 */
866 deploymentGroupName?: DeploymentGroupName;
867 /**
868 * The deployment configuration name.
869 */
870 deploymentConfigName?: DeploymentConfigName;
871 /**
872 * The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
873 */
874 ec2TagFilters?: EC2TagFilterList;
875 /**
876 * The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
877 */
878 onPremisesInstanceTagFilters?: TagFilterList;
879 /**
880 * A list of associated Auto Scaling groups.
881 */
882 autoScalingGroups?: AutoScalingGroupList;
883 /**
884 * A service role ARN.
885 */
886 serviceRoleArn?: Role;
887 /**
888 * Information about the deployment group's target revision, including type and location.
889 */
890 targetRevision?: RevisionLocation;
891 /**
892 * Information about triggers associated with the deployment group.
893 */
894 triggerConfigurations?: TriggerConfigList;
895 /**
896 * A list of alarms associated with the deployment group.
897 */
898 alarmConfiguration?: AlarmConfiguration;
899 /**
900 * Information about the automatic rollback configuration associated with the deployment group.
901 */
902 autoRollbackConfiguration?: AutoRollbackConfiguration;
903 /**
904 * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
905 */
906 deploymentStyle?: DeploymentStyle;
907 /**
908 * Information about blue/green deployment options for a deployment group.
909 */
910 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
911 /**
912 * Information about the load balancer to use in a deployment.
913 */
914 loadBalancerInfo?: LoadBalancerInfo;
915 /**
916 * Information about the most recent successful deployment to the deployment group.
917 */
918 lastSuccessfulDeployment?: LastDeploymentInfo;
919 /**
920 * Information about the most recent attempted deployment to the deployment group.
921 */
922 lastAttemptedDeployment?: LastDeploymentInfo;
923 /**
924 * Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
925 */
926 ec2TagSet?: EC2TagSet;
927 /**
928 * Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
929 */
930 onPremisesTagSet?: OnPremisesTagSet;
931 /**
932 * The destination platform type for the deployment group (Lambda or Server).
933 */
934 computePlatform?: ComputePlatform;
935 /**
936 * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format &lt;clustername&gt;:&lt;servicename&gt;.
937 */
938 ecsServices?: ECSServiceList;
939 }
940 export type DeploymentGroupInfoList = DeploymentGroupInfo[];
941 export type DeploymentGroupName = string;
942 export type DeploymentGroupsList = DeploymentGroupName[];
943 export type DeploymentId = string;
944 export interface DeploymentInfo {
945 /**
946 * The application name.
947 */
948 applicationName?: ApplicationName;
949 /**
950 * The deployment group name.
951 */
952 deploymentGroupName?: DeploymentGroupName;
953 /**
954 * The deployment configuration name.
955 */
956 deploymentConfigName?: DeploymentConfigName;
957 /**
958 * The unique ID of a deployment.
959 */
960 deploymentId?: DeploymentId;
961 /**
962 * Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
963 */
964 previousRevision?: RevisionLocation;
965 /**
966 * Information about the location of stored application artifacts and the service from which to retrieve them.
967 */
968 revision?: RevisionLocation;
969 /**
970 * The current state of the deployment as a whole.
971 */
972 status?: DeploymentStatus;
973 /**
974 * Information about any error associated with this deployment.
975 */
976 errorInformation?: ErrorInformation;
977 /**
978 * A timestamp that indicates when the deployment was created.
979 */
980 createTime?: Timestamp;
981 /**
982 * A timestamp that indicates when the deployment was deployed to the deployment group. In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.
983 */
984 startTime?: Timestamp;
985 /**
986 * A timestamp that indicates when the deployment was complete.
987 */
988 completeTime?: Timestamp;
989 /**
990 * A summary of the deployment status of the instances in the deployment.
991 */
992 deploymentOverview?: DeploymentOverview;
993 /**
994 * A comment about the deployment.
995 */
996 description?: Description;
997 /**
998 * The means by which the deployment was created: user: A user created the deployment. autoscaling: Amazon EC2 Auto Scaling created the deployment. codeDeployRollback: A rollback process created the deployment.
999 */
1000 creator?: DeploymentCreator;
1001 /**
1002 * If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
1003 */
1004 ignoreApplicationStopFailures?: Boolean;
1005 /**
1006 * Information about the automatic rollback configuration associated with the deployment.
1007 */
1008 autoRollbackConfiguration?: AutoRollbackConfiguration;
1009 /**
1010 * Indicates whether only instances that are not running the latest application revision are to be deployed to.
1011 */
1012 updateOutdatedInstancesOnly?: Boolean;
1013 /**
1014 * Information about a deployment rollback.
1015 */
1016 rollbackInfo?: RollbackInfo;
1017 /**
1018 * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
1019 */
1020 deploymentStyle?: DeploymentStyle;
1021 /**
1022 * Information about the instances that belong to the replacement environment in a blue/green deployment.
1023 */
1024 targetInstances?: TargetInstances;
1025 /**
1026 * Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.
1027 */
1028 instanceTerminationWaitTimeStarted?: Boolean;
1029 /**
1030 * Information about blue/green deployment options for this deployment.
1031 */
1032 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
1033 /**
1034 * Information about the load balancer used in the deployment.
1035 */
1036 loadBalancerInfo?: LoadBalancerInfo;
1037 /**
1038 * Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
1039 */
1040 additionalDeploymentStatusInfo?: AdditionalDeploymentStatusInfo;
1041 /**
1042 * Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. DISALLOW: The deployment fails. This is also the default behavior if no option is specified. OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance. RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
1043 */
1044 fileExistsBehavior?: FileExistsBehavior;
1045 /**
1046 * Messages that contain information about the status of a deployment.
1047 */
1048 deploymentStatusMessages?: DeploymentStatusMessageList;
1049 /**
1050 * The destination platform type for the deployment (Lambda or Server).
1051 */
1052 computePlatform?: ComputePlatform;
1053 }
1054 export type DeploymentOption = "WITH_TRAFFIC_CONTROL"|"WITHOUT_TRAFFIC_CONTROL"|string;
1055 export interface DeploymentOverview {
1056 /**
1057 * The number of instances in the deployment in a pending state.
1058 */
1059 Pending?: InstanceCount;
1060 /**
1061 * The number of instances in which the deployment is in progress.
1062 */
1063 InProgress?: InstanceCount;
1064 /**
1065 * The number of instances in the deployment to which revisions have been successfully deployed.
1066 */
1067 Succeeded?: InstanceCount;
1068 /**
1069 * The number of instances in the deployment in a failed state.
1070 */
1071 Failed?: InstanceCount;
1072 /**
1073 * The number of instances in the deployment in a skipped state.
1074 */
1075 Skipped?: InstanceCount;
1076 /**
1077 * The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
1078 */
1079 Ready?: InstanceCount;
1080 }
1081 export type DeploymentReadyAction = "CONTINUE_DEPLOYMENT"|"STOP_DEPLOYMENT"|string;
1082 export interface DeploymentReadyOption {
1083 /**
1084 * Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment. CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment. STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
1085 */
1086 actionOnTimeout?: DeploymentReadyAction;
1087 /**
1088 * The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout
1089 */
1090 waitTimeInMinutes?: Duration;
1091 }
1092 export type DeploymentStatus = "Created"|"Queued"|"InProgress"|"Succeeded"|"Failed"|"Stopped"|"Ready"|string;
1093 export type DeploymentStatusList = DeploymentStatus[];
1094 export type DeploymentStatusMessageList = ErrorMessage[];
1095 export interface DeploymentStyle {
1096 /**
1097 * Indicates whether to run an in-place deployment or a blue/green deployment.
1098 */
1099 deploymentType?: DeploymentType;
1100 /**
1101 * Indicates whether to route deployment traffic behind a load balancer.
1102 */
1103 deploymentOption?: DeploymentOption;
1104 }
1105 export interface DeploymentTarget {
1106 /**
1107 * The deployment type that is specific to the deployment's compute platform.
1108 */
1109 deploymentTargetType?: DeploymentTargetType;
1110 /**
1111 * Information about the target for a deployment that uses the EC2/On-premises compute platform.
1112 */
1113 instanceTarget?: InstanceTarget;
1114 /**
1115 * Information about the target for a deployment that uses the AWS Lambda compute platform.
1116 */
1117 lambdaTarget?: LambdaTarget;
1118 /**
1119 * Information about the target for a deployment that uses the Amazon ECS compute platform.
1120 */
1121 ecsTarget?: ECSTarget;
1122 }
1123 export type DeploymentTargetList = DeploymentTarget[];
1124 export type DeploymentTargetType = "InstanceTarget"|"LambdaTarget"|"ECSTarget"|string;
1125 export type DeploymentType = "IN_PLACE"|"BLUE_GREEN"|string;
1126 export type DeploymentWaitType = "READY_WAIT"|"TERMINATION_WAIT"|string;
1127 export type DeploymentsInfoList = DeploymentInfo[];
1128 export type DeploymentsList = DeploymentId[];
1129 export interface DeregisterOnPremisesInstanceInput {
1130 /**
1131 * The name of the on-premises instance to deregister.
1132 */
1133 instanceName: InstanceName;
1134 }
1135 export type Description = string;
1136 export interface Diagnostics {
1137 /**
1138 * The associated error code: Success: The specified script ran. ScriptMissing: The specified script was not found in the specified location. ScriptNotExecutable: The specified script is not a recognized executable file type. ScriptTimedOut: The specified script did not finish running in the specified time period. ScriptFailed: The specified script failed to run as expected. UnknownError: The specified script did not run for an unknown reason.
1139 */
1140 errorCode?: LifecycleErrorCode;
1141 /**
1142 * The name of the script.
1143 */
1144 scriptName?: ScriptName;
1145 /**
1146 * The message associated with the error.
1147 */
1148 message?: LifecycleMessage;
1149 /**
1150 * The last portion of the diagnostic log. If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.
1151 */
1152 logTail?: LogTail;
1153 }
1154 export type Duration = number;
1155 export interface EC2TagFilter {
1156 /**
1157 * The tag filter key.
1158 */
1159 Key?: Key;
1160 /**
1161 * The tag filter value.
1162 */
1163 Value?: Value;
1164 /**
1165 * The tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value.
1166 */
1167 Type?: EC2TagFilterType;
1168 }
1169 export type EC2TagFilterList = EC2TagFilter[];
1170 export type EC2TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string;
1171 export interface EC2TagSet {
1172 /**
1173 * A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
1174 */
1175 ec2TagSetList?: EC2TagSetList;
1176 }
1177 export type EC2TagSetList = EC2TagFilterList[];
1178 export type ECSClusterName = string;
1179 export interface ECSService {
1180 /**
1181 * The name of the target Amazon ECS service.
1182 */
1183 serviceName?: ECSServiceName;
1184 /**
1185 * The name of the cluster that the Amazon ECS service is associated with.
1186 */
1187 clusterName?: ECSClusterName;
1188 }
1189 export type ECSServiceList = ECSService[];
1190 export type ECSServiceName = string;
1191 export interface ECSTarget {
1192 /**
1193 * The unique ID of a deployment.
1194 */
1195 deploymentId?: DeploymentId;
1196 /**
1197 * The unique ID of a deployment target that has a type of ecsTarget.
1198 */
1199 targetId?: TargetId;
1200 /**
1201 * The ARN of the target.
1202 */
1203 targetArn?: TargetArn;
1204 /**
1205 * The date and time when the target Amazon ECS application was updated by a deployment.
1206 */
1207 lastUpdatedAt?: Time;
1208 /**
1209 * The lifecycle events of the deployment to this target Amazon ECS application.
1210 */
1211 lifecycleEvents?: LifecycleEventList;
1212 /**
1213 * The status an Amazon ECS deployment's target ECS application.
1214 */
1215 status?: TargetStatus;
1216 /**
1217 * The ECSTaskSet objects associated with the ECS target.
1218 */
1219 taskSetsInfo?: ECSTaskSetList;
1220 }
1221 export interface ECSTaskSet {
1222 /**
1223 * A unique ID of an ECSTaskSet.
1224 */
1225 identifer?: ECSTaskSetIdentifier;
1226 /**
1227 * The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.
1228 */
1229 desiredCount?: ECSTaskSetCount;
1230 /**
1231 * The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
1232 */
1233 pendingCount?: ECSTaskSetCount;
1234 /**
1235 * The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.
1236 */
1237 runningCount?: ECSTaskSetCount;
1238 /**
1239 * The status of the task set. There are three valid task set statuses: PRIMARY: Indicates the task set is serving production traffic. ACTIVE: Indicates the task set is not serving production traffic. DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
1240 */
1241 status?: ECSTaskSetStatus;
1242 /**
1243 * The percentage of traffic served by this task set.
1244 */
1245 trafficWeight?: TrafficWeight;
1246 /**
1247 * The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.
1248 */
1249 targetGroup?: TargetGroupInfo;
1250 /**
1251 * A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
1252 */
1253 taskSetLabel?: TargetLabel;
1254 }
1255 export type ECSTaskSetCount = number;
1256 export type ECSTaskSetIdentifier = string;
1257 export type ECSTaskSetList = ECSTaskSet[];
1258 export type ECSTaskSetStatus = string;
1259 export interface ELBInfo {
1260 /**
1261 * For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
1262 */
1263 name?: ELBName;
1264 }
1265 export type ELBInfoList = ELBInfo[];
1266 export type ELBName = string;
1267 export type ETag = string;
1268 export type ErrorCode = "DEPLOYMENT_GROUP_MISSING"|"APPLICATION_MISSING"|"REVISION_MISSING"|"IAM_ROLE_MISSING"|"IAM_ROLE_PERMISSIONS"|"NO_EC2_SUBSCRIPTION"|"OVER_MAX_INSTANCES"|"NO_INSTANCES"|"TIMEOUT"|"HEALTH_CONSTRAINTS_INVALID"|"HEALTH_CONSTRAINTS"|"INTERNAL_ERROR"|"THROTTLED"|"ALARM_ACTIVE"|"AGENT_ISSUE"|"AUTO_SCALING_IAM_ROLE_PERMISSIONS"|"AUTO_SCALING_CONFIGURATION"|"MANUAL_STOP"|"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION"|"MISSING_ELB_INFORMATION"|"MISSING_GITHUB_TOKEN"|"ELASTIC_LOAD_BALANCING_INVALID"|"ELB_INVALID_INSTANCE"|"INVALID_LAMBDA_CONFIGURATION"|"INVALID_LAMBDA_FUNCTION"|"HOOK_EXECUTION_FAILURE"|"AUTOSCALING_VALIDATION_ERROR"|"INVALID_ECS_SERVICE"|"ECS_UPDATE_ERROR"|"INVALID_REVISION"|string;
1269 export interface ErrorInformation {
1270 /**
1271 * For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide. The error code: APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started. DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started. HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified. HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified. IAM_ROLE_MISSING: The service role cannot be accessed. IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions. INTERNAL_ERROR: There was an internal error. NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2. NO_INSTANCES: No instances were specified, or no instances can be found. OVER_MAX_INSTANCES: The maximum number of instances was exceeded. THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services. TIMEOUT: The deployment has timed out. REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
1272 */
1273 code?: ErrorCode;
1274 /**
1275 * An accompanying error message.
1276 */
1277 message?: ErrorMessage;
1278 }
1279 export type ErrorMessage = string;
1280 export type FileExistsBehavior = "DISALLOW"|"OVERWRITE"|"RETAIN"|string;
1281 export type FilterValue = string;
1282 export type FilterValueList = FilterValue[];
1283 export interface GenericRevisionInfo {
1284 /**
1285 * A comment about the revision.
1286 */
1287 description?: Description;
1288 /**
1289 * The deployment groups for which this is the current target revision.
1290 */
1291 deploymentGroups?: DeploymentGroupsList;
1292 /**
1293 * When the revision was first used by AWS CodeDeploy.
1294 */
1295 firstUsedTime?: Timestamp;
1296 /**
1297 * When the revision was last used by AWS CodeDeploy.
1298 */
1299 lastUsedTime?: Timestamp;
1300 /**
1301 * When the revision was registered with AWS CodeDeploy.
1302 */
1303 registerTime?: Timestamp;
1304 }
1305 export interface GetApplicationInput {
1306 /**
1307 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1308 */
1309 applicationName: ApplicationName;
1310 }
1311 export interface GetApplicationOutput {
1312 /**
1313 * Information about the application.
1314 */
1315 application?: ApplicationInfo;
1316 }
1317 export interface GetApplicationRevisionInput {
1318 /**
1319 * The name of the application that corresponds to the revision.
1320 */
1321 applicationName: ApplicationName;
1322 /**
1323 * Information about the application revision to get, including type and location.
1324 */
1325 revision: RevisionLocation;
1326 }
1327 export interface GetApplicationRevisionOutput {
1328 /**
1329 * The name of the application that corresponds to the revision.
1330 */
1331 applicationName?: ApplicationName;
1332 /**
1333 * Additional information about the revision, including type and location.
1334 */
1335 revision?: RevisionLocation;
1336 /**
1337 * General information about the revision.
1338 */
1339 revisionInfo?: GenericRevisionInfo;
1340 }
1341 export interface GetDeploymentConfigInput {
1342 /**
1343 * The name of a deployment configuration associated with the IAM user or AWS account.
1344 */
1345 deploymentConfigName: DeploymentConfigName;
1346 }
1347 export interface GetDeploymentConfigOutput {
1348 /**
1349 * Information about the deployment configuration.
1350 */
1351 deploymentConfigInfo?: DeploymentConfigInfo;
1352 }
1353 export interface GetDeploymentGroupInput {
1354 /**
1355 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1356 */
1357 applicationName: ApplicationName;
1358 /**
1359 * The name of a deployment group for the specified application.
1360 */
1361 deploymentGroupName: DeploymentGroupName;
1362 }
1363 export interface GetDeploymentGroupOutput {
1364 /**
1365 * Information about the deployment group.
1366 */
1367 deploymentGroupInfo?: DeploymentGroupInfo;
1368 }
1369 export interface GetDeploymentInput {
1370 /**
1371 * The unique ID of a deployment associated with the IAM user or AWS account.
1372 */
1373 deploymentId: DeploymentId;
1374 }
1375 export interface GetDeploymentInstanceInput {
1376 /**
1377 * The unique ID of a deployment.
1378 */
1379 deploymentId: DeploymentId;
1380 /**
1381 * The unique ID of an instance in the deployment group.
1382 */
1383 instanceId: InstanceId;
1384 }
1385 export interface GetDeploymentInstanceOutput {
1386 /**
1387 * Information about the instance.
1388 */
1389 instanceSummary?: InstanceSummary;
1390 }
1391 export interface GetDeploymentOutput {
1392 /**
1393 * Information about the deployment.
1394 */
1395 deploymentInfo?: DeploymentInfo;
1396 }
1397 export interface GetDeploymentTargetInput {
1398 /**
1399 * The unique ID of a deployment.
1400 */
1401 deploymentId?: DeploymentId;
1402 /**
1403 * The unique ID of a deployment target.
1404 */
1405 targetId?: TargetId;
1406 }
1407 export interface GetDeploymentTargetOutput {
1408 /**
1409 * A deployment target that contains information about a deployment such as its status, lifecyle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (instanceTarget, lambdaTarget, or ecsTarget).
1410 */
1411 deploymentTarget?: DeploymentTarget;
1412 }
1413 export interface GetOnPremisesInstanceInput {
1414 /**
1415 * The name of the on-premises instance about which to get information.
1416 */
1417 instanceName: InstanceName;
1418 }
1419 export interface GetOnPremisesInstanceOutput {
1420 /**
1421 * Information about the on-premises instance.
1422 */
1423 instanceInfo?: InstanceInfo;
1424 }
1425 export type GitHubAccountTokenName = string;
1426 export type GitHubAccountTokenNameList = GitHubAccountTokenName[];
1427 export interface GitHubLocation {
1428 /**
1429 * The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. Specified as account/repository.
1430 */
1431 repository?: Repository;
1432 /**
1433 * The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
1434 */
1435 commitId?: CommitId;
1436 }
1437 export type GreenFleetProvisioningAction = "DISCOVER_EXISTING"|"COPY_AUTO_SCALING_GROUP"|string;
1438 export interface GreenFleetProvisioningOption {
1439 /**
1440 * The method used to add instances to a replacement environment. DISCOVER_EXISTING: Use instances that already exist or will be created manually. COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.
1441 */
1442 action?: GreenFleetProvisioningAction;
1443 }
1444 export type IamSessionArn = string;
1445 export type IamUserArn = string;
1446 export type InstanceAction = "TERMINATE"|"KEEP_ALIVE"|string;
1447 export type InstanceArn = string;
1448 export type InstanceCount = number;
1449 export type InstanceId = string;
1450 export interface InstanceInfo {
1451 /**
1452 * The name of the on-premises instance.
1453 */
1454 instanceName?: InstanceName;
1455 /**
1456 * The ARN of the IAM session associated with the on-premises instance.
1457 */
1458 iamSessionArn?: IamSessionArn;
1459 /**
1460 * The IAM user ARN associated with the on-premises instance.
1461 */
1462 iamUserArn?: IamUserArn;
1463 /**
1464 * The ARN of the on-premises instance.
1465 */
1466 instanceArn?: InstanceArn;
1467 /**
1468 * The time at which the on-premises instance was registered.
1469 */
1470 registerTime?: Timestamp;
1471 /**
1472 * If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
1473 */
1474 deregisterTime?: Timestamp;
1475 /**
1476 * The tags currently associated with the on-premises instance.
1477 */
1478 tags?: TagList;
1479 }
1480 export type InstanceInfoList = InstanceInfo[];
1481 export type InstanceName = string;
1482 export type InstanceNameList = InstanceName[];
1483 export type InstanceStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string;
1484 export type InstanceStatusList = InstanceStatus[];
1485 export interface InstanceSummary {
1486 /**
1487 * The unique ID of a deployment.
1488 */
1489 deploymentId?: DeploymentId;
1490 /**
1491 * The instance ID.
1492 */
1493 instanceId?: InstanceId;
1494 /**
1495 * The deployment status for this instance: Pending: The deployment is pending for this instance. In Progress: The deployment is in progress for this instance. Succeeded: The deployment has succeeded for this instance. Failed: The deployment has failed for this instance. Skipped: The deployment has been skipped for this instance. Unknown: The deployment status is unknown for this instance.
1496 */
1497 status?: InstanceStatus;
1498 /**
1499 * A timestamp that indicaties when the instance information was last updated.
1500 */
1501 lastUpdatedAt?: Timestamp;
1502 /**
1503 * A list of lifecycle events for this instance.
1504 */
1505 lifecycleEvents?: LifecycleEventList;
1506 /**
1507 * Information about which environment an instance belongs to in a blue/green deployment. BLUE: The instance is part of the original environment. GREEN: The instance is part of the replacement environment.
1508 */
1509 instanceType?: InstanceType;
1510 }
1511 export type InstanceSummaryList = InstanceSummary[];
1512 export interface InstanceTarget {
1513 /**
1514 * The unique ID of a deployment.
1515 */
1516 deploymentId?: DeploymentId;
1517 /**
1518 * The unique ID of a deployment target that has a type of instanceTarget.
1519 */
1520 targetId?: TargetId;
1521 /**
1522 * The ARN of the target.
1523 */
1524 targetArn?: TargetArn;
1525 /**
1526 * The status an EC2/On-premises deployment's target instance.
1527 */
1528 status?: TargetStatus;
1529 /**
1530 * The date and time when the target instance was updated by a deployment.
1531 */
1532 lastUpdatedAt?: Time;
1533 /**
1534 * The lifecycle events of the deployment to this target instance.
1535 */
1536 lifecycleEvents?: LifecycleEventList;
1537 /**
1538 * A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).
1539 */
1540 instanceLabel?: TargetLabel;
1541 }
1542 export type InstanceType = "Blue"|"Green"|string;
1543 export type InstanceTypeList = InstanceType[];
1544 export type InstancesList = InstanceId[];
1545 export type Key = string;
1546 export interface LambdaTarget {
1547 /**
1548 * The unique ID of a deployment.
1549 */
1550 deploymentId?: DeploymentId;
1551 /**
1552 * The unique ID of a deployment target that has a type of lambdaTarget.
1553 */
1554 targetId?: TargetId;
1555 /**
1556 * The ARN of the target.
1557 */
1558 targetArn?: TargetArn;
1559 /**
1560 * The status an AWS Lambda deployment's target Lambda function.
1561 */
1562 status?: TargetStatus;
1563 /**
1564 * The date and time when the target Lambda function was updated by a deployment.
1565 */
1566 lastUpdatedAt?: Time;
1567 /**
1568 * The lifecycle events of the deployment to this target Lambda function.
1569 */
1570 lifecycleEvents?: LifecycleEventList;
1571 }
1572 export interface LastDeploymentInfo {
1573 /**
1574 * The unique ID of a deployment.
1575 */
1576 deploymentId?: DeploymentId;
1577 /**
1578 * The status of the most recent deployment.
1579 */
1580 status?: DeploymentStatus;
1581 /**
1582 * A timestamp that indicates when the most recent deployment to the deployment group was complete.
1583 */
1584 endTime?: Timestamp;
1585 /**
1586 * A timestamp that indicates when the most recent deployment to the deployment group started.
1587 */
1588 createTime?: Timestamp;
1589 }
1590 export type LifecycleErrorCode = "Success"|"ScriptMissing"|"ScriptNotExecutable"|"ScriptTimedOut"|"ScriptFailed"|"UnknownError"|string;
1591 export interface LifecycleEvent {
1592 /**
1593 * The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
1594 */
1595 lifecycleEventName?: LifecycleEventName;
1596 /**
1597 * Diagnostic information about the deployment lifecycle event.
1598 */
1599 diagnostics?: Diagnostics;
1600 /**
1601 * A timestamp that indicates when the deployment lifecycle event started.
1602 */
1603 startTime?: Timestamp;
1604 /**
1605 * A timestamp that indicates when the deployment lifecycle event ended.
1606 */
1607 endTime?: Timestamp;
1608 /**
1609 * The deployment lifecycle event status: Pending: The deployment lifecycle event is pending. InProgress: The deployment lifecycle event is in progress. Succeeded: The deployment lifecycle event ran successfully. Failed: The deployment lifecycle event has failed. Skipped: The deployment lifecycle event has been skipped. Unknown: The deployment lifecycle event is unknown.
1610 */
1611 status?: LifecycleEventStatus;
1612 }
1613 export type LifecycleEventHookExecutionId = string;
1614 export type LifecycleEventList = LifecycleEvent[];
1615 export type LifecycleEventName = string;
1616 export type LifecycleEventStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|string;
1617 export type LifecycleMessage = string;
1618 export interface ListApplicationRevisionsInput {
1619 /**
1620 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1621 */
1622 applicationName: ApplicationName;
1623 /**
1624 * The column name to use to sort the list results: registerTime: Sort by the time the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort by the time the revisions were first used in a deployment. lastUsedTime: Sort by the time the revisions were last used in a deployment. If not specified or set to null, the results are returned in an arbitrary order.
1625 */
1626 sortBy?: ApplicationRevisionSortBy;
1627 /**
1628 * The order in which to sort the list results: ascending: ascending order. descending: descending order. If not specified, the results are sorted in ascending order. If set to null, the results are sorted in an arbitrary order.
1629 */
1630 sortOrder?: SortOrder;
1631 /**
1632 * An Amazon S3 bucket name to limit the search for revisions. If set to null, all of the user's buckets are searched.
1633 */
1634 s3Bucket?: S3Bucket;
1635 /**
1636 * A key prefix for the set of Amazon S3 objects to limit the search for revisions.
1637 */
1638 s3KeyPrefix?: S3Key;
1639 /**
1640 * Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions.
1641 */
1642 deployed?: ListStateFilterAction;
1643 /**
1644 * An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.
1645 */
1646 nextToken?: NextToken;
1647 }
1648 export interface ListApplicationRevisionsOutput {
1649 /**
1650 * A list of locations that contain the matching revisions.
1651 */
1652 revisions?: RevisionLocationList;
1653 /**
1654 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
1655 */
1656 nextToken?: NextToken;
1657 }
1658 export interface ListApplicationsInput {
1659 /**
1660 * An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
1661 */
1662 nextToken?: NextToken;
1663 }
1664 export interface ListApplicationsOutput {
1665 /**
1666 * A list of application names.
1667 */
1668 applications?: ApplicationsList;
1669 /**
1670 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.
1671 */
1672 nextToken?: NextToken;
1673 }
1674 export interface ListDeploymentConfigsInput {
1675 /**
1676 * An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.
1677 */
1678 nextToken?: NextToken;
1679 }
1680 export interface ListDeploymentConfigsOutput {
1681 /**
1682 * A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.
1683 */
1684 deploymentConfigsList?: DeploymentConfigsList;
1685 /**
1686 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
1687 */
1688 nextToken?: NextToken;
1689 }
1690 export interface ListDeploymentGroupsInput {
1691 /**
1692 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1693 */
1694 applicationName: ApplicationName;
1695 /**
1696 * An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
1697 */
1698 nextToken?: NextToken;
1699 }
1700 export interface ListDeploymentGroupsOutput {
1701 /**
1702 * The application name.
1703 */
1704 applicationName?: ApplicationName;
1705 /**
1706 * A list of deployment group names.
1707 */
1708 deploymentGroups?: DeploymentGroupsList;
1709 /**
1710 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
1711 */
1712 nextToken?: NextToken;
1713 }
1714 export interface ListDeploymentInstancesInput {
1715 /**
1716 * The unique ID of a deployment.
1717 */
1718 deploymentId: DeploymentId;
1719 /**
1720 * An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
1721 */
1722 nextToken?: NextToken;
1723 /**
1724 * A subset of instances to list by status: Pending: Include those instances with pending deployments. InProgress: Include those instances where deployments are still in progress. Succeeded: Include those instances with successful deployments. Failed: Include those instances with failed deployments. Skipped: Include those instances with skipped deployments. Unknown: Include those instances with deployments in an unknown state.
1725 */
1726 instanceStatusFilter?: InstanceStatusList;
1727 /**
1728 * The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.
1729 */
1730 instanceTypeFilter?: InstanceTypeList;
1731 }
1732 export interface ListDeploymentInstancesOutput {
1733 /**
1734 * A list of instance IDs.
1735 */
1736 instancesList?: InstancesList;
1737 /**
1738 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
1739 */
1740 nextToken?: NextToken;
1741 }
1742 export interface ListDeploymentTargetsInput {
1743 /**
1744 * The unique ID of a deployment.
1745 */
1746 deploymentId?: DeploymentId;
1747 /**
1748 * A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.
1749 */
1750 nextToken?: NextToken;
1751 /**
1752 * A key used to filter the returned targets.
1753 */
1754 targetFilters?: TargetFilters;
1755 }
1756 export interface ListDeploymentTargetsOutput {
1757 /**
1758 * The unique IDs of deployment targets.
1759 */
1760 targetIds?: TargetIdList;
1761 /**
1762 * If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.
1763 */
1764 nextToken?: NextToken;
1765 }
1766 export interface ListDeploymentsInput {
1767 /**
1768 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1769 */
1770 applicationName?: ApplicationName;
1771 /**
1772 * The name of a deployment group for the specified application.
1773 */
1774 deploymentGroupName?: DeploymentGroupName;
1775 /**
1776 * A subset of deployments to list by status: Created: Include created deployments in the resulting list. Queued: Include queued deployments in the resulting list. In Progress: Include in-progress deployments in the resulting list. Succeeded: Include successful deployments in the resulting list. Failed: Include failed deployments in the resulting list. Stopped: Include stopped deployments in the resulting list.
1777 */
1778 includeOnlyStatuses?: DeploymentStatusList;
1779 /**
1780 * A time range (start and end) for returning a subset of the list of deployments.
1781 */
1782 createTimeRange?: TimeRange;
1783 /**
1784 * An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
1785 */
1786 nextToken?: NextToken;
1787 }
1788 export interface ListDeploymentsOutput {
1789 /**
1790 * A list of deployment IDs.
1791 */
1792 deployments?: DeploymentsList;
1793 /**
1794 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.
1795 */
1796 nextToken?: NextToken;
1797 }
1798 export interface ListGitHubAccountTokenNamesInput {
1799 /**
1800 * An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.
1801 */
1802 nextToken?: NextToken;
1803 }
1804 export interface ListGitHubAccountTokenNamesOutput {
1805 /**
1806 * A list of names of connections to GitHub accounts.
1807 */
1808 tokenNameList?: GitHubAccountTokenNameList;
1809 /**
1810 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list.
1811 */
1812 nextToken?: NextToken;
1813 }
1814 export interface ListOnPremisesInstancesInput {
1815 /**
1816 * The registration status of the on-premises instances: Deregistered: Include deregistered on-premises instances in the resulting list. Registered: Include registered on-premises instances in the resulting list.
1817 */
1818 registrationStatus?: RegistrationStatus;
1819 /**
1820 * The on-premises instance tags that are used to restrict the on-premises instance names returned.
1821 */
1822 tagFilters?: TagFilterList;
1823 /**
1824 * An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
1825 */
1826 nextToken?: NextToken;
1827 }
1828 export interface ListOnPremisesInstancesOutput {
1829 /**
1830 * The list of matching on-premises instance names.
1831 */
1832 instanceNames?: InstanceNameList;
1833 /**
1834 * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
1835 */
1836 nextToken?: NextToken;
1837 }
1838 export type ListStateFilterAction = "include"|"exclude"|"ignore"|string;
1839 export type ListenerArn = string;
1840 export type ListenerArnList = ListenerArn[];
1841 export interface LoadBalancerInfo {
1842 /**
1843 * An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers. Adding more than one load balancer to the array is not supported.
1844 */
1845 elbInfoList?: ELBInfoList;
1846 /**
1847 * An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers. Adding more than one target group to the array is not supported.
1848 */
1849 targetGroupInfoList?: TargetGroupInfoList;
1850 /**
1851 * The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
1852 */
1853 targetGroupPairInfoList?: TargetGroupPairInfoList;
1854 }
1855 export type LogTail = string;
1856 export type Message = string;
1857 export interface MinimumHealthyHosts {
1858 /**
1859 * The minimum healthy instance value.
1860 */
1861 value?: MinimumHealthyHostsValue;
1862 /**
1863 * The minimum healthy instance type: HOST_COUNT: The minimum number of healthy instance as an absolute value. FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment. In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails. In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful. For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide.
1864 */
1865 type?: MinimumHealthyHostsType;
1866 }
1867 export type MinimumHealthyHostsType = "HOST_COUNT"|"FLEET_PERCENT"|string;
1868 export type MinimumHealthyHostsValue = number;
1869 export type NextToken = string;
1870 export type NullableBoolean = boolean;
1871 export interface OnPremisesTagSet {
1872 /**
1873 * A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
1874 */
1875 onPremisesTagSetList?: OnPremisesTagSetList;
1876 }
1877 export type OnPremisesTagSetList = TagFilterList[];
1878 export type Percentage = number;
1879 export interface PutLifecycleEventHookExecutionStatusInput {
1880 /**
1881 * The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
1882 */
1883 deploymentId?: DeploymentId;
1884 /**
1885 * The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.
1886 */
1887 lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId;
1888 /**
1889 * The result of a Lambda function that validates a deployment lifecycle event (Succeeded or Failed).
1890 */
1891 status?: LifecycleEventStatus;
1892 }
1893 export interface PutLifecycleEventHookExecutionStatusOutput {
1894 /**
1895 * The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.
1896 */
1897 lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId;
1898 }
1899 export interface RawString {
1900 /**
1901 * The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.
1902 */
1903 content?: RawStringContent;
1904 /**
1905 * The SHA256 hash value of the revision content.
1906 */
1907 sha256?: RawStringSha256;
1908 }
1909 export type RawStringContent = string;
1910 export type RawStringSha256 = string;
1911 export interface RegisterApplicationRevisionInput {
1912 /**
1913 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1914 */
1915 applicationName: ApplicationName;
1916 /**
1917 * A comment about the revision.
1918 */
1919 description?: Description;
1920 /**
1921 * Information about the application revision to register, including type and location.
1922 */
1923 revision: RevisionLocation;
1924 }
1925 export interface RegisterOnPremisesInstanceInput {
1926 /**
1927 * The name of the on-premises instance to register.
1928 */
1929 instanceName: InstanceName;
1930 /**
1931 * The ARN of the IAM session to associate with the on-premises instance.
1932 */
1933 iamSessionArn?: IamSessionArn;
1934 /**
1935 * The ARN of the IAM user to associate with the on-premises instance.
1936 */
1937 iamUserArn?: IamUserArn;
1938 }
1939 export type RegistrationStatus = "Registered"|"Deregistered"|string;
1940 export interface RemoveTagsFromOnPremisesInstancesInput {
1941 /**
1942 * The tag key-value pairs to remove from the on-premises instances.
1943 */
1944 tags: TagList;
1945 /**
1946 * The names of the on-premises instances from which to remove tags.
1947 */
1948 instanceNames: InstanceNameList;
1949 }
1950 export type Repository = string;
1951 export interface RevisionInfo {
1952 /**
1953 * Information about the location and type of an application revision.
1954 */
1955 revisionLocation?: RevisionLocation;
1956 /**
1957 * Information about an application revision, including usage details and associated deployment groups.
1958 */
1959 genericRevisionInfo?: GenericRevisionInfo;
1960 }
1961 export type RevisionInfoList = RevisionInfo[];
1962 export interface RevisionLocation {
1963 /**
1964 * The type of application revision: S3: An application revision stored in Amazon S3. GitHub: An application revision stored in GitHub (EC2/On-premises deployments only). String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).
1965 */
1966 revisionType?: RevisionLocationType;
1967 /**
1968 * Information about the location of a revision stored in Amazon S3.
1969 */
1970 s3Location?: S3Location;
1971 /**
1972 * Information about the location of application artifacts stored in GitHub.
1973 */
1974 gitHubLocation?: GitHubLocation;
1975 /**
1976 * Information about the location of an AWS Lambda deployment revision stored as a RawString.
1977 */
1978 string?: RawString;
1979 /**
1980 * The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
1981 */
1982 appSpecContent?: AppSpecContent;
1983 }
1984 export type RevisionLocationList = RevisionLocation[];
1985 export type RevisionLocationType = "S3"|"GitHub"|"String"|"AppSpecContent"|string;
1986 export type Role = string;
1987 export interface RollbackInfo {
1988 /**
1989 * The ID of the deployment rollback.
1990 */
1991 rollbackDeploymentId?: DeploymentId;
1992 /**
1993 * The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
1994 */
1995 rollbackTriggeringDeploymentId?: DeploymentId;
1996 /**
1997 * Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded).
1998 */
1999 rollbackMessage?: Description;
2000 }
2001 export type S3Bucket = string;
2002 export type S3Key = string;
2003 export interface S3Location {
2004 /**
2005 * The name of the Amazon S3 bucket where the application revision is stored.
2006 */
2007 bucket?: S3Bucket;
2008 /**
2009 * The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
2010 */
2011 key?: S3Key;
2012 /**
2013 * The file type of the application revision. Must be one of the following: tar: A tar archive file. tgz: A compressed tar archive file. zip: A zip archive file.
2014 */
2015 bundleType?: BundleType;
2016 /**
2017 * A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. If the version is not specified, the system uses the most recent version by default.
2018 */
2019 version?: VersionId;
2020 /**
2021 * The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. If the ETag is not specified as an input parameter, ETag validation of the object is skipped.
2022 */
2023 eTag?: ETag;
2024 }
2025 export type ScriptName = string;
2026 export interface SkipWaitTimeForInstanceTerminationInput {
2027 /**
2028 * The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
2029 */
2030 deploymentId?: DeploymentId;
2031 }
2032 export type SortOrder = "ascending"|"descending"|string;
2033 export interface StopDeploymentInput {
2034 /**
2035 * The unique ID of a deployment.
2036 */
2037 deploymentId: DeploymentId;
2038 /**
2039 * Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
2040 */
2041 autoRollbackEnabled?: NullableBoolean;
2042 }
2043 export interface StopDeploymentOutput {
2044 /**
2045 * The status of the stop deployment operation: Pending: The stop operation is pending. Succeeded: The stop operation was successful.
2046 */
2047 status?: StopStatus;
2048 /**
2049 * An accompanying status message.
2050 */
2051 statusMessage?: Message;
2052 }
2053 export type StopStatus = "Pending"|"Succeeded"|string;
2054 export interface Tag {
2055 /**
2056 * The tag's key.
2057 */
2058 Key?: Key;
2059 /**
2060 * The tag's value.
2061 */
2062 Value?: Value;
2063 }
2064 export interface TagFilter {
2065 /**
2066 * The on-premises instance tag filter key.
2067 */
2068 Key?: Key;
2069 /**
2070 * The on-premises instance tag filter value.
2071 */
2072 Value?: Value;
2073 /**
2074 * The on-premises instance tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value.
2075 */
2076 Type?: TagFilterType;
2077 }
2078 export type TagFilterList = TagFilter[];
2079 export type TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string;
2080 export type TagList = Tag[];
2081 export type TargetArn = string;
2082 export type TargetFilterName = "TargetStatus"|"ServerInstanceLabel"|string;
2083 export type TargetFilters = {[key: string]: FilterValueList};
2084 export interface TargetGroupInfo {
2085 /**
2086 * For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
2087 */
2088 name?: TargetGroupName;
2089 }
2090 export type TargetGroupInfoList = TargetGroupInfo[];
2091 export type TargetGroupName = string;
2092 export interface TargetGroupPairInfo {
2093 /**
2094 * One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.
2095 */
2096 targetGroups?: TargetGroupInfoList;
2097 /**
2098 * The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
2099 */
2100 prodTrafficRoute?: TrafficRoute;
2101 /**
2102 * An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.
2103 */
2104 testTrafficRoute?: TrafficRoute;
2105 }
2106 export type TargetGroupPairInfoList = TargetGroupPairInfo[];
2107 export type TargetId = string;
2108 export type TargetIdList = TargetId[];
2109 export interface TargetInstances {
2110 /**
2111 * The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.
2112 */
2113 tagFilters?: EC2TagFilterList;
2114 /**
2115 * The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
2116 */
2117 autoScalingGroups?: AutoScalingGroupNameList;
2118 /**
2119 * Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.
2120 */
2121 ec2TagSet?: EC2TagSet;
2122 }
2123 export type TargetLabel = "Blue"|"Green"|string;
2124 export type TargetStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string;
2125 export type Time = Date;
2126 export interface TimeBasedCanary {
2127 /**
2128 * The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
2129 */
2130 canaryPercentage?: Percentage;
2131 /**
2132 * The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
2133 */
2134 canaryInterval?: WaitTimeInMins;
2135 }
2136 export interface TimeBasedLinear {
2137 /**
2138 * The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
2139 */
2140 linearPercentage?: Percentage;
2141 /**
2142 * The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
2143 */
2144 linearInterval?: WaitTimeInMins;
2145 }
2146 export interface TimeRange {
2147 /**
2148 * The start time of the time range. Specify null to leave the start time open-ended.
2149 */
2150 start?: Timestamp;
2151 /**
2152 * The end time of the time range. Specify null to leave the end time open-ended.
2153 */
2154 end?: Timestamp;
2155 }
2156 export type Timestamp = Date;
2157 export interface TrafficRoute {
2158 /**
2159 * The ARN of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.
2160 */
2161 listenerArns?: ListenerArnList;
2162 }
2163 export interface TrafficRoutingConfig {
2164 /**
2165 * The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration .
2166 */
2167 type?: TrafficRoutingType;
2168 /**
2169 * A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.
2170 */
2171 timeBasedCanary?: TimeBasedCanary;
2172 /**
2173 * A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.
2174 */
2175 timeBasedLinear?: TimeBasedLinear;
2176 }
2177 export type TrafficRoutingType = "TimeBasedCanary"|"TimeBasedLinear"|"AllAtOnce"|string;
2178 export type TrafficWeight = number;
2179 export interface TriggerConfig {
2180 /**
2181 * The name of the notification trigger.
2182 */
2183 triggerName?: TriggerName;
2184 /**
2185 * The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
2186 */
2187 triggerTargetArn?: TriggerTargetArn;
2188 /**
2189 * The event type or types for which notifications are triggered.
2190 */
2191 triggerEvents?: TriggerEventTypeList;
2192 }
2193 export type TriggerConfigList = TriggerConfig[];
2194 export type TriggerEventType = "DeploymentStart"|"DeploymentSuccess"|"DeploymentFailure"|"DeploymentStop"|"DeploymentRollback"|"DeploymentReady"|"InstanceStart"|"InstanceSuccess"|"InstanceFailure"|"InstanceReady"|string;
2195 export type TriggerEventTypeList = TriggerEventType[];
2196 export type TriggerName = string;
2197 export type TriggerTargetArn = string;
2198 export interface UpdateApplicationInput {
2199 /**
2200 * The current name of the application you want to change.
2201 */
2202 applicationName?: ApplicationName;
2203 /**
2204 * The new name to give the application.
2205 */
2206 newApplicationName?: ApplicationName;
2207 }
2208 export interface UpdateDeploymentGroupInput {
2209 /**
2210 * The application name that corresponds to the deployment group to update.
2211 */
2212 applicationName: ApplicationName;
2213 /**
2214 * The current name of the deployment group.
2215 */
2216 currentDeploymentGroupName: DeploymentGroupName;
2217 /**
2218 * The new name of the deployment group, if you want to change it.
2219 */
2220 newDeploymentGroupName?: DeploymentGroupName;
2221 /**
2222 * The replacement deployment configuration name to use, if you want to change it.
2223 */
2224 deploymentConfigName?: DeploymentConfigName;
2225 /**
2226 * The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
2227 */
2228 ec2TagFilters?: EC2TagFilterList;
2229 /**
2230 * The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
2231 */
2232 onPremisesInstanceTagFilters?: TagFilterList;
2233 /**
2234 * The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.
2235 */
2236 autoScalingGroups?: AutoScalingGroupNameList;
2237 /**
2238 * A replacement ARN for the service role, if you want to change it.
2239 */
2240 serviceRoleArn?: Role;
2241 /**
2242 * Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.
2243 */
2244 triggerConfigurations?: TriggerConfigList;
2245 /**
2246 * Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
2247 */
2248 alarmConfiguration?: AlarmConfiguration;
2249 /**
2250 * Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
2251 */
2252 autoRollbackConfiguration?: AutoRollbackConfiguration;
2253 /**
2254 * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
2255 */
2256 deploymentStyle?: DeploymentStyle;
2257 /**
2258 * Information about blue/green deployment options for a deployment group.
2259 */
2260 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
2261 /**
2262 * Information about the load balancer used in a deployment.
2263 */
2264 loadBalancerInfo?: LoadBalancerInfo;
2265 /**
2266 * Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.
2267 */
2268 ec2TagSet?: EC2TagSet;
2269 /**
2270 * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format &lt;clustername&gt;:&lt;servicename&gt;.
2271 */
2272 ecsServices?: ECSServiceList;
2273 /**
2274 * Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
2275 */
2276 onPremisesTagSet?: OnPremisesTagSet;
2277 }
2278 export interface UpdateDeploymentGroupOutput {
2279 /**
2280 * If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
2281 */
2282 hooksNotCleanedUp?: AutoScalingGroupList;
2283 }
2284 export type Value = string;
2285 export type VersionId = string;
2286 export type WaitTimeInMins = number;
2287 /**
2288 * 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.
2289 */
2290 export type apiVersion = "2014-10-06"|"latest"|string;
2291 export interface ClientApiVersions {
2292 /**
2293 * 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.
2294 */
2295 apiVersion?: apiVersion;
2296 }
2297 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2298 /**
2299 * Contains interfaces for use with the CodeDeploy client.
2300 */
2301 export import Types = CodeDeploy;
2302}
2303export = CodeDeploy;