@datafire/amazonaws_codedeploy

Client library for AWS CodeDeploy

Installation and Usage

``bash
npm install --save @datafire/amazonaws_codedeploy
`
`js
let amazonaws_codedeploy = require('@datafire/amazonaws_codedeploy').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

amazonaws_codedeploy.AddTagsToOnPremisesInstances({
"tags": [],
"instanceNames": []
}).then(data => {
console.log(data);
});
`

Description

AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

• Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

• Deployment group: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.

• Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.

• Deployment: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances.

• Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.

AWS CodeDeploy Information Resources

• AWS CodeDeploy User Guide

• AWS CodeDeploy API Reference Guide

• AWS CLI Reference for AWS CodeDeploy

• AWS CodeDeploy Developer Forum

Actions

$3

`js
amazonaws_codedeploy.AddTagsToOnPremisesInstances({
"tags": [],
"instanceNames": []
}, context)
`

#### Input
* input object
* instanceNames required InstanceNameList
* tags required TagList

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.BatchGetApplicationRevisions({
"applicationName": "",
"revisions": []
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* revisions required RevisionLocationList

#### Output
* output BatchGetApplicationRevisionsOutput

$3

`js
amazonaws_codedeploy.BatchGetApplications({
"applicationNames": []
}, context)
`

#### Input
* input object
* applicationNames required ApplicationsList

#### Output
* output BatchGetApplicationsOutput

$3

`js
amazonaws_codedeploy.BatchGetDeploymentGroups({
"applicationName": "",
"deploymentGroupNames": []
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* deploymentGroupNames required DeploymentGroupsList

#### Output
* output BatchGetDeploymentGroupsOutput

$3

`js
amazonaws_codedeploy.BatchGetDeploymentInstances({
"deploymentId": "",
"instanceIds": []
}, context)
`

#### Input
* input object
* deploymentId required DeploymentId
* instanceIds required InstancesList

#### Output
* output BatchGetDeploymentInstancesOutput

$3

`js
amazonaws_codedeploy.BatchGetDeployments({
"deploymentIds": []
}, context)
`

#### Input
* input object
* deploymentIds required DeploymentsList

#### Output
* output BatchGetDeploymentsOutput

$3

`js
amazonaws_codedeploy.BatchGetOnPremisesInstances({
"instanceNames": []
}, context)
`

#### Input
* input object
* instanceNames required InstanceNameList

#### Output
* output BatchGetOnPremisesInstancesOutput

$3

`js
amazonaws_codedeploy.ContinueDeployment({}, context)
`

#### Input
* input object
* deploymentId DeploymentId

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.CreateApplication({
"applicationName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* computePlatform ComputePlatform

#### Output
* output CreateApplicationOutput

$3

`js
amazonaws_codedeploy.CreateDeployment({
"applicationName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* deploymentConfigName DeploymentConfigName
* deploymentGroupName DeploymentGroupName
* description Description
* fileExistsBehavior FileExistsBehavior
* ignoreApplicationStopFailures Boolean
* revision RevisionLocation
* targetInstances TargetInstances
* updateOutdatedInstancesOnly Boolean

#### Output
* output CreateDeploymentOutput

$3

`js
amazonaws_codedeploy.CreateDeploymentConfig({
"deploymentConfigName": ""
}, context)
`

#### Input
* input object
* computePlatform ComputePlatform
* deploymentConfigName required DeploymentConfigName
* minimumHealthyHosts MinimumHealthyHosts
* trafficRoutingConfig TrafficRoutingConfig

#### Output
* output CreateDeploymentConfigOutput

$3

`js
amazonaws_codedeploy.CreateDeploymentGroup({
"applicationName": "",
"deploymentGroupName": "",
"serviceRoleArn": ""
}, context)
`

#### Input
* input object
* alarmConfiguration AlarmConfiguration
* applicationName required ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* autoScalingGroups AutoScalingGroupNameList
* blueGreenDeploymentConfiguration BlueGreenDeploymentConfiguration
* deploymentConfigName DeploymentConfigName
* deploymentGroupName required DeploymentGroupName
* deploymentStyle DeploymentStyle
* ec2TagFilters EC2TagFilterList
* ec2TagSet EC2TagSet
* loadBalancerInfo LoadBalancerInfo
* onPremisesInstanceTagFilters TagFilterList
* onPremisesTagSet OnPremisesTagSet
* serviceRoleArn required Role
* triggerConfigurations TriggerConfigList

#### Output
* output CreateDeploymentGroupOutput

$3

`js
amazonaws_codedeploy.DeleteApplication({
"applicationName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.DeleteDeploymentConfig({
"deploymentConfigName": ""
}, context)
`

#### Input
* input object
* deploymentConfigName required DeploymentConfigName

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.DeleteDeploymentGroup({
"applicationName": "",
"deploymentGroupName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* deploymentGroupName required DeploymentGroupName

#### Output
* output DeleteDeploymentGroupOutput

$3

`js
amazonaws_codedeploy.DeleteGitHubAccountToken({}, context)
`

#### Input
* input object
* tokenName GitHubAccountTokenName

#### Output
* output DeleteGitHubAccountTokenOutput

$3

`js
amazonaws_codedeploy.DeregisterOnPremisesInstance({
"instanceName": ""
}, context)
`

#### Input
* input object
* instanceName required InstanceName

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.GetApplication({
"applicationName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName

#### Output
* output GetApplicationOutput

$3

`js
amazonaws_codedeploy.GetApplicationRevision({
"applicationName": "",
"revision": {}
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* revision required RevisionLocation

#### Output
* output GetApplicationRevisionOutput

$3

`js
amazonaws_codedeploy.GetDeployment({
"deploymentId": ""
}, context)
`

#### Input
* input object
* deploymentId required DeploymentId

#### Output
* output GetDeploymentOutput

$3

`js
amazonaws_codedeploy.GetDeploymentConfig({
"deploymentConfigName": ""
}, context)
`

#### Input
* input object
* deploymentConfigName required DeploymentConfigName

#### Output
* output GetDeploymentConfigOutput

$3

`js
amazonaws_codedeploy.GetDeploymentGroup({
"applicationName": "",
"deploymentGroupName": ""
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* deploymentGroupName required DeploymentGroupName

#### Output
* output GetDeploymentGroupOutput

$3

`js
amazonaws_codedeploy.GetDeploymentInstance({
"deploymentId": "",
"instanceId": ""
}, context)
`

#### Input
* input object
* deploymentId required DeploymentId
* instanceId required InstanceId

#### Output
* output GetDeploymentInstanceOutput

$3

`js
amazonaws_codedeploy.GetOnPremisesInstance({
"instanceName": ""
}, context)
`

#### Input
* input object
* instanceName required InstanceName

#### Output
* output GetOnPremisesInstanceOutput

$3

`js
amazonaws_codedeploy.ListApplicationRevisions({
"applicationName": ""
}, context)
`

#### Input
* input object
* nextToken string
* applicationName required ApplicationName
* deployed ListStateFilterAction
* nextToken NextToken
* s3Bucket S3Bucket
* s3KeyPrefix S3Key
* sortBy ApplicationRevisionSortBy
* sortOrder SortOrder

#### Output
* output ListApplicationRevisionsOutput

$3

`js
amazonaws_codedeploy.ListApplications({}, context)
`

#### Input
* input object
* nextToken string
* nextToken NextToken

#### Output
* output ListApplicationsOutput

$3

`js
amazonaws_codedeploy.ListDeploymentConfigs({}, context)
`

#### Input
* input object
* nextToken string
* nextToken NextToken

#### Output
* output ListDeploymentConfigsOutput

$3

`js
amazonaws_codedeploy.ListDeploymentGroups({
"applicationName": ""
}, context)
`

#### Input
* input object
* nextToken string
* applicationName required ApplicationName
* nextToken NextToken

#### Output
* output ListDeploymentGroupsOutput

$3

`js
amazonaws_codedeploy.ListDeploymentInstances({
"deploymentId": ""
}, context)
`

#### Input
* input object
* nextToken string
* deploymentId required DeploymentId
* instanceStatusFilter InstanceStatusList
* instanceTypeFilter InstanceTypeList
* nextToken NextToken

#### Output
* output ListDeploymentInstancesOutput

$3

`js
amazonaws_codedeploy.ListDeployments({}, context)
`

#### Input
* input object
* nextToken string
* applicationName ApplicationName
* createTimeRange TimeRange
* deploymentGroupName DeploymentGroupName
* includeOnlyStatuses DeploymentStatusList
* nextToken NextToken

#### Output
* output ListDeploymentsOutput

$3

`js
amazonaws_codedeploy.ListGitHubAccountTokenNames({}, context)
`

#### Input
* input object
* nextToken NextToken

#### Output
* output ListGitHubAccountTokenNamesOutput

$3

`js
amazonaws_codedeploy.ListOnPremisesInstances({}, context)
`

#### Input
* input object
* nextToken NextToken
* registrationStatus RegistrationStatus
* tagFilters TagFilterList

#### Output
* output ListOnPremisesInstancesOutput

$3

`js
amazonaws_codedeploy.PutLifecycleEventHookExecutionStatus({}, context)
`

#### Input
* input object
* deploymentId DeploymentId
* lifecycleEventHookExecutionId LifecycleEventHookExecutionId
* status LifecycleEventStatus

#### Output
* output PutLifecycleEventHookExecutionStatusOutput

$3

`js
amazonaws_codedeploy.RegisterApplicationRevision({
"applicationName": "",
"revision": {}
}, context)
`

#### Input
* input object
* applicationName required ApplicationName
* description Description
* revision required RevisionLocation

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.RegisterOnPremisesInstance({
"instanceName": ""
}, context)
`

#### Input
* input object
* iamSessionArn IamSessionArn
* iamUserArn IamUserArn
* instanceName required InstanceName

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.RemoveTagsFromOnPremisesInstances({
"tags": [],
"instanceNames": []
}, context)
`

#### Input
* input object
* instanceNames required InstanceNameList
* tags required TagList

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.SkipWaitTimeForInstanceTermination({}, context)
`

#### Input
* input object
* deploymentId DeploymentId

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.StopDeployment({
"deploymentId": ""
}, context)
`

#### Input
* input object
* autoRollbackEnabled NullableBoolean
* deploymentId required DeploymentId

#### Output
* output StopDeploymentOutput

$3

`js
amazonaws_codedeploy.UpdateApplication({}, context)
`

#### Input
* input object
* applicationName ApplicationName
* newApplicationName ApplicationName

#### Output
Output schema unknown

$3

`js
amazonaws_codedeploy.UpdateDeploymentGroup({
"applicationName": "",
"currentDeploymentGroupName": ""
}, context)
`

#### Input
* input object
* alarmConfiguration AlarmConfiguration
* applicationName required ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* autoScalingGroups AutoScalingGroupNameList
* blueGreenDeploymentConfiguration BlueGreenDeploymentConfiguration
* currentDeploymentGroupName required DeploymentGroupName
* deploymentConfigName DeploymentConfigName
* deploymentStyle DeploymentStyle
* ec2TagFilters EC2TagFilterList
* ec2TagSet EC2TagSet
* loadBalancerInfo LoadBalancerInfo
* newDeploymentGroupName DeploymentGroupName
* onPremisesInstanceTagFilters TagFilterList
* onPremisesTagSet OnPremisesTagSet
* serviceRoleArn Role
* triggerConfigurations TriggerConfigList

#### Output
* output UpdateDeploymentGroupOutput

Definitions

$3


* AddTagsToOnPremisesInstancesInput object: Represents the input of, and adds tags to, an on-premises instance operation.
* instanceNames required InstanceNameList
* tags required TagList

$3

* AdditionalDeploymentStatusInfo string

$3

* Alarm object: Information about an alarm.
* name AlarmName

$3

* AlarmConfiguration object: Information about alarms associated with the deployment group.
* alarms AlarmList
* enabled Boolean
* ignorePollAlarmFailure Boolean

$3

* AlarmList array
* items Alarm

$3

* AlarmName string

$3

* AlarmsLimitExceededException object: The maximum number of alarms for a deployment group (10) was exceeded.

$3

* ApplicationAlreadyExistsException object: An application with the specified name already exists with the applicable IAM user or AWS account.

$3

* ApplicationDoesNotExistException object: The application does not exist with the applicable IAM user or AWS account.

$3

* ApplicationId string

$3

* ApplicationInfo object: Information about an application.
* applicationId ApplicationId
* applicationName ApplicationName
* computePlatform ComputePlatform
* createTime Timestamp
* gitHubAccountName GitHubAccountTokenName
* linkedToGitHub Boolean

$3

* ApplicationLimitExceededException object: More applications were attempted to be created than are allowed.

$3

* ApplicationName string

$3

* ApplicationNameRequiredException object: The minimum number of required application names was not specified.

$3

* ApplicationRevisionSortBy string (values: registerTime, firstUsedTime, lastUsedTime)

$3

* ApplicationsInfoList array
* items ApplicationInfo

$3

* ApplicationsList array
* items ApplicationName

$3

* AutoRollbackConfiguration object: Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment doesn't complete successfully.
* enabled Boolean
* events AutoRollbackEventsList

$3

* AutoRollbackEvent string (values: DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST)

$3

* AutoRollbackEventsList array
* items AutoRollbackEvent

$3

* AutoScalingGroup object: Information about an Auto Scaling group.
* hook AutoScalingGroupHook
* name AutoScalingGroupName

$3

* AutoScalingGroupHook string

$3

* AutoScalingGroupList array
* items AutoScalingGroup

$3

* AutoScalingGroupName string

$3

* AutoScalingGroupNameList array
* items AutoScalingGroupName

$3

* BatchGetApplicationRevisionsInput object: Represents the input of a BatchGetApplicationRevisions operation.
* applicationName required ApplicationName
* revisions required RevisionLocationList

$3

* BatchGetApplicationRevisionsOutput object: Represents the output of a BatchGetApplicationRevisions operation.
* applicationName ApplicationName
* errorMessage ErrorMessage
* revisions RevisionInfoList

$3

* BatchGetApplicationsInput object: Represents the input of a BatchGetApplications operation.
* applicationNames required ApplicationsList

$3

* BatchGetApplicationsOutput object: Represents the output of a BatchGetApplications operation.
* applicationsInfo ApplicationsInfoList

$3

* BatchGetDeploymentGroupsInput object: Represents the input of a BatchGetDeploymentGroups operation.
* applicationName required ApplicationName
* deploymentGroupNames required DeploymentGroupsList

$3

* BatchGetDeploymentGroupsOutput object: Represents the output of a BatchGetDeploymentGroups operation.
* deploymentGroupsInfo DeploymentGroupInfoList
* errorMessage ErrorMessage

$3

* BatchGetDeploymentInstancesInput object: Represents the input of a BatchGetDeploymentInstances operation.
* deploymentId required DeploymentId
* instanceIds required InstancesList

$3

* BatchGetDeploymentInstancesOutput object: Represents the output of a BatchGetDeploymentInstances operation.
* errorMessage ErrorMessage
* instancesSummary InstanceSummaryList

$3

* BatchGetDeploymentsInput object: Represents the input of a BatchGetDeployments operation.
* deploymentIds required DeploymentsList

$3

* BatchGetDeploymentsOutput object: Represents the output of a BatchGetDeployments operation.
* deploymentsInfo DeploymentsInfoList

$3

* BatchGetOnPremisesInstancesInput object: Represents the input of a BatchGetOnPremisesInstances operation.
* instanceNames required InstanceNameList

$3

* BatchGetOnPremisesInstancesOutput object: Represents the output of a BatchGetOnPremisesInstances operation.
* instanceInfos InstanceInfoList

$3

* BatchLimitExceededException object: The maximum number of names or IDs allowed for this request (100) was exceeded.

$3

* BlueGreenDeploymentConfiguration object: Information about blue/green deployment options for a deployment group.
* deploymentReadyOption DeploymentReadyOption
* greenFleetProvisioningOption GreenFleetProvisioningOption
* terminateBlueInstancesOnDeploymentSuccess BlueInstanceTerminationOption

$3

* BlueInstanceTerminationOption object: Information about whether instances in the original environment are terminated when a blue/green deployment is successful.
* action InstanceAction
* terminationWaitTimeInMinutes Duration

$3

* Boolean boolean

$3

* BucketNameFilterRequiredException object: A bucket name is required, but was not provided.

$3

* BundleType string (values: tar, tgz, zip, YAML, JSON)

$3

* CommitId string

$3

* ComputePlatform string (values: Server, Lambda)

$3

* ContinueDeploymentInput object
* deploymentId DeploymentId

$3

* CreateApplicationInput object: Represents the input of a CreateApplication operation.
* applicationName required ApplicationName
* computePlatform ComputePlatform

$3

* CreateApplicationOutput object: Represents the output of a CreateApplication operation.
* applicationId ApplicationId

$3

* CreateDeploymentConfigInput object: Represents the input of a CreateDeploymentConfig operation.
* computePlatform ComputePlatform
* deploymentConfigName required DeploymentConfigName
* minimumHealthyHosts MinimumHealthyHosts
* trafficRoutingConfig TrafficRoutingConfig

$3

* CreateDeploymentConfigOutput object: Represents the output of a CreateDeploymentConfig operation.
* deploymentConfigId DeploymentConfigId

$3

* CreateDeploymentGroupInput object: Represents the input of a CreateDeploymentGroup operation.
* alarmConfiguration AlarmConfiguration
* applicationName required ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* autoScalingGroups AutoScalingGroupNameList
* blueGreenDeploymentConfiguration BlueGreenDeploymentConfiguration
* deploymentConfigName DeploymentConfigName
* deploymentGroupName required DeploymentGroupName
* deploymentStyle DeploymentStyle
* ec2TagFilters EC2TagFilterList
* ec2TagSet EC2TagSet
* loadBalancerInfo LoadBalancerInfo
* onPremisesInstanceTagFilters TagFilterList
* onPremisesTagSet OnPremisesTagSet
* serviceRoleArn required Role
* triggerConfigurations TriggerConfigList

$3

* CreateDeploymentGroupOutput object: Represents the output of a CreateDeploymentGroup operation.
* deploymentGroupId DeploymentGroupId

$3

* CreateDeploymentInput object: Represents the input of a CreateDeployment operation.
* applicationName required ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* deploymentConfigName DeploymentConfigName
* deploymentGroupName DeploymentGroupName
* description Description
* fileExistsBehavior FileExistsBehavior
* ignoreApplicationStopFailures Boolean
* revision RevisionLocation
* targetInstances TargetInstances
* updateOutdatedInstancesOnly Boolean

$3

* CreateDeploymentOutput object: Represents the output of a CreateDeployment operation.
* deploymentId DeploymentId

$3

* DeleteApplicationInput object: Represents the input of a DeleteApplication operation.
* applicationName required ApplicationName

$3

* DeleteDeploymentConfigInput object: Represents the input of a DeleteDeploymentConfig operation.
* deploymentConfigName required DeploymentConfigName

$3

* DeleteDeploymentGroupInput object: Represents the input of a DeleteDeploymentGroup operation.
* applicationName required ApplicationName
* deploymentGroupName required DeploymentGroupName

$3

* DeleteDeploymentGroupOutput object: Represents the output of a DeleteDeploymentGroup operation.
* hooksNotCleanedUp AutoScalingGroupList

$3

* DeleteGitHubAccountTokenInput object: Represents the input of a DeleteGitHubAccount operation.
* tokenName GitHubAccountTokenName

$3

* DeleteGitHubAccountTokenOutput object: Represents the output of a DeleteGitHubAccountToken operation.
* tokenName GitHubAccountTokenName

$3

* DeploymentAlreadyCompletedException object: The deployment is already complete.

$3

* DeploymentConfigAlreadyExistsException object: A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.

$3

* DeploymentConfigDoesNotExistException object: The deployment configuration does not exist with the applicable IAM user or AWS account.

$3

* DeploymentConfigId string

$3

* DeploymentConfigInUseException object: The deployment configuration is still in use.

$3

* DeploymentConfigInfo object: Information about a deployment configuration.
* computePlatform ComputePlatform
* createTime Timestamp
* deploymentConfigId DeploymentConfigId
* deploymentConfigName DeploymentConfigName
* minimumHealthyHosts MinimumHealthyHosts
* trafficRoutingConfig TrafficRoutingConfig

$3

* DeploymentConfigLimitExceededException object: The deployment configurations limit was exceeded.

$3

* DeploymentConfigName string

$3

* DeploymentConfigNameRequiredException object: The deployment configuration name was not specified.

$3

* DeploymentConfigsList array
* items DeploymentConfigName

$3

* DeploymentCreator string (values: user, autoscaling, codeDeployRollback)

$3

* DeploymentDoesNotExistException object: The deployment does not exist with the applicable IAM user or AWS account.

$3

* DeploymentGroupAlreadyExistsException object: A deployment group with the specified name already exists with the applicable IAM user or AWS account.

$3

* DeploymentGroupDoesNotExistException object: The named deployment group does not exist with the applicable IAM user or AWS account.

$3

* DeploymentGroupId string

$3

* DeploymentGroupInfo object: Information about a deployment group.
* alarmConfiguration AlarmConfiguration
* applicationName ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* autoScalingGroups AutoScalingGroupList
* blueGreenDeploymentConfiguration BlueGreenDeploymentConfiguration
* computePlatform ComputePlatform
* deploymentConfigName DeploymentConfigName
* deploymentGroupId DeploymentGroupId
* deploymentGroupName DeploymentGroupName
* deploymentStyle DeploymentStyle
* ec2TagFilters EC2TagFilterList
* ec2TagSet EC2TagSet
* lastAttemptedDeployment LastDeploymentInfo
* lastSuccessfulDeployment LastDeploymentInfo
* loadBalancerInfo LoadBalancerInfo
* onPremisesInstanceTagFilters TagFilterList
* onPremisesTagSet OnPremisesTagSet
* serviceRoleArn Role
* targetRevision RevisionLocation
* triggerConfigurations TriggerConfigList

$3

* DeploymentGroupInfoList array
* items DeploymentGroupInfo

$3

* DeploymentGroupLimitExceededException object: The deployment groups limit was exceeded.

$3

* DeploymentGroupName string

$3

* DeploymentGroupNameRequiredException object: The deployment group name was not specified.

$3

* DeploymentGroupsList array
* items DeploymentGroupName

$3

* DeploymentId string

$3

* DeploymentIdRequiredException object: At least one deployment ID must be specified.

$3

* DeploymentInfo object: Information about a deployment.
* additionalDeploymentStatusInfo AdditionalDeploymentStatusInfo
* applicationName ApplicationName
* autoRollbackConfiguration AutoRollbackConfiguration
* blueGreenDeploymentConfiguration BlueGreenDeploymentConfiguration
* completeTime Timestamp
* computePlatform ComputePlatform
* createTime Timestamp
* creator DeploymentCreator
* deploymentConfigName DeploymentConfigName
* deploymentGroupName DeploymentGroupName
* deploymentId DeploymentId
* deploymentOverview DeploymentOverview
* deploymentStatusMessages DeploymentStatusMessageList
* deploymentStyle DeploymentStyle
* description Description
* errorInformation ErrorInformation
* fileExistsBehavior FileExistsBehavior
* ignoreApplicationStopFailures Boolean
* instanceTerminationWaitTimeStarted Boolean
* loadBalancerInfo LoadBalancerInfo
* previousRevision RevisionLocation
* revision RevisionLocation
* rollbackInfo RollbackInfo
* startTime Timestamp
* status DeploymentStatus
* targetInstances TargetInstances
* updateOutdatedInstancesOnly Boolean

$3

* DeploymentIsNotInReadyStateException object: The deployment does not have a status of Ready and can't continue yet.

$3

* DeploymentLimitExceededException object: The number of allowed deployments was exceeded.

$3

* DeploymentNotStartedException object: The specified deployment has not started.

$3

* DeploymentOption string (values: WITH_TRAFFIC_CONTROL, WITHOUT_TRAFFIC_CONTROL)

$3

* DeploymentOverview object: Information about the deployment status of the instances in the deployment.
* Failed InstanceCount
* InProgress InstanceCount
* Pending InstanceCount
* Ready InstanceCount
* Skipped InstanceCount
* Succeeded InstanceCount

$3

* DeploymentReadyAction string (values: CONTINUE_DEPLOYMENT, STOP_DEPLOYMENT)

$3

* DeploymentReadyOption object: Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
* actionOnTimeout DeploymentReadyAction
* waitTimeInMinutes Duration

$3

* DeploymentStatus string (values: Created, Queued, InProgress, Succeeded, Failed, Stopped, Ready)

$3

* DeploymentStatusList array
* items DeploymentStatus

$3

* DeploymentStatusMessageList array
* items ErrorMessage

$3

* DeploymentStyle object: Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
* deploymentOption DeploymentOption
* deploymentType DeploymentType

$3

* DeploymentType string (values: IN_PLACE, BLUE_GREEN)

$3

* DeploymentsInfoList array
* items DeploymentInfo

$3

* DeploymentsList array
* items DeploymentId

$3

* DeregisterOnPremisesInstanceInput object: Represents the input of a DeregisterOnPremisesInstance operation.
* instanceName required InstanceName

$3

* Description string

$3

* DescriptionTooLongException object: The description is too long.

$3

* Diagnostics object: Diagnostic information about executable scripts that are part of a deployment.
* errorCode LifecycleErrorCode
* logTail LogTail
* message LifecycleMessage
* scriptName ScriptName

$3

* Duration integer

$3

* EC2TagFilter object: Information about an EC2 tag filter.
* Key Key
* Type EC2TagFilterType
* Value Value

$3

* EC2TagFilterList array
* items EC2TagFilter

$3

* EC2TagFilterType string (values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE)

$3

* EC2TagSet object: Information about groups of EC2 instance tags.
* ec2TagSetList EC2TagSetList

$3

* EC2TagSetList array
* items EC2TagFilterList

$3

* ELBInfo object: Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
* name ELBName

$3

* ELBInfoList array
* items ELBInfo

$3

* ELBName string

$3

* ETag string

$3

* ErrorCode string (values: DEPLOYMENT_GROUP_MISSING, APPLICATION_MISSING, REVISION_MISSING, IAM_ROLE_MISSING, IAM_ROLE_PERMISSIONS, NO_EC2_SUBSCRIPTION, OVER_MAX_INSTANCES, NO_INSTANCES, TIMEOUT, HEALTH_CONSTRAINTS_INVALID, HEALTH_CONSTRAINTS, INTERNAL_ERROR, THROTTLED, ALARM_ACTIVE, AGENT_ISSUE, AUTO_SCALING_IAM_ROLE_PERMISSIONS, AUTO_SCALING_CONFIGURATION, MANUAL_STOP, MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION, MISSING_ELB_INFORMATION, MISSING_GITHUB_TOKEN, ELASTIC_LOAD_BALANCING_INVALID, ELB_INVALID_INSTANCE, INVALID_LAMBDA_CONFIGURATION, INVALID_LAMBDA_FUNCTION, HOOK_EXECUTION_FAILURE)

$3

* ErrorInformation object: Information about a deployment error.
* code ErrorCode
* message ErrorMessage

$3

* ErrorMessage string

$3

* FileExistsBehavior string (values: DISALLOW, OVERWRITE, RETAIN)

$3

* GenericRevisionInfo object: Information about an application revision.
* deploymentGroups DeploymentGroupsList
* description Description
* firstUsedTime Timestamp
* lastUsedTime Timestamp
* registerTime Timestamp

$3

* GetApplicationInput object: Represents the input of a GetApplication operation.
* applicationName required ApplicationName

$3

* GetApplicationOutput object: Represents the output of a GetApplication operation.
* application ApplicationInfo

$3

* GetApplicationRevisionInput object: Represents the input of a GetApplicationRevision operation.
* applicationName required ApplicationName
* revision required RevisionLocation

$3

* GetApplicationRevisionOutput object: Represents the output of a GetApplicationRevision operation.
* applicationName ApplicationName
* revision RevisionLocation
* revisionInfo GenericRevisionInfo

$3

* GetDeploymentConfigInput object: Represents the input of a GetDeploymentConfig operation.
* deploymentConfigName required DeploymentConfigName

$3

* GetDeploymentConfigOutput object: Represents the output of a GetDeploymentConfig operation.
* deploymentConfigInfo DeploymentConfigInfo

$3

* GetDeploymentGroupInput object: Represents the input of a GetDeploymentGroup operation.
* applicationName required ApplicationName
* deploymentGroupName required DeploymentGroupName

$3

* GetDeploymentGroupOutput object: Represents the output of a GetDeploymentGroup operation.
* deploymentGroupInfo DeploymentGroupInfo

$3

* GetDeploymentInput object: Represents the input of a GetDeployment operation.
* deploymentId required DeploymentId

$3

* GetDeploymentInstanceInput object: Represents the input of a GetDeploymentInstance operation.
* deploymentId required DeploymentId
* instanceId required InstanceId

$3

* GetDeploymentInstanceOutput object: Represents the output of a GetDeploymentInstance operation.
* instanceSummary InstanceSummary

$3

* GetDeploymentOutput object: Represents the output of a GetDeployment operation.
* deploymentInfo DeploymentInfo

$3

* GetOnPremisesInstanceInput object: Represents the input of a GetOnPremisesInstance operation.
* instanceName required InstanceName

$3

* GetOnPremisesInstanceOutput object: Represents the output of a GetOnPremisesInstance operation.
* instanceInfo InstanceInfo

$3

* GitHubAccountTokenDoesNotExistException object: No GitHub account connection exists with the named specified in the call.

$3

* GitHubAccountTokenName string

$3

* GitHubAccountTokenNameList array
* items GitHubAccountTokenName

$3

* GitHubAccountTokenNameRequiredException object: The call is missing a required GitHub account connection name.

$3

* GitHubLocation object: Information about the location of application artifacts stored in GitHub.
* commitId CommitId
* repository Repository

$3

* GreenFleetProvisioningAction string (values: DISCOVER_EXISTING, COPY_AUTO_SCALING_GROUP)

$3

* GreenFleetProvisioningOption object: Information about the instances that belong to the replacement environment in a blue/green deployment.
* action GreenFleetProvisioningAction

$3

* IamArnRequiredException object: No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.

$3

* IamSessionArn string

$3

* IamSessionArnAlreadyRegisteredException object: The request included an IAM session ARN that has already been used to register a different instance.

$3

* IamUserArn string

$3

* IamUserArnAlreadyRegisteredException object: The specified IAM user ARN is already registered with an on-premises instance.

$3

* IamUserArnRequiredException object: An IAM user ARN was not specified.

$3

* InstanceAction string (values: TERMINATE, KEEP_ALIVE)

$3

* InstanceArn string

$3

* InstanceCount integer

$3

* InstanceDoesNotExistException object: The specified instance does not exist in the deployment group.

$3

* InstanceId string

$3

* InstanceIdRequiredException object: The instance ID was not specified.

$3

* InstanceInfo object: Information about an on-premises instance.
* deregisterTime Timestamp
* iamSessionArn IamSessionArn
* iamUserArn IamUserArn
* instanceArn InstanceArn
* instanceName InstanceName
* registerTime Timestamp
* tags TagList

$3

* InstanceInfoList array
* items InstanceInfo

$3

* InstanceLimitExceededException object: The maximum number of allowed on-premises instances in a single call was exceeded.

$3

* InstanceName string

$3

* InstanceNameAlreadyRegisteredException object: The specified on-premises instance name is already registered.

$3

* InstanceNameList array
* items InstanceName

$3

* InstanceNameRequiredException object: An on-premises instance name was not specified.

$3

* InstanceNotRegisteredException object: The specified on-premises instance is not registered.

$3

* InstanceStatus string (values: Pending, InProgress, Succeeded, Failed, Skipped, Unknown, Ready)

$3

* InstanceStatusList array
* items InstanceStatus

$3

* InstanceSummary object: Information about an instance in a deployment.
* deploymentId DeploymentId
* instanceId InstanceId
* instanceType InstanceType
* lastUpdatedAt Timestamp
* lifecycleEvents LifecycleEventList
* status InstanceStatus

$3

* InstanceSummaryList array
* items InstanceSummary

$3

* InstanceType string (values: Blue, Green)

$3

* InstanceTypeList array
* items InstanceType

$3

* InstancesList array
* items InstanceId

$3

* InvalidAlarmConfigException object:

The format of the alarm configuration is invalid. Possible causes include:

• The alarm list is null.

• The alarm object is null.

• The alarm name is empty or null or exceeds the 255 character limit.

• Two alarms with the same name have been specified.

• The alarm configuration is enabled but the alarm list is empty.

$3

* InvalidApplicationNameException object: The application name was specified in an invalid format.

$3

* InvalidAutoRollbackConfigException object: The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.

$3

* InvalidAutoScalingGroupException object: The Auto Scaling group was specified in an invalid format or does not exist.

$3

* InvalidBlueGreenDeploymentConfigurationException object: The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

$3

* InvalidBucketNameFilterException object: The bucket name either doesn't exist or was specified in an invalid format.

$3

* InvalidComputePlatformException object: The computePlatform is invalid. The computePlatform should be Lambda or Server.

$3

* InvalidDeployedStateFilterException object: The deployed state filter was specified in an invalid format.

$3

* InvalidDeploymentConfigNameException object: The deployment configuration name was specified in an invalid format.

$3

* InvalidDeploymentGroupNameException object: The deployment group name was specified in an invalid format.

$3

* InvalidDeploymentIdException object: At least one of the deployment IDs was specified in an invalid format.

$3

* InvalidDeploymentInstanceTypeException object: An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.

$3

* InvalidDeploymentStatusException object: The specified deployment status doesn't exist or cannot be determined.

$3

* InvalidDeploymentStyleException object: An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN". Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL".

$3

* InvalidEC2TagCombinationException object: A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

$3

* InvalidEC2TagException object: The tag was specified in an invalid format.

$3

* InvalidFileExistsBehaviorException object: An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location but weren't part of the previous successful deployment. Valid values include "DISALLOW", "OVERWRITE", and "RETAIN".

$3

* InvalidGitHubAccountTokenNameException object: The format of the specified GitHub account connection name is invalid.

$3

* InvalidIamSessionArnException object: The IAM session ARN was specified in an invalid format.

$3

* InvalidIamUserArnException object: The IAM user ARN was specified in an invalid format.

$3

* InvalidIgnoreApplicationStopFailuresValueException object: The IgnoreApplicationStopFailures value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

$3

* InvalidInputException object: The specified input was specified in an invalid format.

$3

* InvalidInstanceIdException object:

$3

* InvalidInstanceNameException object: The specified on-premises instance name was specified in an invalid format.

$3

* InvalidInstanceStatusException object: The specified instance status does not exist.

$3

* InvalidInstanceTypeException object: An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.

$3

* InvalidKeyPrefixFilterException object: The specified key prefix filter was specified in an invalid format.

$3

* InvalidLifecycleEventHookExecutionIdException object: A lifecycle event hook is invalid. Review the hooks section in your AppSpec file to ensure the lifecycle events and hooks functions are valid.

$3

* InvalidLifecycleEventHookExecutionStatusException object: The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded or Failed.

$3

* InvalidLoadBalancerInfoException object: An invalid load balancer name, or no load balancer name, was specified.

$3

* InvalidMinimumHealthyHostValueException object: The minimum healthy instance value was specified in an invalid format.

$3

* InvalidNextTokenException object: The next token was specified in an invalid format.

$3

* InvalidOnPremisesTagCombinationException object: A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

$3

* InvalidOperationException object: An invalid operation was detected.

$3

* InvalidRegistrationStatusException object: The registration status was specified in an invalid format.

$3

* InvalidRevisionException object: The revision was specified in an invalid format.

$3

* InvalidRoleException object: The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

$3

* InvalidSortByException object: The column name to sort by is either not present or was specified in an invalid format.

$3

* InvalidSortOrderException object: The sort order was specified in an invalid format.

$3

* InvalidTagException object: The specified tag was specified in an invalid format.

$3

* InvalidTagFilterException object: The specified tag filter was specified in an invalid format.

$3

* InvalidTargetInstancesException object:

The target instance configuration is invalid. Possible causes include:

• Configuration data for target instances was entered for an in-place deployment.

• The limit of 10 tags for a tag type was exceeded.

• The combined length of the tag names exceeded the limit.

• A specified tag is not currently applied to any instances.

$3

* InvalidTimeRangeException object: The specified time range was specified in an invalid format.

$3

* InvalidTrafficRoutingConfigurationException object: The configuration that specifies how traffic is routed during a deployment is invalid.

$3

* InvalidTriggerConfigException object: The trigger was specified in an invalid format.

$3

* InvalidUpdateOutdatedInstancesOnlyValueException object: The UpdateOutdatedInstancesOnly value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

$3

* Key string

$3

* LastDeploymentInfo object: Information about the most recent attempted or successful deployment to a deployment group.
* createTime Timestamp
* deploymentId DeploymentId
* endTime Timestamp
* status DeploymentStatus

$3

* LifecycleErrorCode string (values: Success, ScriptMissing, ScriptNotExecutable, ScriptTimedOut, ScriptFailed, UnknownError)

$3

* LifecycleEvent object: Information about a deployment lifecycle event.
* diagnostics Diagnostics
* endTime Timestamp
* lifecycleEventName LifecycleEventName
* startTime Timestamp
* status LifecycleEventStatus

$3

* LifecycleEventAlreadyCompletedException object: An attempt to return the status of an already completed lifecycle event occurred.

$3

* LifecycleEventHookExecutionId string

$3

* LifecycleEventList array
* items LifecycleEvent

$3

* LifecycleEventName string

$3

* LifecycleEventStatus string (values: Pending, InProgress, Succeeded, Failed, Skipped, Unknown)

$3

* LifecycleHookLimitExceededException object: The limit for lifecycle hooks was exceeded.

$3

* LifecycleMessage string

$3

* ListApplicationRevisionsInput object: Represents the input of a ListApplicationRevisions operation.
* applicationName required ApplicationName
* deployed ListStateFilterAction
* nextToken NextToken
* s3Bucket S3Bucket
* s3KeyPrefix S3Key
* sortBy ApplicationRevisionSortBy
* sortOrder SortOrder

$3

* ListApplicationRevisionsOutput object: Represents the output of a ListApplicationRevisions operation.
* nextToken NextToken
* revisions RevisionLocationList

$3

* ListApplicationsInput object: Represents the input of a ListApplications operation.
* nextToken NextToken

$3

* ListApplicationsOutput object: Represents the output of a ListApplications operation.
* applications ApplicationsList
* nextToken NextToken

$3

* ListDeploymentConfigsInput object: Represents the input of a ListDeploymentConfigs operation.
* nextToken NextToken

$3

* ListDeploymentConfigsOutput object: Represents the output of a ListDeploymentConfigs operation.
* deploymentConfigsList DeploymentConfigsList
* nextToken NextToken

$3

* ListDeploymentGroupsInput object: Represents the input of a ListDeploymentGroups operation.
* applicationName required ApplicationName
* nextToken NextToken

$3

* ListDeploymentGroupsOutput object: Represents the output of a ListDeploymentGroups operation.
* applicationName ApplicationName
* deploymentGroups DeploymentGroupsList
* nextToken NextToken

$3

* ListDeploymentInstancesInput object: Represents the input of a ListDeploymentInstances operation.
* deploymentId required DeploymentId
* instanceStatusFilter InstanceStatusList
* instanceTypeFilter InstanceTypeList
* nextToken NextToken

$3

* ListDeploymentInstancesOutput object: Represents the output of a ListDeploymentInstances operation.
* instancesList InstancesList
* nextToken NextToken

$3

* ListDeploymentsInput object: Represents the input of a ListDeployments operation.
* applicationName ApplicationName
* createTimeRange TimeRange
* deploymentGroupName DeploymentGroupName
* includeOnlyStatuses DeploymentStatusList
* nextToken NextToken

$3

* ListDeploymentsOutput object: Represents the output of a ListDeployments operation.
* deployments DeploymentsList
* nextToken NextToken

$3

* ListGitHubAccountTokenNamesInput object: Represents the input of a ListGitHubAccountTokenNames operation.
* nextToken NextToken

$3

* ListGitHubAccountTokenNamesOutput object: Represents the output of a ListGitHubAccountTokenNames operation.
* nextToken NextToken
* tokenNameList GitHubAccountTokenNameList

$3

* ListOnPremisesInstancesInput object: Represents the input of a ListOnPremisesInstances operation.
* nextToken NextToken
* registrationStatus RegistrationStatus
* tagFilters TagFilterList

$3

* ListOnPremisesInstancesOutput object: Represents the output of list on-premises instances operation.
* instanceNames InstanceNameList
* nextToken NextToken

$3

* ListStateFilterAction string` (val