universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
790 lines • 122 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class CodeDeploy extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodeDeploy.Types.ClientConfiguration)
config: Config & CodeDeploy.Types.ClientConfiguration;
/**
* Adds tags to on-premises instances.
*/
addTagsToOnPremisesInstances(params: CodeDeploy.Types.AddTagsToOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to on-premises instances.
*/
addTagsToOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
*/
batchGetApplicationRevisions(params: CodeDeploy.Types.BatchGetApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>;
/**
* Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
*/
batchGetApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationRevisionsOutput, AWSError>;
/**
* Gets information about one or more applications. The maximum number of applications that can be returned is 25.
*/
batchGetApplications(params: CodeDeploy.Types.BatchGetApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>;
/**
* Gets information about one or more applications. The maximum number of applications that can be returned is 25.
*/
batchGetApplications(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request<CodeDeploy.Types.BatchGetApplicationsOutput, AWSError>;
/**
* Gets information about one or more deployment groups.
*/
batchGetDeploymentGroups(params: CodeDeploy.Types.BatchGetDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>;
/**
* Gets information about one or more deployment groups.
*/
batchGetDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentGroupsOutput, AWSError>;
/**
* 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.
*/
batchGetDeploymentInstances(params: CodeDeploy.Types.BatchGetDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>;
/**
* 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.
*/
batchGetDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentInstancesOutput, AWSError>;
/**
* 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.
*/
batchGetDeploymentTargets(params: CodeDeploy.Types.BatchGetDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentTargetsOutput, AWSError>;
/**
* 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.
*/
batchGetDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentTargetsOutput, AWSError>;
/**
* Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
*/
batchGetDeployments(params: CodeDeploy.Types.BatchGetDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>;
/**
* Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
*/
batchGetDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request<CodeDeploy.Types.BatchGetDeploymentsOutput, AWSError>;
/**
* Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
*/
batchGetOnPremisesInstances(params: CodeDeploy.Types.BatchGetOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>;
/**
* Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
*/
batchGetOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.BatchGetOnPremisesInstancesOutput, AWSError>;
/**
* 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.)
*/
continueDeployment(params: CodeDeploy.Types.ContinueDeploymentInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.)
*/
continueDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an application.
*/
createApplication(params: CodeDeploy.Types.CreateApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>;
/**
* Creates an application.
*/
createApplication(callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request<CodeDeploy.Types.CreateApplicationOutput, AWSError>;
/**
* Deploys an application revision through the specified deployment group.
*/
createDeployment(params: CodeDeploy.Types.CreateDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>;
/**
* Deploys an application revision through the specified deployment group.
*/
createDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request<CodeDeploy.Types.CreateDeploymentOutput, AWSError>;
/**
* Creates a deployment configuration.
*/
createDeploymentConfig(params: CodeDeploy.Types.CreateDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>;
/**
* Creates a deployment configuration.
*/
createDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request<CodeDeploy.Types.CreateDeploymentConfigOutput, AWSError>;
/**
* Creates a deployment group to which application revisions are deployed.
*/
createDeploymentGroup(params: CodeDeploy.Types.CreateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>;
/**
* Creates a deployment group to which application revisions are deployed.
*/
createDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.CreateDeploymentGroupOutput, AWSError>;
/**
* Deletes an application.
*/
deleteApplication(params: CodeDeploy.Types.DeleteApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an application.
*/
deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
*/
deleteDeploymentConfig(params: CodeDeploy.Types.DeleteDeploymentConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
*/
deleteDeploymentConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a deployment group.
*/
deleteDeploymentGroup(params: CodeDeploy.Types.DeleteDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>;
/**
* Deletes a deployment group.
*/
deleteDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request<CodeDeploy.Types.DeleteDeploymentGroupOutput, AWSError>;
/**
* Deletes a GitHub account connection.
*/
deleteGitHubAccountToken(params: CodeDeploy.Types.DeleteGitHubAccountTokenInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request<CodeDeploy.Types.DeleteGitHubAccountTokenOutput, AWSError>;
/**
* Deletes a GitHub account connection.
*/
deleteGitHubAccountToken(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request<CodeDeploy.Types.DeleteGitHubAccountTokenOutput, AWSError>;
/**
* Deregisters an on-premises instance.
*/
deregisterOnPremisesInstance(params: CodeDeploy.Types.DeregisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deregisters an on-premises instance.
*/
deregisterOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets information about an application.
*/
getApplication(params: CodeDeploy.Types.GetApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>;
/**
* Gets information about an application.
*/
getApplication(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request<CodeDeploy.Types.GetApplicationOutput, AWSError>;
/**
* Gets information about an application revision.
*/
getApplicationRevision(params: CodeDeploy.Types.GetApplicationRevisionInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>;
/**
* Gets information about an application revision.
*/
getApplicationRevision(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request<CodeDeploy.Types.GetApplicationRevisionOutput, AWSError>;
/**
* 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.
*/
getDeployment(params: CodeDeploy.Types.GetDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
/**
* 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.
*/
getDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
/**
* Gets information about a deployment configuration.
*/
getDeploymentConfig(params: CodeDeploy.Types.GetDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>;
/**
* Gets information about a deployment configuration.
*/
getDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request<CodeDeploy.Types.GetDeploymentConfigOutput, AWSError>;
/**
* Gets information about a deployment group.
*/
getDeploymentGroup(params: CodeDeploy.Types.GetDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>;
/**
* Gets information about a deployment group.
*/
getDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request<CodeDeploy.Types.GetDeploymentGroupOutput, AWSError>;
/**
* Gets information about an instance as part of a deployment.
*/
getDeploymentInstance(params: CodeDeploy.Types.GetDeploymentInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>;
/**
* Gets information about an instance as part of a deployment.
*/
getDeploymentInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request<CodeDeploy.Types.GetDeploymentInstanceOutput, AWSError>;
/**
* Returns information about a deployment target.
*/
getDeploymentTarget(params: CodeDeploy.Types.GetDeploymentTargetInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request<CodeDeploy.Types.GetDeploymentTargetOutput, AWSError>;
/**
* Returns information about a deployment target.
*/
getDeploymentTarget(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request<CodeDeploy.Types.GetDeploymentTargetOutput, AWSError>;
/**
* Gets information about an on-premises instance.
*/
getOnPremisesInstance(params: CodeDeploy.Types.GetOnPremisesInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>;
/**
* Gets information about an on-premises instance.
*/
getOnPremisesInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request<CodeDeploy.Types.GetOnPremisesInstanceOutput, AWSError>;
/**
* Lists information about revisions for an application.
*/
listApplicationRevisions(params: CodeDeploy.Types.ListApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>;
/**
* Lists information about revisions for an application.
*/
listApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request<CodeDeploy.Types.ListApplicationRevisionsOutput, AWSError>;
/**
* Lists the applications registered with the IAM user or AWS account.
*/
listApplications(params: CodeDeploy.Types.ListApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>;
/**
* Lists the applications registered with the IAM user or AWS account.
*/
listApplications(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request<CodeDeploy.Types.ListApplicationsOutput, AWSError>;
/**
* Lists the deployment configurations with the IAM user or AWS account.
*/
listDeploymentConfigs(params: CodeDeploy.Types.ListDeploymentConfigsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>;
/**
* Lists the deployment configurations with the IAM user or AWS account.
*/
listDeploymentConfigs(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request<CodeDeploy.Types.ListDeploymentConfigsOutput, AWSError>;
/**
* Lists the deployment groups for an application registered with the IAM user or AWS account.
*/
listDeploymentGroups(params: CodeDeploy.Types.ListDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>;
/**
* Lists the deployment groups for an application registered with the IAM user or AWS account.
*/
listDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request<CodeDeploy.Types.ListDeploymentGroupsOutput, AWSError>;
/**
* 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.
*/
listDeploymentInstances(params: CodeDeploy.Types.ListDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>;
/**
* 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.
*/
listDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request<CodeDeploy.Types.ListDeploymentInstancesOutput, AWSError>;
/**
* Returns an array of target IDs that are associated a deployment.
*/
listDeploymentTargets(params: CodeDeploy.Types.ListDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.ListDeploymentTargetsOutput, AWSError>;
/**
* Returns an array of target IDs that are associated a deployment.
*/
listDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request<CodeDeploy.Types.ListDeploymentTargetsOutput, AWSError>;
/**
* Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.
*/
listDeployments(params: CodeDeploy.Types.ListDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>;
/**
* Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.
*/
listDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request<CodeDeploy.Types.ListDeploymentsOutput, AWSError>;
/**
* Lists the names of stored connections to GitHub accounts.
*/
listGitHubAccountTokenNames(params: CodeDeploy.Types.ListGitHubAccountTokenNamesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request<CodeDeploy.Types.ListGitHubAccountTokenNamesOutput, AWSError>;
/**
* Lists the names of stored connections to GitHub accounts.
*/
listGitHubAccountTokenNames(callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request<CodeDeploy.Types.ListGitHubAccountTokenNamesOutput, AWSError>;
/**
* 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.
*/
listOnPremisesInstances(params: CodeDeploy.Types.ListOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>;
/**
* 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.
*/
listOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request<CodeDeploy.Types.ListOnPremisesInstancesOutput, AWSError>;
/**
* Returns a list of tags for the resource identified by a specified ARN. Tags are used to organize and categorize your CodeDeploy resources.
*/
listTagsForResource(params: CodeDeploy.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListTagsForResourceOutput) => void): Request<CodeDeploy.Types.ListTagsForResourceOutput, AWSError>;
/**
* Returns a list of tags for the resource identified by a specified ARN. Tags are used to organize and categorize your CodeDeploy resources.
*/
listTagsForResource(callback?: (err: AWSError, data: CodeDeploy.Types.ListTagsForResourceOutput) => void): Request<CodeDeploy.Types.ListTagsForResourceOutput, AWSError>;
/**
* Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
*/
putLifecycleEventHookExecutionStatus(params: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusInput, callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
/**
* Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
*/
putLifecycleEventHookExecutionStatus(callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request<CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput, AWSError>;
/**
* Registers with AWS CodeDeploy a revision for the specified application.
*/
registerApplicationRevision(params: CodeDeploy.Types.RegisterApplicationRevisionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Registers with AWS CodeDeploy a revision for the specified application.
*/
registerApplicationRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
registerOnPremisesInstance(params: CodeDeploy.Types.RegisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
registerOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes one or more tags from one or more on-premises instances.
*/
removeTagsFromOnPremisesInstances(params: CodeDeploy.Types.RemoveTagsFromOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes one or more tags from one or more on-premises instances.
*/
removeTagsFromOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
*/
skipWaitTimeForInstanceTermination(params: CodeDeploy.Types.SkipWaitTimeForInstanceTerminationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
*/
skipWaitTimeForInstanceTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attempts to stop an ongoing deployment.
*/
stopDeployment(params: CodeDeploy.Types.StopDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
/**
* Attempts to stop an ongoing deployment.
*/
stopDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request<CodeDeploy.Types.StopDeploymentOutput, AWSError>;
/**
* Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.
*/
tagResource(params: CodeDeploy.Types.TagResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.TagResourceOutput) => void): Request<CodeDeploy.Types.TagResourceOutput, AWSError>;
/**
* Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.
*/
tagResource(callback?: (err: AWSError, data: CodeDeploy.Types.TagResourceOutput) => void): Request<CodeDeploy.Types.TagResourceOutput, AWSError>;
/**
* 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.
*/
untagResource(params: CodeDeploy.Types.UntagResourceInput, callback?: (err: AWSError, data: CodeDeploy.Types.UntagResourceOutput) => void): Request<CodeDeploy.Types.UntagResourceOutput, AWSError>;
/**
* 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.
*/
untagResource(callback?: (err: AWSError, data: CodeDeploy.Types.UntagResourceOutput) => void): Request<CodeDeploy.Types.UntagResourceOutput, AWSError>;
/**
* Changes the name of an application.
*/
updateApplication(params: CodeDeploy.Types.UpdateApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Changes the name of an application.
*/
updateApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Changes information about a deployment group.
*/
updateDeploymentGroup(params: CodeDeploy.Types.UpdateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
/**
* Changes information about a deployment group.
*/
updateDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request<CodeDeploy.Types.UpdateDeploymentGroupOutput, AWSError>;
/**
* Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
*/
waitFor(state: "deploymentSuccessful", params: CodeDeploy.Types.GetDeploymentInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
/**
* Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times).
*/
waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request<CodeDeploy.Types.GetDeploymentOutput, AWSError>;
}
declare namespace CodeDeploy {
export interface AddTagsToOnPremisesInstancesInput {
/**
* 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.
*/
tags: TagList;
/**
* The names of the on-premises instances to which to add tags.
*/
instanceNames: InstanceNameList;
}
export type AdditionalDeploymentStatusInfo = string;
export interface Alarm {
/**
* The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
*/
name?: AlarmName;
}
export interface AlarmConfiguration {
/**
* Indicates whether the alarm configuration is enabled.
*/
enabled?: Boolean;
/**
* 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.
*/
ignorePollAlarmFailure?: Boolean;
/**
* A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.
*/
alarms?: AlarmList;
}
export type AlarmList = Alarm[];
export type AlarmName = string;
export interface AppSpecContent {
/**
* 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.
*/
content?: RawStringContent;
/**
* The SHA256 hash value of the revision content.
*/
sha256?: RawStringSha256;
}
export type ApplicationId = string;
export interface ApplicationInfo {
/**
* The application ID.
*/
applicationId?: ApplicationId;
/**
* The application name.
*/
applicationName?: ApplicationName;
/**
* The time at which the application was created.
*/
createTime?: Timestamp;
/**
* True if the user has authenticated with GitHub for the specified application. Otherwise, false.
*/
linkedToGitHub?: Boolean;
/**
* The name for a connection to a GitHub account.
*/
gitHubAccountName?: GitHubAccountTokenName;
/**
* The destination platform type for deployment of the application (Lambda or Server).
*/
computePlatform?: ComputePlatform;
}
export type ApplicationName = string;
export type ApplicationRevisionSortBy = "registerTime"|"firstUsedTime"|"lastUsedTime"|string;
export type ApplicationsInfoList = ApplicationInfo[];
export type ApplicationsList = ApplicationName[];
export type Arn = string;
export interface AutoRollbackConfiguration {
/**
* Indicates whether a defined automatic rollback configuration is currently enabled.
*/
enabled?: Boolean;
/**
* The event type or types that trigger a rollback.
*/
events?: AutoRollbackEventsList;
}
export type AutoRollbackEvent = "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"|string;
export type AutoRollbackEventsList = AutoRollbackEvent[];
export interface AutoScalingGroup {
/**
* The Auto Scaling group name.
*/
name?: AutoScalingGroupName;
/**
* An Auto Scaling lifecycle event hook name.
*/
hook?: AutoScalingGroupHook;
}
export type AutoScalingGroupHook = string;
export type AutoScalingGroupList = AutoScalingGroup[];
export type AutoScalingGroupName = string;
export type AutoScalingGroupNameList = AutoScalingGroupName[];
export interface BatchGetApplicationRevisionsInput {
/**
* The name of an AWS CodeDeploy application about which to get revision information.
*/
applicationName: ApplicationName;
/**
* 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.
*/
revisions: RevisionLocationList;
}
export interface BatchGetApplicationRevisionsOutput {
/**
* The name of the application that corresponds to the revisions.
*/
applicationName?: ApplicationName;
/**
* Information about errors that might have occurred during the API call.
*/
errorMessage?: ErrorMessage;
/**
* Additional information about the revisions, including the type and location.
*/
revisions?: RevisionInfoList;
}
export interface BatchGetApplicationsInput {
/**
* A list of application names separated by spaces. The maximum number of application names you can specify is 25.
*/
applicationNames: ApplicationsList;
}
export interface BatchGetApplicationsOutput {
/**
* Information about the applications.
*/
applicationsInfo?: ApplicationsInfoList;
}
export interface BatchGetDeploymentGroupsInput {
/**
* The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
*/
applicationName: ApplicationName;
/**
* The names of the deployment groups.
*/
deploymentGroupNames: DeploymentGroupsList;
}
export interface BatchGetDeploymentGroupsOutput {
/**
* Information about the deployment groups.
*/
deploymentGroupsInfo?: DeploymentGroupInfoList;
/**
* Information about errors that might have occurred during the API call.
*/
errorMessage?: ErrorMessage;
}
export interface BatchGetDeploymentInstancesInput {
/**
* The unique ID of a deployment.
*/
deploymentId: DeploymentId;
/**
* The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
*/
instanceIds: InstancesList;
}
export interface BatchGetDeploymentInstancesOutput {
/**
* Information about the instance.
*/
instancesSummary?: InstanceSummaryList;
/**
* Information about errors that might have occurred during the API call.
*/
errorMessage?: ErrorMessage;
}
export interface BatchGetDeploymentTargetsInput {
/**
* The unique ID of a deployment.
*/
deploymentId?: DeploymentId;
/**
* 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 <clustername>:<servicename>. Their target type is ecsTarget.
*/
targetIds?: TargetIdList;
}
export interface BatchGetDeploymentTargetsOutput {
/**
* 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.
*/
deploymentTargets?: DeploymentTargetList;
}
export interface BatchGetDeploymentsInput {
/**
* A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
*/
deploymentIds: DeploymentsList;
}
export interface BatchGetDeploymentsOutput {
/**
* Information about the deployments.
*/
deploymentsInfo?: DeploymentsInfoList;
}
export interface BatchGetOnPremisesInstancesInput {
/**
* The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
*/
instanceNames: InstanceNameList;
}
export interface BatchGetOnPremisesInstancesOutput {
/**
* Information about the on-premises instances.
*/
instanceInfos?: InstanceInfoList;
}
export interface BlueGreenDeploymentConfiguration {
/**
* Information about whether to terminate instances in the original fleet during a blue/green deployment.
*/
terminateBlueInstancesOnDeploymentSuccess?: BlueInstanceTerminationOption;
/**
* Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
*/
deploymentReadyOption?: DeploymentReadyOption;
/**
* Information about how instances are provisioned for a replacement environment in a blue/green deployment.
*/
greenFleetProvisioningOption?: GreenFleetProvisioningOption;
}
export interface BlueInstanceTerminationOption {
/**
* 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.
*/
action?: InstanceAction;
/**
* 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).
*/
terminationWaitTimeInMinutes?: Duration;
}
export type Boolean = boolean;
export type BundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON"|string;
export type CommitId = string;
export type ComputePlatform = "Server"|"Lambda"|"ECS"|string;
export interface ContinueDeploymentInput {
/**
* The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
*/
deploymentId?: DeploymentId;
/**
* 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.
*/
deploymentWaitType?: DeploymentWaitType;
}
export interface CreateApplicationInput {
/**
* The name of the application. This name must be unique with the applicable IAM user or AWS account.
*/
applicationName: ApplicationName;
/**
* The destination platform type for the deployment (Lambda, Server, or ECS).
*/
computePlatform?: ComputePlatform;
/**
* 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.
*/
tags?: TagList;
}
export interface CreateApplicationOutput {
/**
* A unique application ID.
*/
applicationId?: ApplicationId;
}
export interface CreateDeploymentConfigInput {
/**
* The name of the deployment configuration to create.
*/
deploymentConfigName: DeploymentConfigName;
/**
* 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.
*/
minimumHealthyHosts?: MinimumHealthyHosts;
/**
* The configuration that specifies how the deployment traffic is routed.
*/
trafficRoutingConfig?: TrafficRoutingConfig;
/**
* The destination platform type for the deployment (Lambda, Server, or ECS).
*/
computePlatform?: ComputePlatform;
}
export interface CreateDeploymentConfigOutput {
/**
* A unique deployment configuration ID.
*/
deploymentConfigId?: DeploymentConfigId;
}
export interface CreateDeploymentGroupInput {
/**
* The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
*/
applicationName: ApplicationName;
/**
* The name of a new deployment group for the specified application.
*/
deploymentGroupName: DeploymentGroupName;
/**
* 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.
*/
deploymentConfigName?: DeploymentConfigName;
/**
* 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.
*/
ec2TagFilters?: EC2TagFilterList;
/**
* 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.
*/
onPremisesInstanceTagFilters?: TagFilterList;
/**
* A list of associated Amazon EC2 Auto Scaling groups.
*/
autoScalingGroups?: AutoScalingGroupNameList;
/**
* A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
*/
serviceRoleArn: Role;
/**
* 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.
*/
triggerConfigurations?: TriggerConfigList;
/**
* Information to add about Amazon CloudWatch alarms when the deployment group is created.
*/
alarmConfiguration?: AlarmConfiguration;
/**
* Configuration information for an automatic rollback that is added when a deployment group is created.
*/
autoRollbackConfiguration?: AutoRollbackConfiguration;
/**
* 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.
*/
deploymentStyle?: DeploymentStyle;
/**
* Information about blue/green deployment options for a deployment group.
*/
blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
/**
* Information about the load balancer used in a deployment.
*/
loadBalancerInfo?: LoadBalancerInfo;
/**
* 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.
*/
ec2TagSet?: EC2TagSet;
/**
* 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 <clustername>:<servicename>.
*/
ecsServices?: ECSServiceList;
/**
* 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.
*/
onPremisesTagSet?: OnPremisesTagSet;
/**
* 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.
*/
tags?: TagList;
}
export interface CreateDeploymentGroupOutput {
/**
* A unique deployment group ID.
*/
deploymentGroupId?: DeploymentGroupId;
}
export interface CreateDeploymentInput {
/**
* The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
*/
applicationName: ApplicationName;
/**
* The name of the deployment group.
*/
deploymentGroupName?: DeploymentGroupName;
/**
* The type and location of the revision to deploy.
*/
revision?: RevisionLocation;
/**
* 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.
*/
deploymentConfigName?: DeploymentConfigName;
/**
* A comment about the deployment.
*/
description?: Description;
/**
* 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 an