codedeploy.d.ts (72478B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class CodeDeploy extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CodeDeploy.Types.ClientConfiguration) 13 config: Config & CodeDeploy.Types.ClientConfiguration; 14 /** 15 * Adds tags to on-premises instances. 16 */ 17 addTagsToOnPremisesInstances(params: CodeDeploy.Types.AddTagsToOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * Adds tags to on-premises instances. 20 */ 21 addTagsToOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * Gets information about one or more application revisions. 24 */ 25 batchGetApplicationRevisions(params: CodeDeploy.Types.BatchGetApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>; 26 /** 27 * Gets information about one or more application revisions. 28 */ 29 batchGetApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>; 30 /** 31 * Gets information about one or more applications. 32 */ 33 batchGetApplications(params: CodeDeploy.Types.BatchGetApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>; 34 /** 35 * Gets information about one or more applications. 36 */ 37 batchGetApplications(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>; 38 /** 39 * Get information about one or more deployment groups. 40 */ 41 batchGetDeploymentGroups(params: CodeDeploy.Types.BatchGetDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>; 42 /** 43 * Get information about one or more deployment groups. 44 */ 45 batchGetDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>; 46 /** 47 * Gets information about one or more instance that are part of a deployment group. 48 */ 49 batchGetDeploymentInstances(params: CodeDeploy.Types.BatchGetDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>; 50 /** 51 * Gets information about one or more instance that are part of a deployment group. 52 */ 53 batchGetDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>; 54 /** 55 * Gets information about one or more deployments. 56 */ 57 batchGetDeployments(params: CodeDeploy.Types.BatchGetDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>; 58 /** 59 * Gets information about one or more deployments. 60 */ 61 batchGetDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>; 62 /** 63 * Gets information about one or more on-premises instances. 64 */ 65 batchGetOnPremisesInstances(params: CodeDeploy.Types.BatchGetOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>; 66 /** 67 * Gets information about one or more on-premises instances. 68 */ 69 batchGetOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>; 70 /** 71 * Creates an application. 72 */ 73 createApplication(params: CodeDeploy.Types.CreateApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>; 74 /** 75 * Creates an application. 76 */ 77 createApplication(callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>; 78 /** 79 * Deploys an application revision through the specified deployment group. 80 */ 81 createDeployment(params: CodeDeploy.Types.CreateDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>; 82 /** 83 * Deploys an application revision through the specified deployment group. 84 */ 85 createDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>; 86 /** 87 * Creates a deployment configuration. 88 */ 89 createDeploymentConfig(params: CodeDeploy.Types.CreateDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>; 90 /** 91 * Creates a deployment configuration. 92 */ 93 createDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>; 94 /** 95 * Creates a deployment group to which application revisions will be deployed. 96 */ 97 createDeploymentGroup(params: CodeDeploy.Types.CreateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>; 98 /** 99 * Creates a deployment group to which application revisions will be deployed. 100 */ 101 createDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>; 102 /** 103 * Deletes an application. 104 */ 105 deleteApplication(params: CodeDeploy.Types.DeleteApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 106 /** 107 * Deletes an application. 108 */ 109 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 110 /** 111 * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. 112 */ 113 deleteDeploymentConfig(params: CodeDeploy.Types.DeleteDeploymentConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 114 /** 115 * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. 116 */ 117 deleteDeploymentConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 118 /** 119 * Deletes a deployment group. 120 */ 121 deleteDeploymentGroup(params: CodeDeploy.Types.DeleteDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>; 122 /** 123 * Deletes a deployment group. 124 */ 125 deleteDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>; 126 /** 127 * Deregisters an on-premises instance. 128 */ 129 deregisterOnPremisesInstance(params: CodeDeploy.Types.DeregisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 130 /** 131 * Deregisters an on-premises instance. 132 */ 133 deregisterOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 134 /** 135 * Gets information about an application. 136 */ 137 getApplication(params: CodeDeploy.Types.GetApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>; 138 /** 139 * Gets information about an application. 140 */ 141 getApplication(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>; 142 /** 143 * Gets information about an application revision. 144 */ 145 getApplicationRevision(params: CodeDeploy.Types.GetApplicationRevisionInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>; 146 /** 147 * Gets information about an application revision. 148 */ 149 getApplicationRevision(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>; 150 /** 151 * Gets information about a deployment. 152 */ 153 getDeployment(params: CodeDeploy.Types.GetDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>; 154 /** 155 * Gets information about a deployment. 156 */ 157 getDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>; 158 /** 159 * Gets information about a deployment configuration. 160 */ 161 getDeploymentConfig(params: CodeDeploy.Types.GetDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>; 162 /** 163 * Gets information about a deployment configuration. 164 */ 165 getDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>; 166 /** 167 * Gets information about a deployment group. 168 */ 169 getDeploymentGroup(params: CodeDeploy.Types.GetDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>; 170 /** 171 * Gets information about a deployment group. 172 */ 173 getDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>; 174 /** 175 * Gets information about an instance as part of a deployment. 176 */ 177 getDeploymentInstance(params: CodeDeploy.Types.GetDeploymentInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>; 178 /** 179 * Gets information about an instance as part of a deployment. 180 */ 181 getDeploymentInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>; 182 /** 183 * Gets information about an on-premises instance. 184 */ 185 getOnPremisesInstance(params: CodeDeploy.Types.GetOnPremisesInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>; 186 /** 187 * Gets information about an on-premises instance. 188 */ 189 getOnPremisesInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>; 190 /** 191 * Lists information about revisions for an application. 192 */ 193 listApplicationRevisions(params: CodeDeploy.Types.ListApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>; 194 /** 195 * Lists information about revisions for an application. 196 */ 197 listApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>; 198 /** 199 * Lists the applications registered with the applicable IAM user or AWS account. 200 */ 201 listApplications(params: CodeDeploy.Types.ListApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>; 202 /** 203 * Lists the applications registered with the applicable IAM user or AWS account. 204 */ 205 listApplications(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>; 206 /** 207 * Lists the deployment configurations with the applicable IAM user or AWS account. 208 */ 209 listDeploymentConfigs(params: CodeDeploy.Types.ListDeploymentConfigsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>; 210 /** 211 * Lists the deployment configurations with the applicable IAM user or AWS account. 212 */ 213 listDeploymentConfigs(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>; 214 /** 215 * Lists the deployment groups for an application registered with the applicable IAM user or AWS account. 216 */ 217 listDeploymentGroups(params: CodeDeploy.Types.ListDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>; 218 /** 219 * Lists the deployment groups for an application registered with the applicable IAM user or AWS account. 220 */ 221 listDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>; 222 /** 223 * Lists the instance for a deployment associated with the applicable IAM user or AWS account. 224 */ 225 listDeploymentInstances(params: CodeDeploy.Types.ListDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>; 226 /** 227 * Lists the instance for a deployment associated with the applicable IAM user or AWS account. 228 */ 229 listDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>; 230 /** 231 * Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account. 232 */ 233 listDeployments(params: CodeDeploy.Types.ListDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>; 234 /** 235 * Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account. 236 */ 237 listDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>; 238 /** 239 * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. 240 */ 241 listOnPremisesInstances(params: CodeDeploy.Types.ListOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>; 242 /** 243 * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. 244 */ 245 listOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>; 246 /** 247 * Registers with AWS CodeDeploy a revision for the specified application. 248 */ 249 registerApplicationRevision(params: CodeDeploy.Types.RegisterApplicationRevisionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 250 /** 251 * Registers with AWS CodeDeploy a revision for the specified application. 252 */ 253 registerApplicationRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 254 /** 255 * Registers an on-premises instance. 256 */ 257 registerOnPremisesInstance(params: CodeDeploy.Types.RegisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 258 /** 259 * Registers an on-premises instance. 260 */ 261 registerOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 262 /** 263 * Removes one or more tags from one or more on-premises instances. 264 */ 265 removeTagsFromOnPremisesInstances(params: CodeDeploy.Types.RemoveTagsFromOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 266 /** 267 * Removes one or more tags from one or more on-premises instances. 268 */ 269 removeTagsFromOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 270 /** 271 * Attempts to stop an ongoing deployment. 272 */ 273 stopDeployment(params: CodeDeploy.Types.StopDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>; 274 /** 275 * Attempts to stop an ongoing deployment. 276 */ 277 stopDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>; 278 /** 279 * Changes the name of an application. 280 */ 281 updateApplication(params: CodeDeploy.Types.UpdateApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 282 /** 283 * Changes the name of an application. 284 */ 285 updateApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 286 /** 287 * Changes information about a deployment group. 288 */ 289 updateDeploymentGroup(params: CodeDeploy.Types.UpdateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>; 290 /** 291 * Changes information about a deployment group. 292 */ 293 updateDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>; 294 /** 295 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times). 296 */ 297 waitFor(state: "deploymentSuccessful", params: CodeDeploy.Types.GetDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>; 298 /** 299 * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times). 300 */ 301 waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>; 302 } 303 declare namespace CodeDeploy.Types { 304 export interface AddTagsToOnPremisesInstancesInput { 305 /** 306 * 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. 307 */ 308 tags: TagList; 309 /** 310 * The names of the on-premises instances to which to add tags. 311 */ 312 instanceNames: InstanceNameList; 313 } 314 export interface Alarm { 315 /** 316 * The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms. 317 */ 318 name?: AlarmName; 319 } 320 export interface AlarmConfiguration { 321 /** 322 * Indicates whether the alarm configuration is enabled. 323 */ 324 enabled?: Boolean; 325 /** 326 * 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 will proceed even if alarm status information can't be retrieved from Amazon CloudWatch. false: The deployment will stop if alarm status information can't be retrieved from Amazon CloudWatch. 327 */ 328 ignorePollAlarmFailure?: Boolean; 329 /** 330 * A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group. 331 */ 332 alarms?: AlarmList; 333 } 334 export type AlarmList = Alarm[]; 335 export type AlarmName = string; 336 export type ApplicationId = string; 337 export interface ApplicationInfo { 338 /** 339 * The application ID. 340 */ 341 applicationId?: ApplicationId; 342 /** 343 * The application name. 344 */ 345 applicationName?: ApplicationName; 346 /** 347 * The time at which the application was created. 348 */ 349 createTime?: Timestamp; 350 /** 351 * True if the user has authenticated with GitHub for the specified application; otherwise, false. 352 */ 353 linkedToGitHub?: Boolean; 354 } 355 export type ApplicationName = string; 356 export type ApplicationRevisionSortBy = "registerTime"|"firstUsedTime"|"lastUsedTime"|string; 357 export type ApplicationsInfoList = ApplicationInfo[]; 358 export type ApplicationsList = ApplicationName[]; 359 export interface AutoRollbackConfiguration { 360 /** 361 * Indicates whether a defined automatic rollback configuration is currently enabled. 362 */ 363 enabled?: Boolean; 364 /** 365 * The event type or types that trigger a rollback. 366 */ 367 events?: AutoRollbackEventsList; 368 } 369 export type AutoRollbackEvent = "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"|string; 370 export type AutoRollbackEventsList = AutoRollbackEvent[]; 371 export interface AutoScalingGroup { 372 /** 373 * The Auto Scaling group name. 374 */ 375 name?: AutoScalingGroupName; 376 /** 377 * An Auto Scaling lifecycle event hook name. 378 */ 379 hook?: AutoScalingGroupHook; 380 } 381 export type AutoScalingGroupHook = string; 382 export type AutoScalingGroupList = AutoScalingGroup[]; 383 export type AutoScalingGroupName = string; 384 export type AutoScalingGroupNameList = AutoScalingGroupName[]; 385 export interface BatchGetApplicationRevisionsInput { 386 /** 387 * The name of an AWS CodeDeploy application about which to get revision information. 388 */ 389 applicationName: ApplicationName; 390 /** 391 * Information to get about the application revisions, including type and location. 392 */ 393 revisions: RevisionLocationList; 394 } 395 export interface BatchGetApplicationRevisionsOutput { 396 /** 397 * The name of the application that corresponds to the revisions. 398 */ 399 applicationName?: ApplicationName; 400 /** 401 * Information about errors that may have occurred during the API call. 402 */ 403 errorMessage?: ErrorMessage; 404 /** 405 * Additional information about the revisions, including the type and location. 406 */ 407 revisions?: RevisionInfoList; 408 } 409 export interface BatchGetApplicationsInput { 410 /** 411 * A list of application names separated by spaces. 412 */ 413 applicationNames?: ApplicationsList; 414 } 415 export interface BatchGetApplicationsOutput { 416 /** 417 * Information about the applications. 418 */ 419 applicationsInfo?: ApplicationsInfoList; 420 } 421 export interface BatchGetDeploymentGroupsInput { 422 /** 423 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 424 */ 425 applicationName: ApplicationName; 426 /** 427 * The deployment groups' names. 428 */ 429 deploymentGroupNames: DeploymentGroupsList; 430 } 431 export interface BatchGetDeploymentGroupsOutput { 432 /** 433 * Information about the deployment groups. 434 */ 435 deploymentGroupsInfo?: DeploymentGroupInfoList; 436 /** 437 * Information about errors that may have occurred during the API call. 438 */ 439 errorMessage?: ErrorMessage; 440 } 441 export interface BatchGetDeploymentInstancesInput { 442 /** 443 * The unique ID of a deployment. 444 */ 445 deploymentId: DeploymentId; 446 /** 447 * The unique IDs of instances in the deployment group. 448 */ 449 instanceIds: InstancesList; 450 } 451 export interface BatchGetDeploymentInstancesOutput { 452 /** 453 * Information about the instance. 454 */ 455 instancesSummary?: InstanceSummaryList; 456 /** 457 * Information about errors that may have occurred during the API call. 458 */ 459 errorMessage?: ErrorMessage; 460 } 461 export interface BatchGetDeploymentsInput { 462 /** 463 * A list of deployment IDs, separated by spaces. 464 */ 465 deploymentIds?: DeploymentsList; 466 } 467 export interface BatchGetDeploymentsOutput { 468 /** 469 * Information about the deployments. 470 */ 471 deploymentsInfo?: DeploymentsInfoList; 472 } 473 export interface BatchGetOnPremisesInstancesInput { 474 /** 475 * The names of the on-premises instances about which to get information. 476 */ 477 instanceNames?: InstanceNameList; 478 } 479 export interface BatchGetOnPremisesInstancesOutput { 480 /** 481 * Information about the on-premises instances. 482 */ 483 instanceInfos?: InstanceInfoList; 484 } 485 export type Boolean = boolean; 486 export type BundleType = "tar"|"tgz"|"zip"|string; 487 export type CommitId = string; 488 export interface CreateApplicationInput { 489 /** 490 * The name of the application. This name must be unique with the applicable IAM user or AWS account. 491 */ 492 applicationName: ApplicationName; 493 } 494 export interface CreateApplicationOutput { 495 /** 496 * A unique application ID. 497 */ 498 applicationId?: ApplicationId; 499 } 500 export interface CreateDeploymentConfigInput { 501 /** 502 * The name of the deployment configuration to create. 503 */ 504 deploymentConfigName: DeploymentConfigName; 505 /** 506 * 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. 507 */ 508 minimumHealthyHosts?: MinimumHealthyHosts; 509 } 510 export interface CreateDeploymentConfigOutput { 511 /** 512 * A unique deployment configuration ID. 513 */ 514 deploymentConfigId?: DeploymentConfigId; 515 } 516 export interface CreateDeploymentGroupInput { 517 /** 518 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 519 */ 520 applicationName: ApplicationName; 521 /** 522 * The name of a new deployment group for the specified application. 523 */ 524 deploymentGroupName: DeploymentGroupName; 525 /** 526 * 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 the deployment group. The predefined deployment configurations include the following: CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail. CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails. CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time. For deployment groups that contain more than one instance: The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration. The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails. In an example using nine instances, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instances is successful; the overall deployment fails if deployment to any of the first eight instances fails. For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful 527 */ 528 deploymentConfigName?: DeploymentConfigName; 529 /** 530 * The Amazon EC2 tags on which to filter. 531 */ 532 ec2TagFilters?: EC2TagFilterList; 533 /** 534 * The on-premises instance tags on which to filter. 535 */ 536 onPremisesInstanceTagFilters?: TagFilterList; 537 /** 538 * A list of associated Auto Scaling groups. 539 */ 540 autoScalingGroups?: AutoScalingGroupNameList; 541 /** 542 * A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services. 543 */ 544 serviceRoleArn: Role; 545 /** 546 * 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. 547 */ 548 triggerConfigurations?: TriggerConfigList; 549 /** 550 * Information to add about Amazon CloudWatch alarms when the deployment group is created. 551 */ 552 alarmConfiguration?: AlarmConfiguration; 553 /** 554 * Configuration information for an automatic rollback that is added when a deployment group is created. 555 */ 556 autoRollbackConfiguration?: AutoRollbackConfiguration; 557 } 558 export interface CreateDeploymentGroupOutput { 559 /** 560 * A unique deployment group ID. 561 */ 562 deploymentGroupId?: DeploymentGroupId; 563 } 564 export interface CreateDeploymentInput { 565 /** 566 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 567 */ 568 applicationName: ApplicationName; 569 /** 570 * The name of the deployment group. 571 */ 572 deploymentGroupName?: DeploymentGroupName; 573 /** 574 * The type and location of the revision to deploy. 575 */ 576 revision?: RevisionLocation; 577 /** 578 * The name of a deployment configuration associated with the applicable IAM user or AWS account. If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default. 579 */ 580 deploymentConfigName?: DeploymentConfigName; 581 /** 582 * A comment about the deployment. 583 */ 584 description?: Description; 585 /** 586 * If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event. If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed. 587 */ 588 ignoreApplicationStopFailures?: Boolean; 589 /** 590 * Configuration information for an automatic rollback that is added when a deployment is created. 591 */ 592 autoRollbackConfiguration?: AutoRollbackConfiguration; 593 /** 594 * Indicates whether to deploy to all instances or only to instances that are not running the latest application revision. 595 */ 596 updateOutdatedInstancesOnly?: Boolean; 597 } 598 export interface CreateDeploymentOutput { 599 /** 600 * A unique deployment ID. 601 */ 602 deploymentId?: DeploymentId; 603 } 604 export interface DeleteApplicationInput { 605 /** 606 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 607 */ 608 applicationName: ApplicationName; 609 } 610 export interface DeleteDeploymentConfigInput { 611 /** 612 * The name of a deployment configuration associated with the applicable IAM user or AWS account. 613 */ 614 deploymentConfigName: DeploymentConfigName; 615 } 616 export interface DeleteDeploymentGroupInput { 617 /** 618 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 619 */ 620 applicationName: ApplicationName; 621 /** 622 * The name of an existing deployment group for the specified application. 623 */ 624 deploymentGroupName: DeploymentGroupName; 625 } 626 export interface DeleteDeploymentGroupOutput { 627 /** 628 * 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. 629 */ 630 hooksNotCleanedUp?: AutoScalingGroupList; 631 } 632 export type DeploymentConfigId = string; 633 export interface DeploymentConfigInfo { 634 /** 635 * The deployment configuration ID. 636 */ 637 deploymentConfigId?: DeploymentConfigId; 638 /** 639 * The deployment configuration name. 640 */ 641 deploymentConfigName?: DeploymentConfigName; 642 /** 643 * Information about the number or percentage of minimum healthy instance. 644 */ 645 minimumHealthyHosts?: MinimumHealthyHosts; 646 /** 647 * The time at which the deployment configuration was created. 648 */ 649 createTime?: Timestamp; 650 } 651 export type DeploymentConfigName = string; 652 export type DeploymentConfigsList = DeploymentConfigName[]; 653 export type DeploymentCreator = "user"|"autoscaling"|"codeDeployRollback"|string; 654 export type DeploymentGroupId = string; 655 export interface DeploymentGroupInfo { 656 /** 657 * The application name. 658 */ 659 applicationName?: ApplicationName; 660 /** 661 * The deployment group ID. 662 */ 663 deploymentGroupId?: DeploymentGroupId; 664 /** 665 * The deployment group name. 666 */ 667 deploymentGroupName?: DeploymentGroupName; 668 /** 669 * The deployment configuration name. 670 */ 671 deploymentConfigName?: DeploymentConfigName; 672 /** 673 * The Amazon EC2 tags on which to filter. 674 */ 675 ec2TagFilters?: EC2TagFilterList; 676 /** 677 * The on-premises instance tags on which to filter. 678 */ 679 onPremisesInstanceTagFilters?: TagFilterList; 680 /** 681 * A list of associated Auto Scaling groups. 682 */ 683 autoScalingGroups?: AutoScalingGroupList; 684 /** 685 * A service role ARN. 686 */ 687 serviceRoleArn?: Role; 688 /** 689 * Information about the deployment group's target revision, including type and location. 690 */ 691 targetRevision?: RevisionLocation; 692 /** 693 * Information about triggers associated with the deployment group. 694 */ 695 triggerConfigurations?: TriggerConfigList; 696 /** 697 * A list of alarms associated with the deployment group. 698 */ 699 alarmConfiguration?: AlarmConfiguration; 700 /** 701 * Information about the automatic rollback configuration associated with the deployment group. 702 */ 703 autoRollbackConfiguration?: AutoRollbackConfiguration; 704 } 705 export type DeploymentGroupInfoList = DeploymentGroupInfo[]; 706 export type DeploymentGroupName = string; 707 export type DeploymentGroupsList = DeploymentGroupName[]; 708 export type DeploymentId = string; 709 export interface DeploymentInfo { 710 /** 711 * The application name. 712 */ 713 applicationName?: ApplicationName; 714 /** 715 * The deployment group name. 716 */ 717 deploymentGroupName?: DeploymentGroupName; 718 /** 719 * The deployment configuration name. 720 */ 721 deploymentConfigName?: DeploymentConfigName; 722 /** 723 * The deployment ID. 724 */ 725 deploymentId?: DeploymentId; 726 /** 727 * Information about the location of stored application artifacts and the service from which to retrieve them. 728 */ 729 revision?: RevisionLocation; 730 /** 731 * The current state of the deployment as a whole. 732 */ 733 status?: DeploymentStatus; 734 /** 735 * Information about any error associated with this deployment. 736 */ 737 errorInformation?: ErrorInformation; 738 /** 739 * A timestamp indicating when the deployment was created. 740 */ 741 createTime?: Timestamp; 742 /** 743 * A timestamp indicating when the deployment was deployed to the deployment group. In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process. 744 */ 745 startTime?: Timestamp; 746 /** 747 * A timestamp indicating when the deployment was complete. 748 */ 749 completeTime?: Timestamp; 750 /** 751 * A summary of the deployment status of the instances in the deployment. 752 */ 753 deploymentOverview?: DeploymentOverview; 754 /** 755 * A comment about the deployment. 756 */ 757 description?: Description; 758 /** 759 * The means by which the deployment was created: user: A user created the deployment. autoscaling: Auto Scaling created the deployment. codeDeployRollback: A rollback process created the deployment. 760 */ 761 creator?: DeploymentCreator; 762 /** 763 * If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event. If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed. 764 */ 765 ignoreApplicationStopFailures?: Boolean; 766 /** 767 * Information about the automatic rollback configuration associated with the deployment. 768 */ 769 autoRollbackConfiguration?: AutoRollbackConfiguration; 770 /** 771 * Indicates whether only instances that are not running the latest application revision are to be deployed to. 772 */ 773 updateOutdatedInstancesOnly?: Boolean; 774 /** 775 * Information about a deployment rollback. 776 */ 777 rollbackInfo?: RollbackInfo; 778 } 779 export interface DeploymentOverview { 780 /** 781 * The number of instances in the deployment in a pending state. 782 */ 783 Pending?: InstanceCount; 784 /** 785 * The number of instances in which the deployment is in progress. 786 */ 787 InProgress?: InstanceCount; 788 /** 789 * The number of instances in the deployment to which revisions have been successfully deployed. 790 */ 791 Succeeded?: InstanceCount; 792 /** 793 * The number of instances in the deployment in a failed state. 794 */ 795 Failed?: InstanceCount; 796 /** 797 * The number of instances in the deployment in a skipped state. 798 */ 799 Skipped?: InstanceCount; 800 } 801 export type DeploymentStatus = "Created"|"Queued"|"InProgress"|"Succeeded"|"Failed"|"Stopped"|string; 802 export type DeploymentStatusList = DeploymentStatus[]; 803 export type DeploymentsInfoList = DeploymentInfo[]; 804 export type DeploymentsList = DeploymentId[]; 805 export interface DeregisterOnPremisesInstanceInput { 806 /** 807 * The name of the on-premises instance to deregister. 808 */ 809 instanceName: InstanceName; 810 } 811 export type Description = string; 812 export interface Diagnostics { 813 /** 814 * 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. 815 */ 816 errorCode?: LifecycleErrorCode; 817 /** 818 * The name of the script. 819 */ 820 scriptName?: ScriptName; 821 /** 822 * The message associated with the error. 823 */ 824 message?: LifecycleMessage; 825 /** 826 * The last portion of the diagnostic log. If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log. 827 */ 828 logTail?: LogTail; 829 } 830 export interface EC2TagFilter { 831 /** 832 * The tag filter key. 833 */ 834 Key?: Key; 835 /** 836 * The tag filter value. 837 */ 838 Value?: Value; 839 /** 840 * The tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value. 841 */ 842 Type?: EC2TagFilterType; 843 } 844 export type EC2TagFilterList = EC2TagFilter[]; 845 export type EC2TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string; 846 export type ETag = string; 847 export type ErrorCode = "DEPLOYMENT_GROUP_MISSING"|"APPLICATION_MISSING"|"REVISION_MISSING"|"IAM_ROLE_MISSING"|"IAM_ROLE_PERMISSIONS"|"NO_EC2_SUBSCRIPTION"|"OVER_MAX_INSTANCES"|"NO_INSTANCES"|"TIMEOUT"|"HEALTH_CONSTRAINTS_INVALID"|"HEALTH_CONSTRAINTS"|"INTERNAL_ERROR"|"THROTTLED"|"ALARM_ACTIVE"|"AGENT_ISSUE"|"AUTO_SCALING_IAM_ROLE_PERMISSIONS"|"AUTO_SCALING_CONFIGURATION"|"MANUAL_STOP"|string; 848 export interface ErrorInformation { 849 /** 850 * The error code: APPLICATION_MISSING: The application was missing. This error code will most likely be 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 will most likely be 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 the Amazon EC2 service. NO_INSTANCES: No instance were specified, or no instance can be found. OVER_MAX_INSTANCES: The maximum number of instance 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 will most likely be raised if the revision is deleted after the deployment is created but before it is started. 851 */ 852 code?: ErrorCode; 853 /** 854 * An accompanying error message. 855 */ 856 message?: ErrorMessage; 857 } 858 export type ErrorMessage = string; 859 export interface GenericRevisionInfo { 860 /** 861 * A comment about the revision. 862 */ 863 description?: Description; 864 /** 865 * The deployment groups for which this is the current target revision. 866 */ 867 deploymentGroups?: DeploymentGroupsList; 868 /** 869 * When the revision was first used by AWS CodeDeploy. 870 */ 871 firstUsedTime?: Timestamp; 872 /** 873 * When the revision was last used by AWS CodeDeploy. 874 */ 875 lastUsedTime?: Timestamp; 876 /** 877 * When the revision was registered with AWS CodeDeploy. 878 */ 879 registerTime?: Timestamp; 880 } 881 export interface GetApplicationInput { 882 /** 883 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 884 */ 885 applicationName: ApplicationName; 886 } 887 export interface GetApplicationOutput { 888 /** 889 * Information about the application. 890 */ 891 application?: ApplicationInfo; 892 } 893 export interface GetApplicationRevisionInput { 894 /** 895 * The name of the application that corresponds to the revision. 896 */ 897 applicationName: ApplicationName; 898 /** 899 * Information about the application revision to get, including type and location. 900 */ 901 revision: RevisionLocation; 902 } 903 export interface GetApplicationRevisionOutput { 904 /** 905 * The name of the application that corresponds to the revision. 906 */ 907 applicationName?: ApplicationName; 908 /** 909 * Additional information about the revision, including type and location. 910 */ 911 revision?: RevisionLocation; 912 /** 913 * General information about the revision. 914 */ 915 revisionInfo?: GenericRevisionInfo; 916 } 917 export interface GetDeploymentConfigInput { 918 /** 919 * The name of a deployment configuration associated with the applicable IAM user or AWS account. 920 */ 921 deploymentConfigName: DeploymentConfigName; 922 } 923 export interface GetDeploymentConfigOutput { 924 /** 925 * Information about the deployment configuration. 926 */ 927 deploymentConfigInfo?: DeploymentConfigInfo; 928 } 929 export interface GetDeploymentGroupInput { 930 /** 931 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 932 */ 933 applicationName: ApplicationName; 934 /** 935 * The name of an existing deployment group for the specified application. 936 */ 937 deploymentGroupName: DeploymentGroupName; 938 } 939 export interface GetDeploymentGroupOutput { 940 /** 941 * Information about the deployment group. 942 */ 943 deploymentGroupInfo?: DeploymentGroupInfo; 944 } 945 export interface GetDeploymentInput { 946 /** 947 * A deployment ID associated with the applicable IAM user or AWS account. 948 */ 949 deploymentId: DeploymentId; 950 } 951 export interface GetDeploymentInstanceInput { 952 /** 953 * The unique ID of a deployment. 954 */ 955 deploymentId: DeploymentId; 956 /** 957 * The unique ID of an instance in the deployment group. 958 */ 959 instanceId: InstanceId; 960 } 961 export interface GetDeploymentInstanceOutput { 962 /** 963 * Information about the instance. 964 */ 965 instanceSummary?: InstanceSummary; 966 } 967 export interface GetDeploymentOutput { 968 /** 969 * Information about the deployment. 970 */ 971 deploymentInfo?: DeploymentInfo; 972 } 973 export interface GetOnPremisesInstanceInput { 974 /** 975 * The name of the on-premises instance about which to get information. 976 */ 977 instanceName: InstanceName; 978 } 979 export interface GetOnPremisesInstanceOutput { 980 /** 981 * Information about the on-premises instance. 982 */ 983 instanceInfo?: InstanceInfo; 984 } 985 export interface GitHubLocation { 986 /** 987 * 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. 988 */ 989 repository?: Repository; 990 /** 991 * The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision. 992 */ 993 commitId?: CommitId; 994 } 995 export type IamUserArn = string; 996 export type InstanceArn = string; 997 export type InstanceCount = number; 998 export type InstanceId = string; 999 export interface InstanceInfo { 1000 /** 1001 * The name of the on-premises instance. 1002 */ 1003 instanceName?: InstanceName; 1004 /** 1005 * The IAM user ARN associated with the on-premises instance. 1006 */ 1007 iamUserArn?: IamUserArn; 1008 /** 1009 * The ARN of the on-premises instance. 1010 */ 1011 instanceArn?: InstanceArn; 1012 /** 1013 * The time at which the on-premises instance was registered. 1014 */ 1015 registerTime?: Timestamp; 1016 /** 1017 * If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered. 1018 */ 1019 deregisterTime?: Timestamp; 1020 /** 1021 * The tags currently associated with the on-premises instance. 1022 */ 1023 tags?: TagList; 1024 } 1025 export type InstanceInfoList = InstanceInfo[]; 1026 export type InstanceName = string; 1027 export type InstanceNameList = InstanceName[]; 1028 export type InstanceStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|string; 1029 export type InstanceStatusList = InstanceStatus[]; 1030 export interface InstanceSummary { 1031 /** 1032 * The deployment ID. 1033 */ 1034 deploymentId?: DeploymentId; 1035 /** 1036 * The instance ID. 1037 */ 1038 instanceId?: InstanceId; 1039 /** 1040 * 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. 1041 */ 1042 status?: InstanceStatus; 1043 /** 1044 * A timestamp indicating when the instance information was last updated. 1045 */ 1046 lastUpdatedAt?: Timestamp; 1047 /** 1048 * A list of lifecycle events for this instance. 1049 */ 1050 lifecycleEvents?: LifecycleEventList; 1051 } 1052 export type InstanceSummaryList = InstanceSummary[]; 1053 export type InstancesList = InstanceId[]; 1054 export type Key = string; 1055 export type LifecycleErrorCode = "Success"|"ScriptMissing"|"ScriptNotExecutable"|"ScriptTimedOut"|"ScriptFailed"|"UnknownError"|string; 1056 export interface LifecycleEvent { 1057 /** 1058 * The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService. 1059 */ 1060 lifecycleEventName?: LifecycleEventName; 1061 /** 1062 * Diagnostic information about the deployment lifecycle event. 1063 */ 1064 diagnostics?: Diagnostics; 1065 /** 1066 * A timestamp indicating when the deployment lifecycle event started. 1067 */ 1068 startTime?: Timestamp; 1069 /** 1070 * A timestamp indicating when the deployment lifecycle event ended. 1071 */ 1072 endTime?: Timestamp; 1073 /** 1074 * 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. 1075 */ 1076 status?: LifecycleEventStatus; 1077 } 1078 export type LifecycleEventList = LifecycleEvent[]; 1079 export type LifecycleEventName = string; 1080 export type LifecycleEventStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|string; 1081 export type LifecycleMessage = string; 1082 export interface ListApplicationRevisionsInput { 1083 /** 1084 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 1085 */ 1086 applicationName: ApplicationName; 1087 /** 1088 * 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 will be returned in an arbitrary order. 1089 */ 1090 sortBy?: ApplicationRevisionSortBy; 1091 /** 1092 * The order in which to sort the list results: ascending: ascending order. descending: descending order. If not specified, the results will be sorted in ascending order. If set to null, the results will be sorted in an arbitrary order. 1093 */ 1094 sortOrder?: SortOrder; 1095 /** 1096 * An Amazon S3 bucket name to limit the search for revisions. If set to null, all of the user's buckets will be searched. 1097 */ 1098 s3Bucket?: S3Bucket; 1099 /** 1100 * A key prefix for the set of Amazon S3 objects to limit the search for revisions. 1101 */ 1102 s3KeyPrefix?: S3Key; 1103 /** 1104 * 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. 1105 */ 1106 deployed?: ListStateFilterAction; 1107 /** 1108 * An identifier returned from the previous list application revisions call. It can be used to return the next set of applications in the list. 1109 */ 1110 nextToken?: NextToken; 1111 } 1112 export interface ListApplicationRevisionsOutput { 1113 /** 1114 * A list of locations that contain the matching revisions. 1115 */ 1116 revisions?: RevisionLocationList; 1117 /** 1118 * If a large amount of information is returned, an identifier will also be returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list. 1119 */ 1120 nextToken?: NextToken; 1121 } 1122 export interface ListApplicationsInput { 1123 /** 1124 * An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list. 1125 */ 1126 nextToken?: NextToken; 1127 } 1128 export interface ListApplicationsOutput { 1129 /** 1130 * A list of application names. 1131 */ 1132 applications?: ApplicationsList; 1133 /** 1134 * 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, will also be returned. in the list. 1135 */ 1136 nextToken?: NextToken; 1137 } 1138 export interface ListDeploymentConfigsInput { 1139 /** 1140 * An identifier returned from the previous list deployment configurations call. It can be used to return the next set of deployment configurations in the list. 1141 */ 1142 nextToken?: NextToken; 1143 } 1144 export interface ListDeploymentConfigsOutput { 1145 /** 1146 * A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime. 1147 */ 1148 deploymentConfigsList?: DeploymentConfigsList; 1149 /** 1150 * 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. 1151 */ 1152 nextToken?: NextToken; 1153 } 1154 export interface ListDeploymentGroupsInput { 1155 /** 1156 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 1157 */ 1158 applicationName: ApplicationName; 1159 /** 1160 * 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. 1161 */ 1162 nextToken?: NextToken; 1163 } 1164 export interface ListDeploymentGroupsOutput { 1165 /** 1166 * The application name. 1167 */ 1168 applicationName?: ApplicationName; 1169 /** 1170 * A list of corresponding deployment group names. 1171 */ 1172 deploymentGroups?: DeploymentGroupsList; 1173 /** 1174 * 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. 1175 */ 1176 nextToken?: NextToken; 1177 } 1178 export interface ListDeploymentInstancesInput { 1179 /** 1180 * The unique ID of a deployment. 1181 */ 1182 deploymentId: DeploymentId; 1183 /** 1184 * 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. 1185 */ 1186 nextToken?: NextToken; 1187 /** 1188 * A subset of instances to list by status: Pending: Include those instance with pending deployments. InProgress: Include those instance where deployments are still in progress. Succeeded: Include those instances with successful deployments. Failed: Include those instance with failed deployments. Skipped: Include those instance with skipped deployments. Unknown: Include those instance with deployments in an unknown state. 1189 */ 1190 instanceStatusFilter?: InstanceStatusList; 1191 } 1192 export interface ListDeploymentInstancesOutput { 1193 /** 1194 * A list of instance IDs. 1195 */ 1196 instancesList?: InstancesList; 1197 /** 1198 * 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. 1199 */ 1200 nextToken?: NextToken; 1201 } 1202 export interface ListDeploymentsInput { 1203 /** 1204 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 1205 */ 1206 applicationName?: ApplicationName; 1207 /** 1208 * The name of an existing deployment group for the specified application. 1209 */ 1210 deploymentGroupName?: DeploymentGroupName; 1211 /** 1212 * 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. 1213 */ 1214 includeOnlyStatuses?: DeploymentStatusList; 1215 /** 1216 * A time range (start and end) for returning a subset of the list of deployments. 1217 */ 1218 createTimeRange?: TimeRange; 1219 /** 1220 * An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list. 1221 */ 1222 nextToken?: NextToken; 1223 } 1224 export interface ListDeploymentsOutput { 1225 /** 1226 * A list of deployment IDs. 1227 */ 1228 deployments?: DeploymentsList; 1229 /** 1230 * 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. 1231 */ 1232 nextToken?: NextToken; 1233 } 1234 export interface ListOnPremisesInstancesInput { 1235 /** 1236 * 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. 1237 */ 1238 registrationStatus?: RegistrationStatus; 1239 /** 1240 * The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned. 1241 */ 1242 tagFilters?: TagFilterList; 1243 /** 1244 * 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. 1245 */ 1246 nextToken?: NextToken; 1247 } 1248 export interface ListOnPremisesInstancesOutput { 1249 /** 1250 * The list of matching on-premises instance names. 1251 */ 1252 instanceNames?: InstanceNameList; 1253 /** 1254 * 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. 1255 */ 1256 nextToken?: NextToken; 1257 } 1258 export type ListStateFilterAction = "include"|"exclude"|"ignore"|string; 1259 export type LogTail = string; 1260 export type Message = string; 1261 export interface MinimumHealthyHosts { 1262 /** 1263 * The minimum healthy instance value. 1264 */ 1265 value?: MinimumHealthyHostsValue; 1266 /** 1267 * 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 will be 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 will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails. In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return 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 will try 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 still succeeds. 1268 */ 1269 type?: MinimumHealthyHostsType; 1270 } 1271 export type MinimumHealthyHostsType = "HOST_COUNT"|"FLEET_PERCENT"|string; 1272 export type MinimumHealthyHostsValue = number; 1273 export type NextToken = string; 1274 export type NullableBoolean = boolean; 1275 export interface RegisterApplicationRevisionInput { 1276 /** 1277 * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. 1278 */ 1279 applicationName: ApplicationName; 1280 /** 1281 * A comment about the revision. 1282 */ 1283 description?: Description; 1284 /** 1285 * Information about the application revision to register, including type and location. 1286 */ 1287 revision: RevisionLocation; 1288 } 1289 export interface RegisterOnPremisesInstanceInput { 1290 /** 1291 * The name of the on-premises instance to register. 1292 */ 1293 instanceName: InstanceName; 1294 /** 1295 * The ARN of the IAM user to associate with the on-premises instance. 1296 */ 1297 iamUserArn: IamUserArn; 1298 } 1299 export type RegistrationStatus = "Registered"|"Deregistered"|string; 1300 export interface RemoveTagsFromOnPremisesInstancesInput { 1301 /** 1302 * The tag key-value pairs to remove from the on-premises instances. 1303 */ 1304 tags: TagList; 1305 /** 1306 * The names of the on-premises instances from which to remove tags. 1307 */ 1308 instanceNames: InstanceNameList; 1309 } 1310 export type Repository = string; 1311 export interface RevisionInfo { 1312 revisionLocation?: RevisionLocation; 1313 genericRevisionInfo?: GenericRevisionInfo; 1314 } 1315 export type RevisionInfoList = RevisionInfo[]; 1316 export interface RevisionLocation { 1317 /** 1318 * The type of application revision: S3: An application revision stored in Amazon S3. GitHub: An application revision stored in GitHub. 1319 */ 1320 revisionType?: RevisionLocationType; 1321 s3Location?: S3Location; 1322 gitHubLocation?: GitHubLocation; 1323 } 1324 export type RevisionLocationList = RevisionLocation[]; 1325 export type RevisionLocationType = "S3"|"GitHub"|string; 1326 export type Role = string; 1327 export interface RollbackInfo { 1328 /** 1329 * The ID of the deployment rollback. 1330 */ 1331 rollbackDeploymentId?: DeploymentId; 1332 /** 1333 * The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped. 1334 */ 1335 rollbackTriggeringDeploymentId?: DeploymentId; 1336 /** 1337 * Information describing the status of a deployment rollback; for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded. 1338 */ 1339 rollbackMessage?: Description; 1340 } 1341 export type S3Bucket = string; 1342 export type S3Key = string; 1343 export interface S3Location { 1344 /** 1345 * The name of the Amazon S3 bucket where the application revision is stored. 1346 */ 1347 bucket?: S3Bucket; 1348 /** 1349 * The name of the Amazon S3 object that represents the bundled artifacts for the application revision. 1350 */ 1351 key?: S3Key; 1352 /** 1353 * 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. 1354 */ 1355 bundleType?: BundleType; 1356 /** 1357 * 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 will use the most recent version by default. 1358 */ 1359 version?: VersionId; 1360 /** 1361 * 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 will be skipped. 1362 */ 1363 eTag?: ETag; 1364 } 1365 export type ScriptName = string; 1366 export type SortOrder = "ascending"|"descending"|string; 1367 export interface StopDeploymentInput { 1368 /** 1369 * The unique ID of a deployment. 1370 */ 1371 deploymentId: DeploymentId; 1372 /** 1373 * Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision. 1374 */ 1375 autoRollbackEnabled?: NullableBoolean; 1376 } 1377 export interface StopDeploymentOutput { 1378 /** 1379 * The status of the stop deployment operation: Pending: The stop operation is pending. Succeeded: The stop operation was successful. 1380 */ 1381 status?: StopStatus; 1382 /** 1383 * An accompanying status message. 1384 */ 1385 statusMessage?: Message; 1386 } 1387 export type StopStatus = "Pending"|"Succeeded"|string; 1388 export interface Tag { 1389 /** 1390 * The tag's key. 1391 */ 1392 Key?: Key; 1393 /** 1394 * The tag's value. 1395 */ 1396 Value?: Value; 1397 } 1398 export interface TagFilter { 1399 /** 1400 * The on-premises instance tag filter key. 1401 */ 1402 Key?: Key; 1403 /** 1404 * The on-premises instance tag filter value. 1405 */ 1406 Value?: Value; 1407 /** 1408 * The on-premises instance tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value. 1409 */ 1410 Type?: TagFilterType; 1411 } 1412 export type TagFilterList = TagFilter[]; 1413 export type TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string; 1414 export type TagList = Tag[]; 1415 export interface TimeRange { 1416 /** 1417 * The start time of the time range. Specify null to leave the start time open-ended. 1418 */ 1419 start?: Timestamp; 1420 /** 1421 * The end time of the time range. Specify null to leave the end time open-ended. 1422 */ 1423 end?: Timestamp; 1424 } 1425 export type Timestamp = Date; 1426 export interface TriggerConfig { 1427 /** 1428 * The name of the notification trigger. 1429 */ 1430 triggerName?: TriggerName; 1431 /** 1432 * The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent. 1433 */ 1434 triggerTargetArn?: TriggerTargetArn; 1435 /** 1436 * The event type or types for which notifications are triggered. 1437 */ 1438 triggerEvents?: TriggerEventTypeList; 1439 } 1440 export type TriggerConfigList = TriggerConfig[]; 1441 export type TriggerEventType = "DeploymentStart"|"DeploymentSuccess"|"DeploymentFailure"|"DeploymentStop"|"DeploymentRollback"|"InstanceStart"|"InstanceSuccess"|"InstanceFailure"|string; 1442 export type TriggerEventTypeList = TriggerEventType[]; 1443 export type TriggerName = string; 1444 export type TriggerTargetArn = string; 1445 export interface UpdateApplicationInput { 1446 /** 1447 * The current name of the application you want to change. 1448 */ 1449 applicationName?: ApplicationName; 1450 /** 1451 * The new name to give the application. 1452 */ 1453 newApplicationName?: ApplicationName; 1454 } 1455 export interface UpdateDeploymentGroupInput { 1456 /** 1457 * The application name corresponding to the deployment group to update. 1458 */ 1459 applicationName: ApplicationName; 1460 /** 1461 * The current name of the deployment group. 1462 */ 1463 currentDeploymentGroupName: DeploymentGroupName; 1464 /** 1465 * The new name of the deployment group, if you want to change it. 1466 */ 1467 newDeploymentGroupName?: DeploymentGroupName; 1468 /** 1469 * The replacement deployment configuration name to use, if you want to change it. 1470 */ 1471 deploymentConfigName?: DeploymentConfigName; 1472 /** 1473 * 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. 1474 */ 1475 ec2TagFilters?: EC2TagFilterList; 1476 /** 1477 * 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. 1478 */ 1479 onPremisesInstanceTagFilters?: TagFilterList; 1480 /** 1481 * 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. 1482 */ 1483 autoScalingGroups?: AutoScalingGroupNameList; 1484 /** 1485 * A replacement ARN for the service role, if you want to change it. 1486 */ 1487 serviceRoleArn?: Role; 1488 /** 1489 * 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. 1490 */ 1491 triggerConfigurations?: TriggerConfigList; 1492 /** 1493 * Information to add or change about Amazon CloudWatch alarms when the deployment group is updated. 1494 */ 1495 alarmConfiguration?: AlarmConfiguration; 1496 /** 1497 * Information for an automatic rollback configuration that is added or changed when a deployment group is updated. 1498 */ 1499 autoRollbackConfiguration?: AutoRollbackConfiguration; 1500 } 1501 export interface UpdateDeploymentGroupOutput { 1502 /** 1503 * 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. 1504 */ 1505 hooksNotCleanedUp?: AutoScalingGroupList; 1506 } 1507 export type Value = string; 1508 export type VersionId = string; 1509 /** 1510 * 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. 1511 */ 1512 export type apiVersion = "2014-10-06"|"latest"|string; 1513 export interface ClientApiVersions { 1514 /** 1515 * 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. 1516 */ 1517 apiVersion?: apiVersion; 1518 } 1519 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1520 } 1521 export = CodeDeploy;