UNPKG

122 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. The maximum number of application revisions that can be returned is 25.
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. The maximum number of application revisions that can be returned is 25.
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. The maximum number of applications that can be returned is 25.
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. The maximum number of applications that can be returned is 25.
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 one or more 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. The maximum number of instances that can be returned is 25.
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 one or more 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. The maximum number of instances that can be returned is 25.
53 */
54 batchGetDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>;
55 /**
56 * Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25. 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 one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25. 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. The maximum number of deployments that can be returned is 25.
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. The maximum number of deployments that can be returned is 25.
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. The maximum number of on-premises instances that can be returned is 25.
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. The maximum number of on-premises instances that can be returned is 25.
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 * Returns a list of tags for the resource identified by a specified ARN. Tags are used to organize and categorize your CodeDeploy resources.
297 */
298 listTagsForResource(params: CodeDeploy.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListTagsForResourceOutput) => void): Request<CodeDeploy.Types.ListTagsForResourceOutput, AWSError>;
299 /**
300 * Returns a list of tags for the resource identified by a specified ARN. Tags are used to organize and categorize your CodeDeploy resources.
301 */
302 listTagsForResource(callback?: (err: AWSError, data: CodeDeploy.Types.ListTagsForResourceOutput) => void): Request<CodeDeploy.Types.ListTagsForResourceOutput, AWSError>;
303 /**
304 * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
305 */
306 putLifecycleEventHookExecutionStatus(params: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusInput, callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
307 /**
308 * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
309 */
310 putLifecycleEventHookExecutionStatus(callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
311 /**
312 * Registers with AWS CodeDeploy a revision for the specified application.
313 */
314 registerApplicationRevision(params: CodeDeploy.Types.RegisterApplicationRevisionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
315 /**
316 * Registers with AWS CodeDeploy a revision for the specified application.
317 */
318 registerApplicationRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
319 /**
320 * 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.
321 */
322 registerOnPremisesInstance(params: CodeDeploy.Types.RegisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
323 /**
324 * 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.
325 */
326 registerOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
327 /**
328 * Removes one or more tags from one or more on-premises instances.
329 */
330 removeTagsFromOnPremisesInstances(params: CodeDeploy.Types.RemoveTagsFromOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
331 /**
332 * Removes one or more tags from one or more on-premises instances.
333 */
334 removeTagsFromOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
335 /**
336 * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
337 */
338 skipWaitTimeForInstanceTermination(params: CodeDeploy.Types.SkipWaitTimeForInstanceTerminationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
339 /**
340 * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
341 */
342 skipWaitTimeForInstanceTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
343 /**
344 * Attempts to stop an ongoing deployment.
345 */
346 stopDeployment(params: CodeDeploy.Types.StopDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
347 /**
348 * Attempts to stop an ongoing deployment.
349 */
350 stopDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
351 /**
352 * Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.
353 */
354 tagResource(params: CodeDeploy.Types.TagResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.TagResourceOutput) => void): Request<CodeDeploy.Types.TagResourceOutput, AWSError>;
355 /**
356 * Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.
357 */
358 tagResource(callback?: (err: AWSError, data: CodeDeploy.Types.TagResourceOutput) => void): Request<CodeDeploy.Types.TagResourceOutput, AWSError>;
359 /**
360 * Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identfied by the list of keys in the TagKeys input parameter.
361 */
362 untagResource(params: CodeDeploy.Types.UntagResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.UntagResourceOutput) => void): Request<CodeDeploy.Types.UntagResourceOutput, AWSError>;
363 /**
364 * Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identfied by the list of keys in the TagKeys input parameter.
365 */
366 untagResource(callback?: (err: AWSError, data: CodeDeploy.Types.UntagResourceOutput) => void): Request<CodeDeploy.Types.UntagResourceOutput, AWSError>;
367 /**
368 * Changes the name of an application.
369 */
370 updateApplication(params: CodeDeploy.Types.UpdateApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
371 /**
372 * Changes the name of an application.
373 */
374 updateApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
375 /**
376 * Changes information about a deployment group.
377 */
378 updateDeploymentGroup(params: CodeDeploy.Types.UpdateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
379 /**
380 * Changes information about a deployment group.
381 */
382 updateDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
383 /**
384 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
385 */
386 waitFor(state: "deploymentSuccessful", params: CodeDeploy.Types.GetDeploymentInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
387 /**
388 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
389 */
390 waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
391}
392declare namespace CodeDeploy {
393 export interface AddTagsToOnPremisesInstancesInput {
394 /**
395 * 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.
396 */
397 tags: TagList;
398 /**
399 * The names of the on-premises instances to which to add tags.
400 */
401 instanceNames: InstanceNameList;
402 }
403 export type AdditionalDeploymentStatusInfo = string;
404 export interface Alarm {
405 /**
406 * The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
407 */
408 name?: AlarmName;
409 }
410 export interface AlarmConfiguration {
411 /**
412 * Indicates whether the alarm configuration is enabled.
413 */
414 enabled?: Boolean;
415 /**
416 * 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.
417 */
418 ignorePollAlarmFailure?: Boolean;
419 /**
420 * A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.
421 */
422 alarms?: AlarmList;
423 }
424 export type AlarmList = Alarm[];
425 export type AlarmName = string;
426 export interface AppSpecContent {
427 /**
428 * 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.
429 */
430 content?: RawStringContent;
431 /**
432 * The SHA256 hash value of the revision content.
433 */
434 sha256?: RawStringSha256;
435 }
436 export type ApplicationId = string;
437 export interface ApplicationInfo {
438 /**
439 * The application ID.
440 */
441 applicationId?: ApplicationId;
442 /**
443 * The application name.
444 */
445 applicationName?: ApplicationName;
446 /**
447 * The time at which the application was created.
448 */
449 createTime?: Timestamp;
450 /**
451 * True if the user has authenticated with GitHub for the specified application. Otherwise, false.
452 */
453 linkedToGitHub?: Boolean;
454 /**
455 * The name for a connection to a GitHub account.
456 */
457 gitHubAccountName?: GitHubAccountTokenName;
458 /**
459 * The destination platform type for deployment of the application (Lambda or Server).
460 */
461 computePlatform?: ComputePlatform;
462 }
463 export type ApplicationName = string;
464 export type ApplicationRevisionSortBy = "registerTime"|"firstUsedTime"|"lastUsedTime"|string;
465 export type ApplicationsInfoList = ApplicationInfo[];
466 export type ApplicationsList = ApplicationName[];
467 export type Arn = string;
468 export interface AutoRollbackConfiguration {
469 /**
470 * Indicates whether a defined automatic rollback configuration is currently enabled.
471 */
472 enabled?: Boolean;
473 /**
474 * The event type or types that trigger a rollback.
475 */
476 events?: AutoRollbackEventsList;
477 }
478 export type AutoRollbackEvent = "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"|string;
479 export type AutoRollbackEventsList = AutoRollbackEvent[];
480 export interface AutoScalingGroup {
481 /**
482 * The Auto Scaling group name.
483 */
484 name?: AutoScalingGroupName;
485 /**
486 * An Auto Scaling lifecycle event hook name.
487 */
488 hook?: AutoScalingGroupHook;
489 }
490 export type AutoScalingGroupHook = string;
491 export type AutoScalingGroupList = AutoScalingGroup[];
492 export type AutoScalingGroupName = string;
493 export type AutoScalingGroupNameList = AutoScalingGroupName[];
494 export interface BatchGetApplicationRevisionsInput {
495 /**
496 * The name of an AWS CodeDeploy application about which to get revision information.
497 */
498 applicationName: ApplicationName;
499 /**
500 * An array of RevisionLocation objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation objects you can specify is 25.
501 */
502 revisions: RevisionLocationList;
503 }
504 export interface BatchGetApplicationRevisionsOutput {
505 /**
506 * The name of the application that corresponds to the revisions.
507 */
508 applicationName?: ApplicationName;
509 /**
510 * Information about errors that might have occurred during the API call.
511 */
512 errorMessage?: ErrorMessage;
513 /**
514 * Additional information about the revisions, including the type and location.
515 */
516 revisions?: RevisionInfoList;
517 }
518 export interface BatchGetApplicationsInput {
519 /**
520 * A list of application names separated by spaces. The maximum number of application names you can specify is 25.
521 */
522 applicationNames: ApplicationsList;
523 }
524 export interface BatchGetApplicationsOutput {
525 /**
526 * Information about the applications.
527 */
528 applicationsInfo?: ApplicationsInfoList;
529 }
530 export interface BatchGetDeploymentGroupsInput {
531 /**
532 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
533 */
534 applicationName: ApplicationName;
535 /**
536 * The names of the deployment groups.
537 */
538 deploymentGroupNames: DeploymentGroupsList;
539 }
540 export interface BatchGetDeploymentGroupsOutput {
541 /**
542 * Information about the deployment groups.
543 */
544 deploymentGroupsInfo?: DeploymentGroupInfoList;
545 /**
546 * Information about errors that might have occurred during the API call.
547 */
548 errorMessage?: ErrorMessage;
549 }
550 export interface BatchGetDeploymentInstancesInput {
551 /**
552 * The unique ID of a deployment.
553 */
554 deploymentId: DeploymentId;
555 /**
556 * The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
557 */
558 instanceIds: InstancesList;
559 }
560 export interface BatchGetDeploymentInstancesOutput {
561 /**
562 * Information about the instance.
563 */
564 instancesSummary?: InstanceSummaryList;
565 /**
566 * Information about errors that might have occurred during the API call.
567 */
568 errorMessage?: ErrorMessage;
569 }
570 export interface BatchGetDeploymentTargetsInput {
571 /**
572 * The unique ID of a deployment.
573 */
574 deploymentId?: DeploymentId;
575 /**
576 * The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25. 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.
577 */
578 targetIds?: TargetIdList;
579 }
580 export interface BatchGetDeploymentTargetsOutput {
581 /**
582 * 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.
583 */
584 deploymentTargets?: DeploymentTargetList;
585 }
586 export interface BatchGetDeploymentsInput {
587 /**
588 * A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
589 */
590 deploymentIds: DeploymentsList;
591 }
592 export interface BatchGetDeploymentsOutput {
593 /**
594 * Information about the deployments.
595 */
596 deploymentsInfo?: DeploymentsInfoList;
597 }
598 export interface BatchGetOnPremisesInstancesInput {
599 /**
600 * The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
601 */
602 instanceNames: InstanceNameList;
603 }
604 export interface BatchGetOnPremisesInstancesOutput {
605 /**
606 * Information about the on-premises instances.
607 */
608 instanceInfos?: InstanceInfoList;
609 }
610 export interface BlueGreenDeploymentConfiguration {
611 /**
612 * Information about whether to terminate instances in the original fleet during a blue/green deployment.
613 */
614 terminateBlueInstancesOnDeploymentSuccess?: BlueInstanceTerminationOption;
615 /**
616 * Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
617 */
618 deploymentReadyOption?: DeploymentReadyOption;
619 /**
620 * Information about how instances are provisioned for a replacement environment in a blue/green deployment.
621 */
622 greenFleetProvisioningOption?: GreenFleetProvisioningOption;
623 }
624 export interface BlueInstanceTerminationOption {
625 /**
626 * 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.
627 */
628 action?: InstanceAction;
629 /**
630 * For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. The maximum setting is 2880 minutes (2 days).
631 */
632 terminationWaitTimeInMinutes?: Duration;
633 }
634 export type Boolean = boolean;
635 export type BundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON"|string;
636 export type CommitId = string;
637 export type ComputePlatform = "Server"|"Lambda"|"ECS"|string;
638 export interface ContinueDeploymentInput {
639 /**
640 * The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
641 */
642 deploymentId?: DeploymentId;
643 /**
644 * 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.
645 */
646 deploymentWaitType?: DeploymentWaitType;
647 }
648 export interface CreateApplicationInput {
649 /**
650 * The name of the application. This name must be unique with the applicable IAM user or AWS account.
651 */
652 applicationName: ApplicationName;
653 /**
654 * The destination platform type for the deployment (Lambda, Server, or ECS).
655 */
656 computePlatform?: ComputePlatform;
657 /**
658 * The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
659 */
660 tags?: TagList;
661 }
662 export interface CreateApplicationOutput {
663 /**
664 * A unique application ID.
665 */
666 applicationId?: ApplicationId;
667 }
668 export interface CreateDeploymentConfigInput {
669 /**
670 * The name of the deployment configuration to create.
671 */
672 deploymentConfigName: DeploymentConfigName;
673 /**
674 * 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.
675 */
676 minimumHealthyHosts?: MinimumHealthyHosts;
677 /**
678 * The configuration that specifies how the deployment traffic is routed.
679 */
680 trafficRoutingConfig?: TrafficRoutingConfig;
681 /**
682 * The destination platform type for the deployment (Lambda, Server, or ECS).
683 */
684 computePlatform?: ComputePlatform;
685 }
686 export interface CreateDeploymentConfigOutput {
687 /**
688 * A unique deployment configuration ID.
689 */
690 deploymentConfigId?: DeploymentConfigId;
691 }
692 export interface CreateDeploymentGroupInput {
693 /**
694 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
695 */
696 applicationName: ApplicationName;
697 /**
698 * The name of a new deployment group for the specified application.
699 */
700 deploymentGroupName: DeploymentGroupName;
701 /**
702 * 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.
703 */
704 deploymentConfigName?: DeploymentConfigName;
705 /**
706 * 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.
707 */
708 ec2TagFilters?: EC2TagFilterList;
709 /**
710 * 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.
711 */
712 onPremisesInstanceTagFilters?: TagFilterList;
713 /**
714 * A list of associated Amazon EC2 Auto Scaling groups.
715 */
716 autoScalingGroups?: AutoScalingGroupNameList;
717 /**
718 * A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
719 */
720 serviceRoleArn: Role;
721 /**
722 * 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.
723 */
724 triggerConfigurations?: TriggerConfigList;
725 /**
726 * Information to add about Amazon CloudWatch alarms when the deployment group is created.
727 */
728 alarmConfiguration?: AlarmConfiguration;
729 /**
730 * Configuration information for an automatic rollback that is added when a deployment group is created.
731 */
732 autoRollbackConfiguration?: AutoRollbackConfiguration;
733 /**
734 * 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.
735 */
736 deploymentStyle?: DeploymentStyle;
737 /**
738 * Information about blue/green deployment options for a deployment group.
739 */
740 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
741 /**
742 * Information about the load balancer used in a deployment.
743 */
744 loadBalancerInfo?: LoadBalancerInfo;
745 /**
746 * 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.
747 */
748 ec2TagSet?: EC2TagSet;
749 /**
750 * 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;.
751 */
752 ecsServices?: ECSServiceList;
753 /**
754 * 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.
755 */
756 onPremisesTagSet?: OnPremisesTagSet;
757 /**
758 * The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
759 */
760 tags?: TagList;
761 }
762 export interface CreateDeploymentGroupOutput {
763 /**
764 * A unique deployment group ID.
765 */
766 deploymentGroupId?: DeploymentGroupId;
767 }
768 export interface CreateDeploymentInput {
769 /**
770 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
771 */
772 applicationName: ApplicationName;
773 /**
774 * The name of the deployment group.
775 */
776 deploymentGroupName?: DeploymentGroupName;
777 /**
778 * The type and location of the revision to deploy.
779 */
780 revision?: RevisionLocation;
781 /**
782 * 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.
783 */
784 deploymentConfigName?: DeploymentConfigName;
785 /**
786 * A comment about the deployment.
787 */
788 description?: Description;
789 /**
790 * 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.
791 */
792 ignoreApplicationStopFailures?: Boolean;
793 /**
794 * Information about the instances that belong to the replacement environment in a blue/green deployment.
795 */
796 targetInstances?: TargetInstances;
797 /**
798 * Configuration information for an automatic rollback that is added when a deployment is created.
799 */
800 autoRollbackConfiguration?: AutoRollbackConfiguration;
801 /**
802 * Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
803 */
804 updateOutdatedInstancesOnly?: Boolean;
805 /**
806 * 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.
807 */
808 fileExistsBehavior?: FileExistsBehavior;
809 }
810 export interface CreateDeploymentOutput {
811 /**
812 * The unique ID of a deployment.
813 */
814 deploymentId?: DeploymentId;
815 }
816 export interface DeleteApplicationInput {
817 /**
818 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
819 */
820 applicationName: ApplicationName;
821 }
822 export interface DeleteDeploymentConfigInput {
823 /**
824 * The name of a deployment configuration associated with the IAM user or AWS account.
825 */
826 deploymentConfigName: DeploymentConfigName;
827 }
828 export interface DeleteDeploymentGroupInput {
829 /**
830 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
831 */
832 applicationName: ApplicationName;
833 /**
834 * The name of a deployment group for the specified application.
835 */
836 deploymentGroupName: DeploymentGroupName;
837 }
838 export interface DeleteDeploymentGroupOutput {
839 /**
840 * 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.
841 */
842 hooksNotCleanedUp?: AutoScalingGroupList;
843 }
844 export interface DeleteGitHubAccountTokenInput {
845 /**
846 * The name of the GitHub account connection to delete.
847 */
848 tokenName?: GitHubAccountTokenName;
849 }
850 export interface DeleteGitHubAccountTokenOutput {
851 /**
852 * The name of the GitHub account connection that was deleted.
853 */
854 tokenName?: GitHubAccountTokenName;
855 }
856 export type DeploymentConfigId = string;
857 export interface DeploymentConfigInfo {
858 /**
859 * The deployment configuration ID.
860 */
861 deploymentConfigId?: DeploymentConfigId;
862 /**
863 * The deployment configuration name.
864 */
865 deploymentConfigName?: DeploymentConfigName;
866 /**
867 * Information about the number or percentage of minimum healthy instance.
868 */
869 minimumHealthyHosts?: MinimumHealthyHosts;
870 /**
871 * The time at which the deployment configuration was created.
872 */
873 createTime?: Timestamp;
874 /**
875 * The destination platform type for the deployment (Lambda, Server, or ECS).
876 */
877 computePlatform?: ComputePlatform;
878 /**
879 * The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute platform can specify this.
880 */
881 trafficRoutingConfig?: TrafficRoutingConfig;
882 }
883 export type DeploymentConfigName = string;
884 export type DeploymentConfigsList = DeploymentConfigName[];
885 export type DeploymentCreator = "user"|"autoscaling"|"codeDeployRollback"|string;
886 export type DeploymentGroupId = string;
887 export interface DeploymentGroupInfo {
888 /**
889 * The application name.
890 */
891 applicationName?: ApplicationName;
892 /**
893 * The deployment group ID.
894 */
895 deploymentGroupId?: DeploymentGroupId;
896 /**
897 * The deployment group name.
898 */
899 deploymentGroupName?: DeploymentGroupName;
900 /**
901 * The deployment configuration name.
902 */
903 deploymentConfigName?: DeploymentConfigName;
904 /**
905 * The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
906 */
907 ec2TagFilters?: EC2TagFilterList;
908 /**
909 * The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
910 */
911 onPremisesInstanceTagFilters?: TagFilterList;
912 /**
913 * A list of associated Auto Scaling groups.
914 */
915 autoScalingGroups?: AutoScalingGroupList;
916 /**
917 * A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.
918 */
919 serviceRoleArn?: Role;
920 /**
921 * Information about the deployment group's target revision, including type and location.
922 */
923 targetRevision?: RevisionLocation;
924 /**
925 * Information about triggers associated with the deployment group.
926 */
927 triggerConfigurations?: TriggerConfigList;
928 /**
929 * A list of alarms associated with the deployment group.
930 */
931 alarmConfiguration?: AlarmConfiguration;
932 /**
933 * Information about the automatic rollback configuration associated with the deployment group.
934 */
935 autoRollbackConfiguration?: AutoRollbackConfiguration;
936 /**
937 * 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.
938 */
939 deploymentStyle?: DeploymentStyle;
940 /**
941 * Information about blue/green deployment options for a deployment group.
942 */
943 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
944 /**
945 * Information about the load balancer to use in a deployment.
946 */
947 loadBalancerInfo?: LoadBalancerInfo;
948 /**
949 * Information about the most recent successful deployment to the deployment group.
950 */
951 lastSuccessfulDeployment?: LastDeploymentInfo;
952 /**
953 * Information about the most recent attempted deployment to the deployment group.
954 */
955 lastAttemptedDeployment?: LastDeploymentInfo;
956 /**
957 * 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.
958 */
959 ec2TagSet?: EC2TagSet;
960 /**
961 * 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.
962 */
963 onPremisesTagSet?: OnPremisesTagSet;
964 /**
965 * The destination platform type for the deployment (Lambda, Server, or ECS).
966 */
967 computePlatform?: ComputePlatform;
968 /**
969 * 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;.
970 */
971 ecsServices?: ECSServiceList;
972 }
973 export type DeploymentGroupInfoList = DeploymentGroupInfo[];
974 export type DeploymentGroupName = string;
975 export type DeploymentGroupsList = DeploymentGroupName[];
976 export type DeploymentId = string;
977 export interface DeploymentInfo {
978 /**
979 * The application name.
980 */
981 applicationName?: ApplicationName;
982 /**
983 * The deployment group name.
984 */
985 deploymentGroupName?: DeploymentGroupName;
986 /**
987 * The deployment configuration name.
988 */
989 deploymentConfigName?: DeploymentConfigName;
990 /**
991 * The unique ID of a deployment.
992 */
993 deploymentId?: DeploymentId;
994 /**
995 * Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
996 */
997 previousRevision?: RevisionLocation;
998 /**
999 * Information about the location of stored application artifacts and the service from which to retrieve them.
1000 */
1001 revision?: RevisionLocation;
1002 /**
1003 * The current state of the deployment as a whole.
1004 */
1005 status?: DeploymentStatus;
1006 /**
1007 * Information about any error associated with this deployment.
1008 */
1009 errorInformation?: ErrorInformation;
1010 /**
1011 * A timestamp that indicates when the deployment was created.
1012 */
1013 createTime?: Timestamp;
1014 /**
1015 * 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.
1016 */
1017 startTime?: Timestamp;
1018 /**
1019 * A timestamp that indicates when the deployment was complete.
1020 */
1021 completeTime?: Timestamp;
1022 /**
1023 * A summary of the deployment status of the instances in the deployment.
1024 */
1025 deploymentOverview?: DeploymentOverview;
1026 /**
1027 * A comment about the deployment.
1028 */
1029 description?: Description;
1030 /**
1031 * 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.
1032 */
1033 creator?: DeploymentCreator;
1034 /**
1035 * 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.
1036 */
1037 ignoreApplicationStopFailures?: Boolean;
1038 /**
1039 * Information about the automatic rollback configuration associated with the deployment.
1040 */
1041 autoRollbackConfiguration?: AutoRollbackConfiguration;
1042 /**
1043 * Indicates whether only instances that are not running the latest application revision are to be deployed to.
1044 */
1045 updateOutdatedInstancesOnly?: Boolean;
1046 /**
1047 * Information about a deployment rollback.
1048 */
1049 rollbackInfo?: RollbackInfo;
1050 /**
1051 * 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.
1052 */
1053 deploymentStyle?: DeploymentStyle;
1054 /**
1055 * Information about the instances that belong to the replacement environment in a blue/green deployment.
1056 */
1057 targetInstances?: TargetInstances;
1058 /**
1059 * 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.
1060 */
1061 instanceTerminationWaitTimeStarted?: Boolean;
1062 /**
1063 * Information about blue/green deployment options for this deployment.
1064 */
1065 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
1066 /**
1067 * Information about the load balancer used in the deployment.
1068 */
1069 loadBalancerInfo?: LoadBalancerInfo;
1070 /**
1071 * Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
1072 */
1073 additionalDeploymentStatusInfo?: AdditionalDeploymentStatusInfo;
1074 /**
1075 * 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.
1076 */
1077 fileExistsBehavior?: FileExistsBehavior;
1078 /**
1079 * Messages that contain information about the status of a deployment.
1080 */
1081 deploymentStatusMessages?: DeploymentStatusMessageList;
1082 /**
1083 * The destination platform type for the deployment (Lambda, Server, or ECS).
1084 */
1085 computePlatform?: ComputePlatform;
1086 }
1087 export type DeploymentOption = "WITH_TRAFFIC_CONTROL"|"WITHOUT_TRAFFIC_CONTROL"|string;
1088 export interface DeploymentOverview {
1089 /**
1090 * The number of instances in the deployment in a pending state.
1091 */
1092 Pending?: InstanceCount;
1093 /**
1094 * The number of instances in which the deployment is in progress.
1095 */
1096 InProgress?: InstanceCount;
1097 /**
1098 * The number of instances in the deployment to which revisions have been successfully deployed.
1099 */
1100 Succeeded?: InstanceCount;
1101 /**
1102 * The number of instances in the deployment in a failed state.
1103 */
1104 Failed?: InstanceCount;
1105 /**
1106 * The number of instances in the deployment in a skipped state.
1107 */
1108 Skipped?: InstanceCount;
1109 /**
1110 * The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
1111 */
1112 Ready?: InstanceCount;
1113 }
1114 export type DeploymentReadyAction = "CONTINUE_DEPLOYMENT"|"STOP_DEPLOYMENT"|string;
1115 export interface DeploymentReadyOption {
1116 /**
1117 * 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.
1118 */
1119 actionOnTimeout?: DeploymentReadyAction;
1120 /**
1121 * 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
1122 */
1123 waitTimeInMinutes?: Duration;
1124 }
1125 export type DeploymentStatus = "Created"|"Queued"|"InProgress"|"Succeeded"|"Failed"|"Stopped"|"Ready"|string;
1126 export type DeploymentStatusList = DeploymentStatus[];
1127 export type DeploymentStatusMessageList = ErrorMessage[];
1128 export interface DeploymentStyle {
1129 /**
1130 * Indicates whether to run an in-place deployment or a blue/green deployment.
1131 */
1132 deploymentType?: DeploymentType;
1133 /**
1134 * Indicates whether to route deployment traffic behind a load balancer.
1135 */
1136 deploymentOption?: DeploymentOption;
1137 }
1138 export interface DeploymentTarget {
1139 /**
1140 * The deployment type that is specific to the deployment's compute platform.
1141 */
1142 deploymentTargetType?: DeploymentTargetType;
1143 /**
1144 * Information about the target for a deployment that uses the EC2/On-premises compute platform.
1145 */
1146 instanceTarget?: InstanceTarget;
1147 /**
1148 * Information about the target for a deployment that uses the AWS Lambda compute platform.
1149 */
1150 lambdaTarget?: LambdaTarget;
1151 /**
1152 * Information about the target for a deployment that uses the Amazon ECS compute platform.
1153 */
1154 ecsTarget?: ECSTarget;
1155 }
1156 export type DeploymentTargetList = DeploymentTarget[];
1157 export type DeploymentTargetType = "InstanceTarget"|"LambdaTarget"|"ECSTarget"|string;
1158 export type DeploymentType = "IN_PLACE"|"BLUE_GREEN"|string;
1159 export type DeploymentWaitType = "READY_WAIT"|"TERMINATION_WAIT"|string;
1160 export type DeploymentsInfoList = DeploymentInfo[];
1161 export type DeploymentsList = DeploymentId[];
1162 export interface DeregisterOnPremisesInstanceInput {
1163 /**
1164 * The name of the on-premises instance to deregister.
1165 */
1166 instanceName: InstanceName;
1167 }
1168 export type Description = string;
1169 export interface Diagnostics {
1170 /**
1171 * 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.
1172 */
1173 errorCode?: LifecycleErrorCode;
1174 /**
1175 * The name of the script.
1176 */
1177 scriptName?: ScriptName;
1178 /**
1179 * The message associated with the error.
1180 */
1181 message?: LifecycleMessage;
1182 /**
1183 * The last portion of the diagnostic log. If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.
1184 */
1185 logTail?: LogTail;
1186 }
1187 export type Duration = number;
1188 export interface EC2TagFilter {
1189 /**
1190 * The tag filter key.
1191 */
1192 Key?: Key;
1193 /**
1194 * The tag filter value.
1195 */
1196 Value?: Value;
1197 /**
1198 * The tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value.
1199 */
1200 Type?: EC2TagFilterType;
1201 }
1202 export type EC2TagFilterList = EC2TagFilter[];
1203 export type EC2TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string;
1204 export interface EC2TagSet {
1205 /**
1206 * 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.
1207 */
1208 ec2TagSetList?: EC2TagSetList;
1209 }
1210 export type EC2TagSetList = EC2TagFilterList[];
1211 export type ECSClusterName = string;
1212 export interface ECSService {
1213 /**
1214 * The name of the target Amazon ECS service.
1215 */
1216 serviceName?: ECSServiceName;
1217 /**
1218 * The name of the cluster that the Amazon ECS service is associated with.
1219 */
1220 clusterName?: ECSClusterName;
1221 }
1222 export type ECSServiceList = ECSService[];
1223 export type ECSServiceName = string;
1224 export interface ECSTarget {
1225 /**
1226 * The unique ID of a deployment.
1227 */
1228 deploymentId?: DeploymentId;
1229 /**
1230 * The unique ID of a deployment target that has a type of ecsTarget.
1231 */
1232 targetId?: TargetId;
1233 /**
1234 * The ARN of the target.
1235 */
1236 targetArn?: TargetArn;
1237 /**
1238 * The date and time when the target Amazon ECS application was updated by a deployment.
1239 */
1240 lastUpdatedAt?: Time;
1241 /**
1242 * The lifecycle events of the deployment to this target Amazon ECS application.
1243 */
1244 lifecycleEvents?: LifecycleEventList;
1245 /**
1246 * The status an Amazon ECS deployment's target ECS application.
1247 */
1248 status?: TargetStatus;
1249 /**
1250 * The ECSTaskSet objects associated with the ECS target.
1251 */
1252 taskSetsInfo?: ECSTaskSetList;
1253 }
1254 export interface ECSTaskSet {
1255 /**
1256 * A unique ID of an ECSTaskSet.
1257 */
1258 identifer?: ECSTaskSetIdentifier;
1259 /**
1260 * 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.
1261 */
1262 desiredCount?: ECSTaskSetCount;
1263 /**
1264 * 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.
1265 */
1266 pendingCount?: ECSTaskSetCount;
1267 /**
1268 * 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.
1269 */
1270 runningCount?: ECSTaskSetCount;
1271 /**
1272 * 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.
1273 */
1274 status?: ECSTaskSetStatus;
1275 /**
1276 * The percentage of traffic served by this task set.
1277 */
1278 trafficWeight?: TrafficWeight;
1279 /**
1280 * The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.
1281 */
1282 targetGroup?: TargetGroupInfo;
1283 /**
1284 * A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
1285 */
1286 taskSetLabel?: TargetLabel;
1287 }
1288 export type ECSTaskSetCount = number;
1289 export type ECSTaskSetIdentifier = string;
1290 export type ECSTaskSetList = ECSTaskSet[];
1291 export type ECSTaskSetStatus = string;
1292 export interface ELBInfo {
1293 /**
1294 * 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.
1295 */
1296 name?: ELBName;
1297 }
1298 export type ELBInfoList = ELBInfo[];
1299 export type ELBName = string;
1300 export type ETag = string;
1301 export type ErrorCode = "AGENT_ISSUE"|"ALARM_ACTIVE"|"APPLICATION_MISSING"|"AUTOSCALING_VALIDATION_ERROR"|"AUTO_SCALING_CONFIGURATION"|"AUTO_SCALING_IAM_ROLE_PERMISSIONS"|"CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND"|"CUSTOMER_APPLICATION_UNHEALTHY"|"DEPLOYMENT_GROUP_MISSING"|"ECS_UPDATE_ERROR"|"ELASTIC_LOAD_BALANCING_INVALID"|"ELB_INVALID_INSTANCE"|"HEALTH_CONSTRAINTS"|"HEALTH_CONSTRAINTS_INVALID"|"HOOK_EXECUTION_FAILURE"|"IAM_ROLE_MISSING"|"IAM_ROLE_PERMISSIONS"|"INTERNAL_ERROR"|"INVALID_ECS_SERVICE"|"INVALID_LAMBDA_CONFIGURATION"|"INVALID_LAMBDA_FUNCTION"|"INVALID_REVISION"|"MANUAL_STOP"|"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION"|"MISSING_ELB_INFORMATION"|"MISSING_GITHUB_TOKEN"|"NO_EC2_SUBSCRIPTION"|"NO_INSTANCES"|"OVER_MAX_INSTANCES"|"RESOURCE_LIMIT_EXCEEDED"|"REVISION_MISSING"|"THROTTLED"|"TIMEOUT"|string;
1302 export interface ErrorInformation {
1303 /**
1304 * 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.
1305 */
1306 code?: ErrorCode;
1307 /**
1308 * An accompanying error message.
1309 */
1310 message?: ErrorMessage;
1311 }
1312 export type ErrorMessage = string;
1313 export type FileExistsBehavior = "DISALLOW"|"OVERWRITE"|"RETAIN"|string;
1314 export type FilterValue = string;
1315 export type FilterValueList = FilterValue[];
1316 export interface GenericRevisionInfo {
1317 /**
1318 * A comment about the revision.
1319 */
1320 description?: Description;
1321 /**
1322 * The deployment groups for which this is the current target revision.
1323 */
1324 deploymentGroups?: DeploymentGroupsList;
1325 /**
1326 * When the revision was first used by AWS CodeDeploy.
1327 */
1328 firstUsedTime?: Timestamp;
1329 /**
1330 * When the revision was last used by AWS CodeDeploy.
1331 */
1332 lastUsedTime?: Timestamp;
1333 /**
1334 * When the revision was registered with AWS CodeDeploy.
1335 */
1336 registerTime?: Timestamp;
1337 }
1338 export interface GetApplicationInput {
1339 /**
1340 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1341 */
1342 applicationName: ApplicationName;
1343 }
1344 export interface GetApplicationOutput {
1345 /**
1346 * Information about the application.
1347 */
1348 application?: ApplicationInfo;
1349 }
1350 export interface GetApplicationRevisionInput {
1351 /**
1352 * The name of the application that corresponds to the revision.
1353 */
1354 applicationName: ApplicationName;
1355 /**
1356 * Information about the application revision to get, including type and location.
1357 */
1358 revision: RevisionLocation;
1359 }
1360 export interface GetApplicationRevisionOutput {
1361 /**
1362 * The name of the application that corresponds to the revision.
1363 */
1364 applicationName?: ApplicationName;
1365 /**
1366 * Additional information about the revision, including type and location.
1367 */
1368 revision?: RevisionLocation;
1369 /**
1370 * General information about the revision.
1371 */
1372 revisionInfo?: GenericRevisionInfo;
1373 }
1374 export interface GetDeploymentConfigInput {
1375 /**
1376 * The name of a deployment configuration associated with the IAM user or AWS account.
1377 */
1378 deploymentConfigName: DeploymentConfigName;
1379 }
1380 export interface GetDeploymentConfigOutput {
1381 /**
1382 * Information about the deployment configuration.
1383 */
1384 deploymentConfigInfo?: DeploymentConfigInfo;
1385 }
1386 export interface GetDeploymentGroupInput {
1387 /**
1388 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1389 */
1390 applicationName: ApplicationName;
1391 /**
1392 * The name of a deployment group for the specified application.
1393 */
1394 deploymentGroupName: DeploymentGroupName;
1395 }
1396 export interface GetDeploymentGroupOutput {
1397 /**
1398 * Information about the deployment group.
1399 */
1400 deploymentGroupInfo?: DeploymentGroupInfo;
1401 }
1402 export interface GetDeploymentInput {
1403 /**
1404 * The unique ID of a deployment associated with the IAM user or AWS account.
1405 */
1406 deploymentId: DeploymentId;
1407 }
1408 export interface GetDeploymentInstanceInput {
1409 /**
1410 * The unique ID of a deployment.
1411 */
1412 deploymentId: DeploymentId;
1413 /**
1414 * The unique ID of an instance in the deployment group.
1415 */
1416 instanceId: InstanceId;
1417 }
1418 export interface GetDeploymentInstanceOutput {
1419 /**
1420 * Information about the instance.
1421 */
1422 instanceSummary?: InstanceSummary;
1423 }
1424 export interface GetDeploymentOutput {
1425 /**
1426 * Information about the deployment.
1427 */
1428 deploymentInfo?: DeploymentInfo;
1429 }
1430 export interface GetDeploymentTargetInput {
1431 /**
1432 * The unique ID of a deployment.
1433 */
1434 deploymentId?: DeploymentId;
1435 /**
1436 * The unique ID of a deployment target.
1437 */
1438 targetId?: TargetId;
1439 }
1440 export interface GetDeploymentTargetOutput {
1441 /**
1442 * 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).
1443 */
1444 deploymentTarget?: DeploymentTarget;
1445 }
1446 export interface GetOnPremisesInstanceInput {
1447 /**
1448 * The name of the on-premises instance about which to get information.
1449 */
1450 instanceName: InstanceName;
1451 }
1452 export interface GetOnPremisesInstanceOutput {
1453 /**
1454 * Information about the on-premises instance.
1455 */
1456 instanceInfo?: InstanceInfo;
1457 }
1458 export type GitHubAccountTokenName = string;
1459 export type GitHubAccountTokenNameList = GitHubAccountTokenName[];
1460 export interface GitHubLocation {
1461 /**
1462 * 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.
1463 */
1464 repository?: Repository;
1465 /**
1466 * The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
1467 */
1468 commitId?: CommitId;
1469 }
1470 export type GreenFleetProvisioningAction = "DISCOVER_EXISTING"|"COPY_AUTO_SCALING_GROUP"|string;
1471 export interface GreenFleetProvisioningOption {
1472 /**
1473 * 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.
1474 */
1475 action?: GreenFleetProvisioningAction;
1476 }
1477 export type IamSessionArn = string;
1478 export type IamUserArn = string;
1479 export type InstanceAction = "TERMINATE"|"KEEP_ALIVE"|string;
1480 export type InstanceArn = string;
1481 export type InstanceCount = number;
1482 export type InstanceId = string;
1483 export interface InstanceInfo {
1484 /**
1485 * The name of the on-premises instance.
1486 */
1487 instanceName?: InstanceName;
1488 /**
1489 * The ARN of the IAM session associated with the on-premises instance.
1490 */
1491 iamSessionArn?: IamSessionArn;
1492 /**
1493 * The IAM user ARN associated with the on-premises instance.
1494 */
1495 iamUserArn?: IamUserArn;
1496 /**
1497 * The ARN of the on-premises instance.
1498 */
1499 instanceArn?: InstanceArn;
1500 /**
1501 * The time at which the on-premises instance was registered.
1502 */
1503 registerTime?: Timestamp;
1504 /**
1505 * If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
1506 */
1507 deregisterTime?: Timestamp;
1508 /**
1509 * The tags currently associated with the on-premises instance.
1510 */
1511 tags?: TagList;
1512 }
1513 export type InstanceInfoList = InstanceInfo[];
1514 export type InstanceName = string;
1515 export type InstanceNameList = InstanceName[];
1516 export type InstanceStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string;
1517 export type InstanceStatusList = InstanceStatus[];
1518 export interface InstanceSummary {
1519 /**
1520 * The unique ID of a deployment.
1521 */
1522 deploymentId?: DeploymentId;
1523 /**
1524 * The instance ID.
1525 */
1526 instanceId?: InstanceId;
1527 /**
1528 * 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.
1529 */
1530 status?: InstanceStatus;
1531 /**
1532 * A timestamp that indicaties when the instance information was last updated.
1533 */
1534 lastUpdatedAt?: Timestamp;
1535 /**
1536 * A list of lifecycle events for this instance.
1537 */
1538 lifecycleEvents?: LifecycleEventList;
1539 /**
1540 * 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.
1541 */
1542 instanceType?: InstanceType;
1543 }
1544 export type InstanceSummaryList = InstanceSummary[];
1545 export interface InstanceTarget {
1546 /**
1547 * The unique ID of a deployment.
1548 */
1549 deploymentId?: DeploymentId;
1550 /**
1551 * The unique ID of a deployment target that has a type of instanceTarget.
1552 */
1553 targetId?: TargetId;
1554 /**
1555 * The ARN of the target.
1556 */
1557 targetArn?: TargetArn;
1558 /**
1559 * The status an EC2/On-premises deployment's target instance.
1560 */
1561 status?: TargetStatus;
1562 /**
1563 * The date and time when the target instance was updated by a deployment.
1564 */
1565 lastUpdatedAt?: Time;
1566 /**
1567 * The lifecycle events of the deployment to this target instance.
1568 */
1569 lifecycleEvents?: LifecycleEventList;
1570 /**
1571 * A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).
1572 */
1573 instanceLabel?: TargetLabel;
1574 }
1575 export type InstanceType = "Blue"|"Green"|string;
1576 export type InstanceTypeList = InstanceType[];
1577 export type InstancesList = InstanceId[];
1578 export type Key = string;
1579 export type LambdaFunctionAlias = string;
1580 export interface LambdaFunctionInfo {
1581 /**
1582 * The name of a Lambda function.
1583 */
1584 functionName?: LambdaFunctionName;
1585 /**
1586 * The alias of a Lambda function. For more information, see Introduction to AWS Lambda Aliases.
1587 */
1588 functionAlias?: LambdaFunctionAlias;
1589 /**
1590 * The version of a Lambda function that production traffic points to.
1591 */
1592 currentVersion?: Version;
1593 /**
1594 * The version of a Lambda function that production traffic points to after the Lambda function is deployed.
1595 */
1596 targetVersion?: Version;
1597 /**
1598 * The percentage of production traffic that the target version of a Lambda function receives.
1599 */
1600 targetVersionWeight?: TrafficWeight;
1601 }
1602 export type LambdaFunctionName = string;
1603 export interface LambdaTarget {
1604 /**
1605 * The unique ID of a deployment.
1606 */
1607 deploymentId?: DeploymentId;
1608 /**
1609 * The unique ID of a deployment target that has a type of lambdaTarget.
1610 */
1611 targetId?: TargetId;
1612 /**
1613 * The ARN of the target.
1614 */
1615 targetArn?: TargetArn;
1616 /**
1617 * The status an AWS Lambda deployment's target Lambda function.
1618 */
1619 status?: TargetStatus;
1620 /**
1621 * The date and time when the target Lambda function was updated by a deployment.
1622 */
1623 lastUpdatedAt?: Time;
1624 /**
1625 * The lifecycle events of the deployment to this target Lambda function.
1626 */
1627 lifecycleEvents?: LifecycleEventList;
1628 /**
1629 * A LambdaFunctionInfo object that describes a target Lambda function.
1630 */
1631 lambdaFunctionInfo?: LambdaFunctionInfo;
1632 }
1633 export interface LastDeploymentInfo {
1634 /**
1635 * The unique ID of a deployment.
1636 */
1637 deploymentId?: DeploymentId;
1638 /**
1639 * The status of the most recent deployment.
1640 */
1641 status?: DeploymentStatus;
1642 /**
1643 * A timestamp that indicates when the most recent deployment to the deployment group was complete.
1644 */
1645 endTime?: Timestamp;
1646 /**
1647 * A timestamp that indicates when the most recent deployment to the deployment group started.
1648 */
1649 createTime?: Timestamp;
1650 }
1651 export type LifecycleErrorCode = "Success"|"ScriptMissing"|"ScriptNotExecutable"|"ScriptTimedOut"|"ScriptFailed"|"UnknownError"|string;
1652 export interface LifecycleEvent {
1653 /**
1654 * The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
1655 */
1656 lifecycleEventName?: LifecycleEventName;
1657 /**
1658 * Diagnostic information about the deployment lifecycle event.
1659 */
1660 diagnostics?: Diagnostics;
1661 /**
1662 * A timestamp that indicates when the deployment lifecycle event started.
1663 */
1664 startTime?: Timestamp;
1665 /**
1666 * A timestamp that indicates when the deployment lifecycle event ended.
1667 */
1668 endTime?: Timestamp;
1669 /**
1670 * 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.
1671 */
1672 status?: LifecycleEventStatus;
1673 }
1674 export type LifecycleEventHookExecutionId = string;
1675 export type LifecycleEventList = LifecycleEvent[];
1676 export type LifecycleEventName = string;
1677 export type LifecycleEventStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|string;
1678 export type LifecycleMessage = string;
1679 export interface ListApplicationRevisionsInput {
1680 /**
1681 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1682 */
1683 applicationName: ApplicationName;
1684 /**
1685 * 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.
1686 */
1687 sortBy?: ApplicationRevisionSortBy;
1688 /**
1689 * 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.
1690 */
1691 sortOrder?: SortOrder;
1692 /**
1693 * An Amazon S3 bucket name to limit the search for revisions. If set to null, all of the user's buckets are searched.
1694 */
1695 s3Bucket?: S3Bucket;
1696 /**
1697 * A key prefix for the set of Amazon S3 objects to limit the search for revisions.
1698 */
1699 s3KeyPrefix?: S3Key;
1700 /**
1701 * 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.
1702 */
1703 deployed?: ListStateFilterAction;
1704 /**
1705 * An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.
1706 */
1707 nextToken?: NextToken;
1708 }
1709 export interface ListApplicationRevisionsOutput {
1710 /**
1711 * A list of locations that contain the matching revisions.
1712 */
1713 revisions?: RevisionLocationList;
1714 /**
1715 * 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.
1716 */
1717 nextToken?: NextToken;
1718 }
1719 export interface ListApplicationsInput {
1720 /**
1721 * An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
1722 */
1723 nextToken?: NextToken;
1724 }
1725 export interface ListApplicationsOutput {
1726 /**
1727 * A list of application names.
1728 */
1729 applications?: ApplicationsList;
1730 /**
1731 * 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.
1732 */
1733 nextToken?: NextToken;
1734 }
1735 export interface ListDeploymentConfigsInput {
1736 /**
1737 * An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.
1738 */
1739 nextToken?: NextToken;
1740 }
1741 export interface ListDeploymentConfigsOutput {
1742 /**
1743 * A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.
1744 */
1745 deploymentConfigsList?: DeploymentConfigsList;
1746 /**
1747 * 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.
1748 */
1749 nextToken?: NextToken;
1750 }
1751 export interface ListDeploymentGroupsInput {
1752 /**
1753 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1754 */
1755 applicationName: ApplicationName;
1756 /**
1757 * 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.
1758 */
1759 nextToken?: NextToken;
1760 }
1761 export interface ListDeploymentGroupsOutput {
1762 /**
1763 * The application name.
1764 */
1765 applicationName?: ApplicationName;
1766 /**
1767 * A list of deployment group names.
1768 */
1769 deploymentGroups?: DeploymentGroupsList;
1770 /**
1771 * 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.
1772 */
1773 nextToken?: NextToken;
1774 }
1775 export interface ListDeploymentInstancesInput {
1776 /**
1777 * The unique ID of a deployment.
1778 */
1779 deploymentId: DeploymentId;
1780 /**
1781 * 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.
1782 */
1783 nextToken?: NextToken;
1784 /**
1785 * 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.
1786 */
1787 instanceStatusFilter?: InstanceStatusList;
1788 /**
1789 * 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.
1790 */
1791 instanceTypeFilter?: InstanceTypeList;
1792 }
1793 export interface ListDeploymentInstancesOutput {
1794 /**
1795 * A list of instance IDs.
1796 */
1797 instancesList?: InstancesList;
1798 /**
1799 * 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.
1800 */
1801 nextToken?: NextToken;
1802 }
1803 export interface ListDeploymentTargetsInput {
1804 /**
1805 * The unique ID of a deployment.
1806 */
1807 deploymentId?: DeploymentId;
1808 /**
1809 * A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.
1810 */
1811 nextToken?: NextToken;
1812 /**
1813 * A key used to filter the returned targets. The two valid values are: TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown. ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.
1814 */
1815 targetFilters?: TargetFilters;
1816 }
1817 export interface ListDeploymentTargetsOutput {
1818 /**
1819 * The unique IDs of deployment targets.
1820 */
1821 targetIds?: TargetIdList;
1822 /**
1823 * 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.
1824 */
1825 nextToken?: NextToken;
1826 }
1827 export interface ListDeploymentsInput {
1828 /**
1829 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.
1830 */
1831 applicationName?: ApplicationName;
1832 /**
1833 * The name of a deployment group for the specified application. If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.
1834 */
1835 deploymentGroupName?: DeploymentGroupName;
1836 /**
1837 * 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.
1838 */
1839 includeOnlyStatuses?: DeploymentStatusList;
1840 /**
1841 * A time range (start and end) for returning a subset of the list of deployments.
1842 */
1843 createTimeRange?: TimeRange;
1844 /**
1845 * An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
1846 */
1847 nextToken?: NextToken;
1848 }
1849 export interface ListDeploymentsOutput {
1850 /**
1851 * A list of deployment IDs.
1852 */
1853 deployments?: DeploymentsList;
1854 /**
1855 * 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.
1856 */
1857 nextToken?: NextToken;
1858 }
1859 export interface ListGitHubAccountTokenNamesInput {
1860 /**
1861 * An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.
1862 */
1863 nextToken?: NextToken;
1864 }
1865 export interface ListGitHubAccountTokenNamesOutput {
1866 /**
1867 * A list of names of connections to GitHub accounts.
1868 */
1869 tokenNameList?: GitHubAccountTokenNameList;
1870 /**
1871 * 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.
1872 */
1873 nextToken?: NextToken;
1874 }
1875 export interface ListOnPremisesInstancesInput {
1876 /**
1877 * 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.
1878 */
1879 registrationStatus?: RegistrationStatus;
1880 /**
1881 * The on-premises instance tags that are used to restrict the on-premises instance names returned.
1882 */
1883 tagFilters?: TagFilterList;
1884 /**
1885 * 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.
1886 */
1887 nextToken?: NextToken;
1888 }
1889 export interface ListOnPremisesInstancesOutput {
1890 /**
1891 * The list of matching on-premises instance names.
1892 */
1893 instanceNames?: InstanceNameList;
1894 /**
1895 * 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.
1896 */
1897 nextToken?: NextToken;
1898 }
1899 export type ListStateFilterAction = "include"|"exclude"|"ignore"|string;
1900 export interface ListTagsForResourceInput {
1901 /**
1902 * The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.
1903 */
1904 ResourceArn: Arn;
1905 /**
1906 * An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.
1907 */
1908 NextToken?: NextToken;
1909 }
1910 export interface ListTagsForResourceOutput {
1911 /**
1912 * A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter.
1913 */
1914 Tags?: TagList;
1915 /**
1916 * 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.
1917 */
1918 NextToken?: NextToken;
1919 }
1920 export type ListenerArn = string;
1921 export type ListenerArnList = ListenerArn[];
1922 export interface LoadBalancerInfo {
1923 /**
1924 * 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.
1925 */
1926 elbInfoList?: ELBInfoList;
1927 /**
1928 * 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.
1929 */
1930 targetGroupInfoList?: TargetGroupInfoList;
1931 /**
1932 * The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
1933 */
1934 targetGroupPairInfoList?: TargetGroupPairInfoList;
1935 }
1936 export type LogTail = string;
1937 export type Message = string;
1938 export interface MinimumHealthyHosts {
1939 /**
1940 * The minimum healthy instance value.
1941 */
1942 value?: MinimumHealthyHostsValue;
1943 /**
1944 * 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 GetDeploymentConfig, 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.
1945 */
1946 type?: MinimumHealthyHostsType;
1947 }
1948 export type MinimumHealthyHostsType = "HOST_COUNT"|"FLEET_PERCENT"|string;
1949 export type MinimumHealthyHostsValue = number;
1950 export type NextToken = string;
1951 export type NullableBoolean = boolean;
1952 export interface OnPremisesTagSet {
1953 /**
1954 * 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.
1955 */
1956 onPremisesTagSetList?: OnPremisesTagSetList;
1957 }
1958 export type OnPremisesTagSetList = TagFilterList[];
1959 export type Percentage = number;
1960 export interface PutLifecycleEventHookExecutionStatusInput {
1961 /**
1962 * The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
1963 */
1964 deploymentId?: DeploymentId;
1965 /**
1966 * The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.
1967 */
1968 lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId;
1969 /**
1970 * The result of a Lambda function that validates a deployment lifecycle event (Succeeded or Failed).
1971 */
1972 status?: LifecycleEventStatus;
1973 }
1974 export interface PutLifecycleEventHookExecutionStatusOutput {
1975 /**
1976 * The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.
1977 */
1978 lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId;
1979 }
1980 export interface RawString {
1981 /**
1982 * 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.
1983 */
1984 content?: RawStringContent;
1985 /**
1986 * The SHA256 hash value of the revision content.
1987 */
1988 sha256?: RawStringSha256;
1989 }
1990 export type RawStringContent = string;
1991 export type RawStringSha256 = string;
1992 export interface RegisterApplicationRevisionInput {
1993 /**
1994 * The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
1995 */
1996 applicationName: ApplicationName;
1997 /**
1998 * A comment about the revision.
1999 */
2000 description?: Description;
2001 /**
2002 * Information about the application revision to register, including type and location.
2003 */
2004 revision: RevisionLocation;
2005 }
2006 export interface RegisterOnPremisesInstanceInput {
2007 /**
2008 * The name of the on-premises instance to register.
2009 */
2010 instanceName: InstanceName;
2011 /**
2012 * The ARN of the IAM session to associate with the on-premises instance.
2013 */
2014 iamSessionArn?: IamSessionArn;
2015 /**
2016 * The ARN of the IAM user to associate with the on-premises instance.
2017 */
2018 iamUserArn?: IamUserArn;
2019 }
2020 export type RegistrationStatus = "Registered"|"Deregistered"|string;
2021 export interface RemoveTagsFromOnPremisesInstancesInput {
2022 /**
2023 * The tag key-value pairs to remove from the on-premises instances.
2024 */
2025 tags: TagList;
2026 /**
2027 * The names of the on-premises instances from which to remove tags.
2028 */
2029 instanceNames: InstanceNameList;
2030 }
2031 export type Repository = string;
2032 export interface RevisionInfo {
2033 /**
2034 * Information about the location and type of an application revision.
2035 */
2036 revisionLocation?: RevisionLocation;
2037 /**
2038 * Information about an application revision, including usage details and associated deployment groups.
2039 */
2040 genericRevisionInfo?: GenericRevisionInfo;
2041 }
2042 export type RevisionInfoList = RevisionInfo[];
2043 export interface RevisionLocation {
2044 /**
2045 * 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).
2046 */
2047 revisionType?: RevisionLocationType;
2048 /**
2049 * Information about the location of a revision stored in Amazon S3.
2050 */
2051 s3Location?: S3Location;
2052 /**
2053 * Information about the location of application artifacts stored in GitHub.
2054 */
2055 gitHubLocation?: GitHubLocation;
2056 /**
2057 * Information about the location of an AWS Lambda deployment revision stored as a RawString.
2058 */
2059 string?: RawString;
2060 /**
2061 * 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.
2062 */
2063 appSpecContent?: AppSpecContent;
2064 }
2065 export type RevisionLocationList = RevisionLocation[];
2066 export type RevisionLocationType = "S3"|"GitHub"|"String"|"AppSpecContent"|string;
2067 export type Role = string;
2068 export interface RollbackInfo {
2069 /**
2070 * The ID of the deployment rollback.
2071 */
2072 rollbackDeploymentId?: DeploymentId;
2073 /**
2074 * The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
2075 */
2076 rollbackTriggeringDeploymentId?: DeploymentId;
2077 /**
2078 * 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).
2079 */
2080 rollbackMessage?: Description;
2081 }
2082 export type S3Bucket = string;
2083 export type S3Key = string;
2084 export interface S3Location {
2085 /**
2086 * The name of the Amazon S3 bucket where the application revision is stored.
2087 */
2088 bucket?: S3Bucket;
2089 /**
2090 * The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
2091 */
2092 key?: S3Key;
2093 /**
2094 * 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.
2095 */
2096 bundleType?: BundleType;
2097 /**
2098 * 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.
2099 */
2100 version?: VersionId;
2101 /**
2102 * 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.
2103 */
2104 eTag?: ETag;
2105 }
2106 export type ScriptName = string;
2107 export interface SkipWaitTimeForInstanceTerminationInput {
2108 /**
2109 * The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
2110 */
2111 deploymentId?: DeploymentId;
2112 }
2113 export type SortOrder = "ascending"|"descending"|string;
2114 export interface StopDeploymentInput {
2115 /**
2116 * The unique ID of a deployment.
2117 */
2118 deploymentId: DeploymentId;
2119 /**
2120 * Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
2121 */
2122 autoRollbackEnabled?: NullableBoolean;
2123 }
2124 export interface StopDeploymentOutput {
2125 /**
2126 * The status of the stop deployment operation: Pending: The stop operation is pending. Succeeded: The stop operation was successful.
2127 */
2128 status?: StopStatus;
2129 /**
2130 * An accompanying status message.
2131 */
2132 statusMessage?: Message;
2133 }
2134 export type StopStatus = "Pending"|"Succeeded"|string;
2135 export interface Tag {
2136 /**
2137 * The tag's key.
2138 */
2139 Key?: Key;
2140 /**
2141 * The tag's value.
2142 */
2143 Value?: Value;
2144 }
2145 export interface TagFilter {
2146 /**
2147 * The on-premises instance tag filter key.
2148 */
2149 Key?: Key;
2150 /**
2151 * The on-premises instance tag filter value.
2152 */
2153 Value?: Value;
2154 /**
2155 * The on-premises instance tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value.
2156 */
2157 Type?: TagFilterType;
2158 }
2159 export type TagFilterList = TagFilter[];
2160 export type TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string;
2161 export type TagKeyList = Key[];
2162 export type TagList = Tag[];
2163 export interface TagResourceInput {
2164 /**
2165 * The ARN of a resource, such as a CodeDeploy application or deployment group.
2166 */
2167 ResourceArn: Arn;
2168 /**
2169 * A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.
2170 */
2171 Tags: TagList;
2172 }
2173 export interface TagResourceOutput {
2174 }
2175 export type TargetArn = string;
2176 export type TargetFilterName = "TargetStatus"|"ServerInstanceLabel"|string;
2177 export type TargetFilters = {[key: string]: FilterValueList};
2178 export interface TargetGroupInfo {
2179 /**
2180 * 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.
2181 */
2182 name?: TargetGroupName;
2183 }
2184 export type TargetGroupInfoList = TargetGroupInfo[];
2185 export type TargetGroupName = string;
2186 export interface TargetGroupPairInfo {
2187 /**
2188 * 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.
2189 */
2190 targetGroups?: TargetGroupInfoList;
2191 /**
2192 * The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
2193 */
2194 prodTrafficRoute?: TrafficRoute;
2195 /**
2196 * 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.
2197 */
2198 testTrafficRoute?: TrafficRoute;
2199 }
2200 export type TargetGroupPairInfoList = TargetGroupPairInfo[];
2201 export type TargetId = string;
2202 export type TargetIdList = TargetId[];
2203 export interface TargetInstances {
2204 /**
2205 * 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.
2206 */
2207 tagFilters?: EC2TagFilterList;
2208 /**
2209 * The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
2210 */
2211 autoScalingGroups?: AutoScalingGroupNameList;
2212 /**
2213 * 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.
2214 */
2215 ec2TagSet?: EC2TagSet;
2216 }
2217 export type TargetLabel = "Blue"|"Green"|string;
2218 export type TargetStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string;
2219 export type Time = Date;
2220 export interface TimeBasedCanary {
2221 /**
2222 * The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
2223 */
2224 canaryPercentage?: Percentage;
2225 /**
2226 * The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
2227 */
2228 canaryInterval?: WaitTimeInMins;
2229 }
2230 export interface TimeBasedLinear {
2231 /**
2232 * The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
2233 */
2234 linearPercentage?: Percentage;
2235 /**
2236 * The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
2237 */
2238 linearInterval?: WaitTimeInMins;
2239 }
2240 export interface TimeRange {
2241 /**
2242 * The start time of the time range. Specify null to leave the start time open-ended.
2243 */
2244 start?: Timestamp;
2245 /**
2246 * The end time of the time range. Specify null to leave the end time open-ended.
2247 */
2248 end?: Timestamp;
2249 }
2250 export type Timestamp = Date;
2251 export interface TrafficRoute {
2252 /**
2253 * 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.
2254 */
2255 listenerArns?: ListenerArnList;
2256 }
2257 export interface TrafficRoutingConfig {
2258 /**
2259 * The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration .
2260 */
2261 type?: TrafficRoutingType;
2262 /**
2263 * 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.
2264 */
2265 timeBasedCanary?: TimeBasedCanary;
2266 /**
2267 * 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.
2268 */
2269 timeBasedLinear?: TimeBasedLinear;
2270 }
2271 export type TrafficRoutingType = "TimeBasedCanary"|"TimeBasedLinear"|"AllAtOnce"|string;
2272 export type TrafficWeight = number;
2273 export interface TriggerConfig {
2274 /**
2275 * The name of the notification trigger.
2276 */
2277 triggerName?: TriggerName;
2278 /**
2279 * The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
2280 */
2281 triggerTargetArn?: TriggerTargetArn;
2282 /**
2283 * The event type or types for which notifications are triggered.
2284 */
2285 triggerEvents?: TriggerEventTypeList;
2286 }
2287 export type TriggerConfigList = TriggerConfig[];
2288 export type TriggerEventType = "DeploymentStart"|"DeploymentSuccess"|"DeploymentFailure"|"DeploymentStop"|"DeploymentRollback"|"DeploymentReady"|"InstanceStart"|"InstanceSuccess"|"InstanceFailure"|"InstanceReady"|string;
2289 export type TriggerEventTypeList = TriggerEventType[];
2290 export type TriggerName = string;
2291 export type TriggerTargetArn = string;
2292 export interface UntagResourceInput {
2293 /**
2294 * The ARN that specifies from which resource to disassociate the tags with the keys in the TagKeys input paramter.
2295 */
2296 ResourceArn: Arn;
2297 /**
2298 * A list of keys of Tag objects. The Tag objects identified by the keys are disassociated from the resource specified by the ResourceArn input parameter.
2299 */
2300 TagKeys: TagKeyList;
2301 }
2302 export interface UntagResourceOutput {
2303 }
2304 export interface UpdateApplicationInput {
2305 /**
2306 * The current name of the application you want to change.
2307 */
2308 applicationName?: ApplicationName;
2309 /**
2310 * The new name to give the application.
2311 */
2312 newApplicationName?: ApplicationName;
2313 }
2314 export interface UpdateDeploymentGroupInput {
2315 /**
2316 * The application name that corresponds to the deployment group to update.
2317 */
2318 applicationName: ApplicationName;
2319 /**
2320 * The current name of the deployment group.
2321 */
2322 currentDeploymentGroupName: DeploymentGroupName;
2323 /**
2324 * The new name of the deployment group, if you want to change it.
2325 */
2326 newDeploymentGroupName?: DeploymentGroupName;
2327 /**
2328 * The replacement deployment configuration name to use, if you want to change it.
2329 */
2330 deploymentConfigName?: DeploymentConfigName;
2331 /**
2332 * 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.
2333 */
2334 ec2TagFilters?: EC2TagFilterList;
2335 /**
2336 * 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.
2337 */
2338 onPremisesInstanceTagFilters?: TagFilterList;
2339 /**
2340 * 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.
2341 */
2342 autoScalingGroups?: AutoScalingGroupNameList;
2343 /**
2344 * A replacement ARN for the service role, if you want to change it.
2345 */
2346 serviceRoleArn?: Role;
2347 /**
2348 * 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.
2349 */
2350 triggerConfigurations?: TriggerConfigList;
2351 /**
2352 * Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
2353 */
2354 alarmConfiguration?: AlarmConfiguration;
2355 /**
2356 * Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
2357 */
2358 autoRollbackConfiguration?: AutoRollbackConfiguration;
2359 /**
2360 * 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.
2361 */
2362 deploymentStyle?: DeploymentStyle;
2363 /**
2364 * Information about blue/green deployment options for a deployment group.
2365 */
2366 blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
2367 /**
2368 * Information about the load balancer used in a deployment.
2369 */
2370 loadBalancerInfo?: LoadBalancerInfo;
2371 /**
2372 * Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.
2373 */
2374 ec2TagSet?: EC2TagSet;
2375 /**
2376 * 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;.
2377 */
2378 ecsServices?: ECSServiceList;
2379 /**
2380 * Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
2381 */
2382 onPremisesTagSet?: OnPremisesTagSet;
2383 }
2384 export interface UpdateDeploymentGroupOutput {
2385 /**
2386 * 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.
2387 */
2388 hooksNotCleanedUp?: AutoScalingGroupList;
2389 }
2390 export type Value = string;
2391 export type Version = string;
2392 export type VersionId = string;
2393 export type WaitTimeInMins = number;
2394 /**
2395 * 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.
2396 */
2397 export type apiVersion = "2014-10-06"|"latest"|string;
2398 export interface ClientApiVersions {
2399 /**
2400 * 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.
2401 */
2402 apiVersion?: apiVersion;
2403 }
2404 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2405 /**
2406 * Contains interfaces for use with the CodeDeploy client.
2407 */
2408 export import Types = CodeDeploy;
2409}
2410export = CodeDeploy;