# Data Types
<a name="API_Types"></a>

The Amazon CodeDeploy API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [Alarm](API_Alarm.md) 
+  [AlarmConfiguration](API_AlarmConfiguration.md) 
+  [ApplicationInfo](API_ApplicationInfo.md) 
+  [AppSpecContent](API_AppSpecContent.md) 
+  [AutoRollbackConfiguration](API_AutoRollbackConfiguration.md) 
+  [AutoScalingGroup](API_AutoScalingGroup.md) 
+  [BlueGreenDeploymentConfiguration](API_BlueGreenDeploymentConfiguration.md) 
+  [BlueInstanceTerminationOption](API_BlueInstanceTerminationOption.md) 
+  [CloudFormationTarget](API_CloudFormationTarget.md) 
+  [DeploymentConfigInfo](API_DeploymentConfigInfo.md) 
+  [DeploymentGroupInfo](API_DeploymentGroupInfo.md) 
+  [DeploymentInfo](API_DeploymentInfo.md) 
+  [DeploymentOverview](API_DeploymentOverview.md) 
+  [DeploymentReadyOption](API_DeploymentReadyOption.md) 
+  [DeploymentStyle](API_DeploymentStyle.md) 
+  [DeploymentTarget](API_DeploymentTarget.md) 
+  [Diagnostics](API_Diagnostics.md) 
+  [EC2TagFilter](API_EC2TagFilter.md) 
+  [EC2TagSet](API_EC2TagSet.md) 
+  [ECSService](API_ECSService.md) 
+  [ECSTarget](API_ECSTarget.md) 
+  [ECSTaskSet](API_ECSTaskSet.md) 
+  [ELBInfo](API_ELBInfo.md) 
+  [ErrorInformation](API_ErrorInformation.md) 
+  [GenericRevisionInfo](API_GenericRevisionInfo.md) 
+  [GitHubLocation](API_GitHubLocation.md) 
+  [GreenFleetProvisioningOption](API_GreenFleetProvisioningOption.md) 
+  [InstanceInfo](API_InstanceInfo.md) 
+  [InstanceSummary](API_InstanceSummary.md) 
+  [InstanceTarget](API_InstanceTarget.md) 
+  [LambdaFunctionInfo](API_LambdaFunctionInfo.md) 
+  [LambdaTarget](API_LambdaTarget.md) 
+  [LastDeploymentInfo](API_LastDeploymentInfo.md) 
+  [LifecycleEvent](API_LifecycleEvent.md) 
+  [LoadBalancerInfo](API_LoadBalancerInfo.md) 
+  [MinimumHealthyHosts](API_MinimumHealthyHosts.md) 
+  [MinimumHealthyHostsPerZone](API_MinimumHealthyHostsPerZone.md) 
+  [OnPremisesTagSet](API_OnPremisesTagSet.md) 
+  [RawString](API_RawString.md) 
+  [RelatedDeployments](API_RelatedDeployments.md) 
+  [RevisionInfo](API_RevisionInfo.md) 
+  [RevisionLocation](API_RevisionLocation.md) 
+  [RollbackInfo](API_RollbackInfo.md) 
+  [S3Location](API_S3Location.md) 
+  [Tag](API_Tag.md) 
+  [TagFilter](API_TagFilter.md) 
+  [TargetGroupInfo](API_TargetGroupInfo.md) 
+  [TargetGroupPairInfo](API_TargetGroupPairInfo.md) 
+  [TargetInstances](API_TargetInstances.md) 
+  [TimeBasedCanary](API_TimeBasedCanary.md) 
+  [TimeBasedLinear](API_TimeBasedLinear.md) 
+  [TimeRange](API_TimeRange.md) 
+  [TrafficRoute](API_TrafficRoute.md) 
+  [TrafficRoutingConfig](API_TrafficRoutingConfig.md) 
+  [TriggerConfig](API_TriggerConfig.md) 
+  [ZonalConfig](API_ZonalConfig.md) 

# Alarm
<a name="API_Alarm"></a>

Information about an alarm.

## Contents
<a name="API_Alarm_Contents"></a>

 ** name **   <a name="CodeDeploy-Type-Alarm-name"></a>
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.  
Type: String  
Required: No

## See Also
<a name="API_Alarm_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/Alarm) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/Alarm) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/Alarm) 

# AlarmConfiguration
<a name="API_AlarmConfiguration"></a>

Information about alarms associated with a deployment or deployment group.

## Contents
<a name="API_AlarmConfiguration_Contents"></a>

 ** alarms **   <a name="CodeDeploy-Type-AlarmConfiguration-alarms"></a>
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.  
Type: Array of [Alarm](API_Alarm.md) objects  
Required: No

 ** enabled **   <a name="CodeDeploy-Type-AlarmConfiguration-enabled"></a>
Indicates whether the alarm configuration is enabled.  
Type: Boolean  
Required: No

 ** ignorePollAlarmFailure **   <a name="CodeDeploy-Type-AlarmConfiguration-ignorePollAlarmFailure"></a>
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.
Type: Boolean  
Required: No

## See Also
<a name="API_AlarmConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/AlarmConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/AlarmConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/AlarmConfiguration) 

# ApplicationInfo
<a name="API_ApplicationInfo"></a>

Information about an application.

## Contents
<a name="API_ApplicationInfo_Contents"></a>

 ** applicationId **   <a name="CodeDeploy-Type-ApplicationInfo-applicationId"></a>
The application ID.  
Type: String  
Required: No

 ** applicationName **   <a name="CodeDeploy-Type-ApplicationInfo-applicationName"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** computePlatform **   <a name="CodeDeploy-Type-ApplicationInfo-computePlatform"></a>
The destination platform type for deployment of the application (`Lambda` or `Server`).  
Type: String  
Valid Values: `Server | Lambda | ECS | Kubernetes`   
Required: No

 ** createTime **   <a name="CodeDeploy-Type-ApplicationInfo-createTime"></a>
The time at which the application was created.  
Type: Timestamp  
Required: No

 ** gitHubAccountName **   <a name="CodeDeploy-Type-ApplicationInfo-gitHubAccountName"></a>
The name for a connection to a GitHub account.  
Type: String  
Required: No

 ** linkedToGitHub **   <a name="CodeDeploy-Type-ApplicationInfo-linkedToGitHub"></a>
True if the user has authenticated with GitHub for the specified application. Otherwise, false.  
Type: Boolean  
Required: No

## See Also
<a name="API_ApplicationInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ApplicationInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ApplicationInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ApplicationInfo) 

# AppSpecContent
<a name="API_AppSpecContent"></a>

 A revision for an Amazon Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Amazon Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated `RawString` data type. 

## Contents
<a name="API_AppSpecContent_Contents"></a>

 ** content **   <a name="CodeDeploy-Type-AppSpecContent-content"></a>
 The YAML-formatted or JSON-formatted revision string.   
 For an Amazon 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.   
Type: String  
Required: No

 ** sha256 **   <a name="CodeDeploy-Type-AppSpecContent-sha256"></a>
 The SHA256 hash value of the revision content.   
Type: String  
Required: No

## See Also
<a name="API_AppSpecContent_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/AppSpecContent) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/AppSpecContent) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/AppSpecContent) 

# AutoRollbackConfiguration
<a name="API_AutoRollbackConfiguration"></a>

Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.

## Contents
<a name="API_AutoRollbackConfiguration_Contents"></a>

 ** enabled **   <a name="CodeDeploy-Type-AutoRollbackConfiguration-enabled"></a>
Indicates whether a defined automatic rollback configuration is currently enabled.  
Type: Boolean  
Required: No

 ** events **   <a name="CodeDeploy-Type-AutoRollbackConfiguration-events"></a>
The event type or types that trigger a rollback.  
Type: Array of strings  
Valid Values: `DEPLOYMENT_FAILURE | DEPLOYMENT_STOP_ON_ALARM | DEPLOYMENT_STOP_ON_REQUEST`   
Required: No

## See Also
<a name="API_AutoRollbackConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/AutoRollbackConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/AutoRollbackConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/AutoRollbackConfiguration) 

# AutoScalingGroup
<a name="API_AutoScalingGroup"></a>

Information about an Auto Scaling group.

## Contents
<a name="API_AutoScalingGroup_Contents"></a>

 ** hook **   <a name="CodeDeploy-Type-AutoScalingGroup-hook"></a>
The name of the launch hook that CodeDeploy installed into the Auto Scaling group.  
For more information about the launch hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy](https://docs.amazonaws.cn/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) in the * Amazon CodeDeploy User Guide*.  
Type: String  
Required: No

 ** name **   <a name="CodeDeploy-Type-AutoScalingGroup-name"></a>
The Auto Scaling group name.  
Type: String  
Required: No

 ** terminationHook **   <a name="CodeDeploy-Type-AutoScalingGroup-terminationHook"></a>
The name of the termination hook that CodeDeploy installed into the Auto Scaling group.  
For more information about the termination hook, see [Enabling termination deployments during Auto Scaling scale-in events](https://docs.amazonaws.cn/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable) in the * Amazon CodeDeploy User Guide*.  
Type: String  
Required: No

## See Also
<a name="API_AutoScalingGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/AutoScalingGroup) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/AutoScalingGroup) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/AutoScalingGroup) 

# BlueGreenDeploymentConfiguration
<a name="API_BlueGreenDeploymentConfiguration"></a>

Information about blue/green deployment options for a deployment group.

## Contents
<a name="API_BlueGreenDeploymentConfiguration_Contents"></a>

 ** deploymentReadyOption **   <a name="CodeDeploy-Type-BlueGreenDeploymentConfiguration-deploymentReadyOption"></a>
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.  
Type: [DeploymentReadyOption](API_DeploymentReadyOption.md) object  
Required: No

 ** greenFleetProvisioningOption **   <a name="CodeDeploy-Type-BlueGreenDeploymentConfiguration-greenFleetProvisioningOption"></a>
Information about how instances are provisioned for a replacement environment in a blue/green deployment.  
Type: [GreenFleetProvisioningOption](API_GreenFleetProvisioningOption.md) object  
Required: No

 ** terminateBlueInstancesOnDeploymentSuccess **   <a name="CodeDeploy-Type-BlueGreenDeploymentConfiguration-terminateBlueInstancesOnDeploymentSuccess"></a>
Information about whether to terminate instances in the original fleet during a blue/green deployment.  
Type: [BlueInstanceTerminationOption](API_BlueInstanceTerminationOption.md) object  
Required: No

## See Also
<a name="API_BlueGreenDeploymentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/BlueGreenDeploymentConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/BlueGreenDeploymentConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/BlueGreenDeploymentConfiguration) 

# BlueInstanceTerminationOption
<a name="API_BlueInstanceTerminationOption"></a>

Information about whether instances in the original environment are terminated when a blue/green deployment is successful. `BlueInstanceTerminationOption` does not apply to Lambda deployments. 

## Contents
<a name="API_BlueInstanceTerminationOption_Contents"></a>

 ** action **   <a name="CodeDeploy-Type-BlueInstanceTerminationOption-action"></a>
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.
Type: String  
Valid Values: `TERMINATE | KEEP_ALIVE`   
Required: No

 ** terminationWaitTimeInMinutes **   <a name="CodeDeploy-Type-BlueInstanceTerminationOption-terminationWaitTimeInMinutes"></a>
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).   
Type: Integer  
Required: No

## See Also
<a name="API_BlueInstanceTerminationOption_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/BlueInstanceTerminationOption) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/BlueInstanceTerminationOption) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/BlueInstanceTerminationOption) 

# CloudFormationTarget
<a name="API_CloudFormationTarget"></a>

 Information about the target to be updated by an Amazon CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.

## Contents
<a name="API_CloudFormationTarget_Contents"></a>

 ** deploymentId **   <a name="CodeDeploy-Type-CloudFormationTarget-deploymentId"></a>
The unique ID of an Amazon CloudFormation blue/green deployment.  
Type: String  
Required: No

 ** lastUpdatedAt **   <a name="CodeDeploy-Type-CloudFormationTarget-lastUpdatedAt"></a>
 The date and time when the target application was updated by an Amazon CloudFormation blue/green deployment.   
Type: Timestamp  
Required: No

 ** lifecycleEvents **   <a name="CodeDeploy-Type-CloudFormationTarget-lifecycleEvents"></a>
 The lifecycle events of the Amazon CloudFormation blue/green deployment to this target application.   
Type: Array of [LifecycleEvent](API_LifecycleEvent.md) objects  
Required: No

 ** resourceType **   <a name="CodeDeploy-Type-CloudFormationTarget-resourceType"></a>
The resource type for the Amazon CloudFormation blue/green deployment.  
Type: String  
Required: No

 ** status **   <a name="CodeDeploy-Type-CloudFormationTarget-status"></a>
 The status of an Amazon CloudFormation blue/green deployment's target application.   
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready`   
Required: No

 ** targetId **   <a name="CodeDeploy-Type-CloudFormationTarget-targetId"></a>
 The unique ID of a deployment target that has a type of `CloudFormationTarget`.   
Type: String  
Required: No

 ** targetVersionWeight **   <a name="CodeDeploy-Type-CloudFormationTarget-targetVersionWeight"></a>
The percentage of production traffic that the target version of an Amazon CloudFormation blue/green deployment receives.  
Type: Double  
Required: No

## See Also
<a name="API_CloudFormationTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/CloudFormationTarget) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/CloudFormationTarget) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/CloudFormationTarget) 

# DeploymentConfigInfo
<a name="API_DeploymentConfigInfo"></a>

Information about a deployment configuration.

## Contents
<a name="API_DeploymentConfigInfo_Contents"></a>

 ** computePlatform **   <a name="CodeDeploy-Type-DeploymentConfigInfo-computePlatform"></a>
The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).  
Type: String  
Valid Values: `Server | Lambda | ECS | Kubernetes`   
Required: No

 ** createTime **   <a name="CodeDeploy-Type-DeploymentConfigInfo-createTime"></a>
The time at which the deployment configuration was created.  
Type: Timestamp  
Required: No

 ** deploymentConfigId **   <a name="CodeDeploy-Type-DeploymentConfigInfo-deploymentConfigId"></a>
The deployment configuration ID.  
Type: String  
Required: No

 ** deploymentConfigName **   <a name="CodeDeploy-Type-DeploymentConfigInfo-deploymentConfigName"></a>
The deployment configuration name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** minimumHealthyHosts **   <a name="CodeDeploy-Type-DeploymentConfigInfo-minimumHealthyHosts"></a>
Information about the number or percentage of minimum healthy instances.  
Type: [MinimumHealthyHosts](API_MinimumHealthyHosts.md) object  
Required: No

 ** trafficRoutingConfig **   <a name="CodeDeploy-Type-DeploymentConfigInfo-trafficRoutingConfig"></a>
The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.  
Type: [TrafficRoutingConfig](API_TrafficRoutingConfig.md) object  
Required: No

 ** zonalConfig **   <a name="CodeDeploy-Type-DeploymentConfigInfo-zonalConfig"></a>
Information about a zonal configuration.  
Type: [ZonalConfig](API_ZonalConfig.md) object  
Required: No

## See Also
<a name="API_DeploymentConfigInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentConfigInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentConfigInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentConfigInfo) 

# DeploymentGroupInfo
<a name="API_DeploymentGroupInfo"></a>

Information about a deployment group.

## Contents
<a name="API_DeploymentGroupInfo_Contents"></a>

 ** alarmConfiguration **   <a name="CodeDeploy-Type-DeploymentGroupInfo-alarmConfiguration"></a>
A list of alarms associated with the deployment group.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** applicationName **   <a name="CodeDeploy-Type-DeploymentGroupInfo-applicationName"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** autoRollbackConfiguration **   <a name="CodeDeploy-Type-DeploymentGroupInfo-autoRollbackConfiguration"></a>
Information about the automatic rollback configuration associated with the deployment group.  
Type: [AutoRollbackConfiguration](API_AutoRollbackConfiguration.md) object  
Required: No

 ** autoScalingGroups **   <a name="CodeDeploy-Type-DeploymentGroupInfo-autoScalingGroups"></a>
A list of associated Auto Scaling groups.  
Type: Array of [AutoScalingGroup](API_AutoScalingGroup.md) objects  
Required: No

 ** blueGreenDeploymentConfiguration **   <a name="CodeDeploy-Type-DeploymentGroupInfo-blueGreenDeploymentConfiguration"></a>
Information about blue/green deployment options for a deployment group.  
Type: [BlueGreenDeploymentConfiguration](API_BlueGreenDeploymentConfiguration.md) object  
Required: No

 ** computePlatform **   <a name="CodeDeploy-Type-DeploymentGroupInfo-computePlatform"></a>
The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).  
Type: String  
Valid Values: `Server | Lambda | ECS | Kubernetes`   
Required: No

 ** deploymentConfigName **   <a name="CodeDeploy-Type-DeploymentGroupInfo-deploymentConfigName"></a>
The deployment configuration name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** deploymentGroupId **   <a name="CodeDeploy-Type-DeploymentGroupInfo-deploymentGroupId"></a>
The deployment group ID.  
Type: String  
Required: No

 ** deploymentGroupName **   <a name="CodeDeploy-Type-DeploymentGroupInfo-deploymentGroupName"></a>
The deployment group name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** deploymentStyle **   <a name="CodeDeploy-Type-DeploymentGroupInfo-deploymentStyle"></a>
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.  
Type: [DeploymentStyle](API_DeploymentStyle.md) object  
Required: No

 ** ec2TagFilters **   <a name="CodeDeploy-Type-DeploymentGroupInfo-ec2TagFilters"></a>
The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.  
Type: Array of [EC2TagFilter](API_EC2TagFilter.md) objects  
Required: No

 ** ec2TagSet **   <a name="CodeDeploy-Type-DeploymentGroupInfo-ec2TagSet"></a>
Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.  
Type: [EC2TagSet](API_EC2TagSet.md) object  
Required: No

 ** ecsServices **   <a name="CodeDeploy-Type-DeploymentGroupInfo-ecsServices"></a>
 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>`.   
Type: Array of [ECSService](API_ECSService.md) objects  
Required: No

 ** lastAttemptedDeployment **   <a name="CodeDeploy-Type-DeploymentGroupInfo-lastAttemptedDeployment"></a>
Information about the most recent attempted deployment to the deployment group.  
Type: [LastDeploymentInfo](API_LastDeploymentInfo.md) object  
Required: No

 ** lastSuccessfulDeployment **   <a name="CodeDeploy-Type-DeploymentGroupInfo-lastSuccessfulDeployment"></a>
Information about the most recent successful deployment to the deployment group.  
Type: [LastDeploymentInfo](API_LastDeploymentInfo.md) object  
Required: No

 ** loadBalancerInfo **   <a name="CodeDeploy-Type-DeploymentGroupInfo-loadBalancerInfo"></a>
Information about the load balancer to use in a deployment.  
Type: [LoadBalancerInfo](API_LoadBalancerInfo.md) object  
Required: No

 ** onPremisesInstanceTagFilters **   <a name="CodeDeploy-Type-DeploymentGroupInfo-onPremisesInstanceTagFilters"></a>
The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.  
Type: Array of [TagFilter](API_TagFilter.md) objects  
Required: No

 ** onPremisesTagSet **   <a name="CodeDeploy-Type-DeploymentGroupInfo-onPremisesTagSet"></a>
Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.  
Type: [OnPremisesTagSet](API_OnPremisesTagSet.md) object  
Required: No

 ** outdatedInstancesStrategy **   <a name="CodeDeploy-Type-DeploymentGroupInfo-outdatedInstancesStrategy"></a>
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.  
If this option is set to `UPDATE` or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.  
If this option is set to `IGNORE`, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.  
Type: String  
Valid Values: `UPDATE | IGNORE`   
Required: No

 ** serviceRoleArn **   <a name="CodeDeploy-Type-DeploymentGroupInfo-serviceRoleArn"></a>
A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon services on your behalf. For more information, see [Create a Service Role for Amazon CodeDeploy](https://docs.amazonaws.cn/codedeploy/latest/userguide/getting-started-create-service-role.html) in the * Amazon CodeDeploy User Guide*.  
Type: String  
Required: No

 ** targetRevision **   <a name="CodeDeploy-Type-DeploymentGroupInfo-targetRevision"></a>
Information about the deployment group's target revision, including type and location.  
Type: [RevisionLocation](API_RevisionLocation.md) object  
Required: No

 ** terminationHookEnabled **   <a name="CodeDeploy-Type-DeploymentGroupInfo-terminationHookEnabled"></a>
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.  
For more information about the termination hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy](https://docs.amazonaws.cn/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) in the * Amazon CodeDeploy User Guide*.  
Type: Boolean  
Required: No

 ** triggerConfigurations **   <a name="CodeDeploy-Type-DeploymentGroupInfo-triggerConfigurations"></a>
Information about triggers associated with the deployment group.  
Type: Array of [TriggerConfig](API_TriggerConfig.md) objects  
Required: No

## See Also
<a name="API_DeploymentGroupInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentGroupInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentGroupInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentGroupInfo) 

# DeploymentInfo
<a name="API_DeploymentInfo"></a>

Information about a deployment.

## Contents
<a name="API_DeploymentInfo_Contents"></a>

 ** additionalDeploymentStatusInfo **   <a name="CodeDeploy-Type-DeploymentInfo-additionalDeploymentStatusInfo"></a>
 *This member has been deprecated.*   
Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.  
Type: String  
Required: No

 ** applicationName **   <a name="CodeDeploy-Type-DeploymentInfo-applicationName"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** autoRollbackConfiguration **   <a name="CodeDeploy-Type-DeploymentInfo-autoRollbackConfiguration"></a>
Information about the automatic rollback configuration associated with the deployment.  
Type: [AutoRollbackConfiguration](API_AutoRollbackConfiguration.md) object  
Required: No

 ** blueGreenDeploymentConfiguration **   <a name="CodeDeploy-Type-DeploymentInfo-blueGreenDeploymentConfiguration"></a>
Information about blue/green deployment options for this deployment.  
Type: [BlueGreenDeploymentConfiguration](API_BlueGreenDeploymentConfiguration.md) object  
Required: No

 ** completeTime **   <a name="CodeDeploy-Type-DeploymentInfo-completeTime"></a>
A timestamp that indicates when the deployment was complete.  
Type: Timestamp  
Required: No

 ** computePlatform **   <a name="CodeDeploy-Type-DeploymentInfo-computePlatform"></a>
The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).  
Type: String  
Valid Values: `Server | Lambda | ECS | Kubernetes`   
Required: No

 ** createTime **   <a name="CodeDeploy-Type-DeploymentInfo-createTime"></a>
A timestamp that indicates when the deployment was created.  
Type: Timestamp  
Required: No

 ** creator **   <a name="CodeDeploy-Type-DeploymentInfo-creator"></a>
The means by which the deployment was created:  
+  `user`: A user created the deployment.
+  `autoscaling`: Amazon EC2 Auto Scaling created the deployment.
+  `codeDeployRollback`: A rollback process created the deployment.
+  `CodeDeployAutoUpdate`: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.
Type: String  
Valid Values: `user | autoscaling | codeDeployRollback | CodeDeploy | CodeDeployAutoUpdate | CloudFormation | CloudFormationRollback | autoscalingTermination`   
Required: No

 ** deploymentConfigName **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentConfigName"></a>
 The deployment configuration name.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** deploymentGroupName **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentGroupName"></a>
 The deployment group name.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** deploymentId **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** deploymentOverview **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentOverview"></a>
A summary of the deployment status of the instances in the deployment.  
Type: [DeploymentOverview](API_DeploymentOverview.md) object  
Required: No

 ** deploymentStatusMessages **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentStatusMessages"></a>
Messages that contain information about the status of a deployment.  
Type: Array of strings  
Required: No

 ** deploymentStyle **   <a name="CodeDeploy-Type-DeploymentInfo-deploymentStyle"></a>
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.  
Type: [DeploymentStyle](API_DeploymentStyle.md) object  
Required: No

 ** description **   <a name="CodeDeploy-Type-DeploymentInfo-description"></a>
A comment about the deployment.  
Type: String  
Required: No

 ** errorInformation **   <a name="CodeDeploy-Type-DeploymentInfo-errorInformation"></a>
Information about any error associated with this deployment.  
Type: [ErrorInformation](API_ErrorInformation.md) object  
Required: No

 ** externalId **   <a name="CodeDeploy-Type-DeploymentInfo-externalId"></a>
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.  
Type: String  
Required: No

 ** fileExistsBehavior **   <a name="CodeDeploy-Type-DeploymentInfo-fileExistsBehavior"></a>
Information about how Amazon CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.  
+  `DISALLOW`: The deployment fails. This is also the default behavior if no option is specified.
+  `OVERWRITE`: The version of the file from the application revision currently being deployed replaces the version already on the instance.
+  `RETAIN`: The version of the file already on the instance is kept and used as part of the new deployment.
Type: String  
Valid Values: `DISALLOW | OVERWRITE | RETAIN`   
Required: No

 ** ignoreApplicationStopFailures **   <a name="CodeDeploy-Type-DeploymentInfo-ignoreApplicationStopFailures"></a>
 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 Amazon CodeDeploy agent runs the scripts specified for `ApplicationStop`, `BeforeBlockTraffic`, and `AfterBlockTraffic` in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.   
 If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use `ignoreApplicationStopFailures` to specify that the `ApplicationStop`, `BeforeBlockTraffic`, and `AfterBlockTraffic` failures should be ignored.   
Type: Boolean  
Required: No

 ** instanceTerminationWaitTimeStarted **   <a name="CodeDeploy-Type-DeploymentInfo-instanceTerminationWaitTimeStarted"></a>
Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP\$1ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.  
Type: Boolean  
Required: No

 ** loadBalancerInfo **   <a name="CodeDeploy-Type-DeploymentInfo-loadBalancerInfo"></a>
Information about the load balancer used in the deployment.  
Type: [LoadBalancerInfo](API_LoadBalancerInfo.md) object  
Required: No

 ** overrideAlarmConfiguration **   <a name="CodeDeploy-Type-DeploymentInfo-overrideAlarmConfiguration"></a>
Information about alarms associated with a deployment or deployment group.  
Type: [AlarmConfiguration](API_AlarmConfiguration.md) object  
Required: No

 ** previousRevision **   <a name="CodeDeploy-Type-DeploymentInfo-previousRevision"></a>
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.  
Type: [RevisionLocation](API_RevisionLocation.md) object  
Required: No

 ** relatedDeployments **   <a name="CodeDeploy-Type-DeploymentInfo-relatedDeployments"></a>
Information about deployments related to the specified deployment.  
Type: [RelatedDeployments](API_RelatedDeployments.md) object  
Required: No

 ** revision **   <a name="CodeDeploy-Type-DeploymentInfo-revision"></a>
Information about the location of stored application artifacts and the service from which to retrieve them.  
Type: [RevisionLocation](API_RevisionLocation.md) object  
Required: No

 ** rollbackInfo **   <a name="CodeDeploy-Type-DeploymentInfo-rollbackInfo"></a>
Information about a deployment rollback.  
Type: [RollbackInfo](API_RollbackInfo.md) object  
Required: No

 ** startTime **   <a name="CodeDeploy-Type-DeploymentInfo-startTime"></a>
A timestamp that indicates when the deployment was deployed to the deployment group.  
In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.  
Type: Timestamp  
Required: No

 ** status **   <a name="CodeDeploy-Type-DeploymentInfo-status"></a>
The current state of the deployment as a whole.  
Type: String  
Valid Values: `Created | Queued | InProgress | Baking | Succeeded | Failed | Stopped | Ready`   
Required: No

 ** targetInstances **   <a name="CodeDeploy-Type-DeploymentInfo-targetInstances"></a>
Information about the instances that belong to the replacement environment in a blue/green deployment.  
Type: [TargetInstances](API_TargetInstances.md) object  
Required: No

 ** updateOutdatedInstancesOnly **   <a name="CodeDeploy-Type-DeploymentInfo-updateOutdatedInstancesOnly"></a>
Indicates whether only instances that are not running the latest application revision are to be deployed to.  
Type: Boolean  
Required: No

## See Also
<a name="API_DeploymentInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentInfo) 

# DeploymentOverview
<a name="API_DeploymentOverview"></a>

Information about the deployment status of the instances in the deployment.

## Contents
<a name="API_DeploymentOverview_Contents"></a>

 ** Failed **   <a name="CodeDeploy-Type-DeploymentOverview-Failed"></a>
The number of instances in the deployment in a failed state.  
Type: Long  
Required: No

 ** InProgress **   <a name="CodeDeploy-Type-DeploymentOverview-InProgress"></a>
The number of instances in which the deployment is in progress.  
Type: Long  
Required: No

 ** Pending **   <a name="CodeDeploy-Type-DeploymentOverview-Pending"></a>
The number of instances in the deployment in a pending state.  
Type: Long  
Required: No

 ** Ready **   <a name="CodeDeploy-Type-DeploymentOverview-Ready"></a>
The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.  
Type: Long  
Required: No

 ** Skipped **   <a name="CodeDeploy-Type-DeploymentOverview-Skipped"></a>
The number of instances in the deployment in a skipped state.  
Type: Long  
Required: No

 ** Succeeded **   <a name="CodeDeploy-Type-DeploymentOverview-Succeeded"></a>
The number of instances in the deployment to which revisions have been successfully deployed.  
Type: Long  
Required: No

## See Also
<a name="API_DeploymentOverview_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentOverview) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentOverview) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentOverview) 

# DeploymentReadyOption
<a name="API_DeploymentReadyOption"></a>

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

## Contents
<a name="API_DeploymentReadyOption_Contents"></a>

 ** actionOnTimeout **   <a name="CodeDeploy-Type-DeploymentReadyOption-actionOnTimeout"></a>
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.  
+ CONTINUE\$1DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
+ STOP\$1DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using [ContinueDeployment](API_ContinueDeployment.md). If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
Type: String  
Valid Values: `CONTINUE_DEPLOYMENT | STOP_DEPLOYMENT`   
Required: No

 ** waitTimeInMinutes **   <a name="CodeDeploy-Type-DeploymentReadyOption-waitTimeInMinutes"></a>
The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the `STOP_DEPLOYMENT` option for `actionOnTimeout`.  
Type: Integer  
Required: No

## See Also
<a name="API_DeploymentReadyOption_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentReadyOption) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentReadyOption) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentReadyOption) 

# DeploymentStyle
<a name="API_DeploymentStyle"></a>

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.

## Contents
<a name="API_DeploymentStyle_Contents"></a>

 ** deploymentOption **   <a name="CodeDeploy-Type-DeploymentStyle-deploymentOption"></a>
Indicates whether to route deployment traffic behind a load balancer.  
Type: String  
Valid Values: `WITH_TRAFFIC_CONTROL | WITHOUT_TRAFFIC_CONTROL`   
Required: No

 ** deploymentType **   <a name="CodeDeploy-Type-DeploymentStyle-deploymentType"></a>
Indicates whether to run an in-place deployment or a blue/green deployment.  
Type: String  
Valid Values: `IN_PLACE | BLUE_GREEN`   
Required: No

## See Also
<a name="API_DeploymentStyle_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentStyle) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentStyle) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentStyle) 

# DeploymentTarget
<a name="API_DeploymentTarget"></a>

 Information about the deployment target. 

## Contents
<a name="API_DeploymentTarget_Contents"></a>

 ** cloudFormationTarget **   <a name="CodeDeploy-Type-DeploymentTarget-cloudFormationTarget"></a>
 Information about the target to be updated by an Amazon CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.  
Type: [CloudFormationTarget](API_CloudFormationTarget.md) object  
Required: No

 ** deploymentTargetType **   <a name="CodeDeploy-Type-DeploymentTarget-deploymentTargetType"></a>
The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.  
Type: String  
Valid Values: `InstanceTarget | LambdaTarget | ECSTarget | EKSTarget | CloudFormationTarget`   
Required: No

 ** ecsTarget **   <a name="CodeDeploy-Type-DeploymentTarget-ecsTarget"></a>
 Information about the target for a deployment that uses the Amazon ECS compute platform.   
Type: [ECSTarget](API_ECSTarget.md) object  
Required: No

 ** instanceTarget **   <a name="CodeDeploy-Type-DeploymentTarget-instanceTarget"></a>
 Information about the target for a deployment that uses the EC2/On-premises compute platform.   
Type: [InstanceTarget](API_InstanceTarget.md) object  
Required: No

 ** lambdaTarget **   <a name="CodeDeploy-Type-DeploymentTarget-lambdaTarget"></a>
 Information about the target for a deployment that uses the Amazon Lambda compute platform.   
Type: [LambdaTarget](API_LambdaTarget.md) object  
Required: No

## See Also
<a name="API_DeploymentTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/DeploymentTarget) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/DeploymentTarget) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/DeploymentTarget) 

# Diagnostics
<a name="API_Diagnostics"></a>

Diagnostic information about executable scripts that are part of a deployment.

## Contents
<a name="API_Diagnostics_Contents"></a>

 ** errorCode **   <a name="CodeDeploy-Type-Diagnostics-errorCode"></a>
The associated error code:  
+ Success: The specified script ran.
+ ScriptMissing: The specified script was not found in the specified location.
+ ScriptNotExecutable: The specified script is not a recognized executable file type.
+ ScriptTimedOut: The specified script did not finish running in the specified time period.
+ ScriptFailed: The specified script failed to run as expected.
+ UnknownError: The specified script did not run for an unknown reason.
Type: String  
Valid Values: `Success | ScriptMissing | ScriptNotExecutable | ScriptTimedOut | ScriptFailed | UnknownError`   
Required: No

 ** logTail **   <a name="CodeDeploy-Type-Diagnostics-logTail"></a>
The last portion of the diagnostic log.  
If available, Amazon CodeDeploy returns up to the last 4 KB of the diagnostic log.  
Type: String  
Required: No

 ** message **   <a name="CodeDeploy-Type-Diagnostics-message"></a>
The message associated with the error.  
Type: String  
Required: No

 ** scriptName **   <a name="CodeDeploy-Type-Diagnostics-scriptName"></a>
The name of the script.  
Type: String  
Required: No

## See Also
<a name="API_Diagnostics_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/Diagnostics) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/Diagnostics) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/Diagnostics) 

# EC2TagFilter
<a name="API_EC2TagFilter"></a>

Information about an EC2 tag filter.

## Contents
<a name="API_EC2TagFilter_Contents"></a>

 ** Key **   <a name="CodeDeploy-Type-EC2TagFilter-Key"></a>
The tag filter key.  
Type: String  
Required: No

 ** Type **   <a name="CodeDeploy-Type-EC2TagFilter-Type"></a>
The tag filter type:  
+  `KEY_ONLY`: Key only.
+  `VALUE_ONLY`: Value only.
+  `KEY_AND_VALUE`: Key and value.
Type: String  
Valid Values: `KEY_ONLY | VALUE_ONLY | KEY_AND_VALUE`   
Required: No

 ** Value **   <a name="CodeDeploy-Type-EC2TagFilter-Value"></a>
The tag filter value.  
Type: String  
Required: No

## See Also
<a name="API_EC2TagFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/EC2TagFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/EC2TagFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/EC2TagFilter) 

# EC2TagSet
<a name="API_EC2TagSet"></a>

Information about groups of Amazon EC2 instance tags.

## Contents
<a name="API_EC2TagSet_Contents"></a>

 ** ec2TagSetList **   <a name="CodeDeploy-Type-EC2TagSet-ec2TagSetList"></a>
A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.  
Type: Array of arrays of [EC2TagFilter](API_EC2TagFilter.md) objects  
Required: No

## See Also
<a name="API_EC2TagSet_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/EC2TagSet) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/EC2TagSet) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/EC2TagSet) 

# ECSService
<a name="API_ECSService"></a>

 Contains the service and cluster names used to identify an Amazon ECS deployment's target. 

## Contents
<a name="API_ECSService_Contents"></a>

 ** clusterName **   <a name="CodeDeploy-Type-ECSService-clusterName"></a>
 The name of the cluster that the Amazon ECS service is associated with.   
Type: String  
Required: No

 ** serviceName **   <a name="CodeDeploy-Type-ECSService-serviceName"></a>
 The name of the target Amazon ECS service.   
Type: String  
Required: No

## See Also
<a name="API_ECSService_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ECSService) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ECSService) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ECSService) 

# ECSTarget
<a name="API_ECSTarget"></a>

 Information about the target of an Amazon ECS deployment. 

## Contents
<a name="API_ECSTarget_Contents"></a>

 ** deploymentId **   <a name="CodeDeploy-Type-ECSTarget-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** lastUpdatedAt **   <a name="CodeDeploy-Type-ECSTarget-lastUpdatedAt"></a>
 The date and time when the target Amazon ECS application was updated by a deployment.   
Type: Timestamp  
Required: No

 ** lifecycleEvents **   <a name="CodeDeploy-Type-ECSTarget-lifecycleEvents"></a>
 The lifecycle events of the deployment to this target Amazon ECS application.   
Type: Array of [LifecycleEvent](API_LifecycleEvent.md) objects  
Required: No

 ** status **   <a name="CodeDeploy-Type-ECSTarget-status"></a>
 The status an Amazon ECS deployment's target ECS application.   
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready`   
Required: No

 ** targetArn **   <a name="CodeDeploy-Type-ECSTarget-targetArn"></a>
 The Amazon Resource Name (ARN) of the target.   
Type: String  
Required: No

 ** targetId **   <a name="CodeDeploy-Type-ECSTarget-targetId"></a>
 The unique ID of a deployment target that has a type of `ecsTarget`.   
Type: String  
Required: No

 ** taskSetsInfo **   <a name="CodeDeploy-Type-ECSTarget-taskSetsInfo"></a>
 The `ECSTaskSet` objects associated with the ECS target.   
Type: Array of [ECSTaskSet](API_ECSTaskSet.md) objects  
Required: No

## See Also
<a name="API_ECSTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ECSTarget) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ECSTarget) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ECSTarget) 

# ECSTaskSet
<a name="API_ECSTaskSet"></a>

 Information about a set of Amazon ECS tasks in an Amazon CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An Amazon CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set. 

## Contents
<a name="API_ECSTaskSet_Contents"></a>

 ** desiredCount **   <a name="CodeDeploy-Type-ECSTaskSet-desiredCount"></a>
 The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.   
Type: Long  
Required: No

 ** identifer **   <a name="CodeDeploy-Type-ECSTaskSet-identifer"></a>
 A unique ID of an `ECSTaskSet`.   
Type: String  
Required: No

 ** pendingCount **   <a name="CodeDeploy-Type-ECSTaskSet-pendingCount"></a>
 The number of tasks in the task set that are in the `PENDING` status during an Amazon ECS deployment. A task in the `PENDING` state is preparing to enter the `RUNNING` state. A task set enters the `PENDING` status when it launches for the first time, or when it is restarted after being in the `STOPPED` state.   
Type: Long  
Required: No

 ** runningCount **   <a name="CodeDeploy-Type-ECSTaskSet-runningCount"></a>
 The number of tasks in the task set that are in the `RUNNING` status during an Amazon ECS deployment. A task in the `RUNNING` state is running and ready for use.   
Type: Long  
Required: No

 ** status **   <a name="CodeDeploy-Type-ECSTaskSet-status"></a>
 The status of the task set. There are three valid task set statuses:   
+  `PRIMARY`: Indicates the task set is serving production traffic. 
+  `ACTIVE`: Indicates the task set is not serving production traffic. 
+  `DRAINING`: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. 
Type: String  
Required: No

 ** targetGroup **   <a name="CodeDeploy-Type-ECSTaskSet-targetGroup"></a>
 The target group associated with the task set. The target group is used by Amazon CodeDeploy to manage traffic to a task set.   
Type: [TargetGroupInfo](API_TargetGroupInfo.md) object  
Required: No

 ** taskSetLabel **   <a name="CodeDeploy-Type-ECSTaskSet-taskSetLabel"></a>
 A label that identifies whether the ECS task set is an original target (`BLUE`) or a replacement target (`GREEN`).   
Type: String  
Valid Values: `Blue | Green`   
Required: No

 ** trafficWeight **   <a name="CodeDeploy-Type-ECSTaskSet-trafficWeight"></a>
 The percentage of traffic served by this task set.   
Type: Double  
Required: No

## See Also
<a name="API_ECSTaskSet_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ECSTaskSet) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ECSTaskSet) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ECSTaskSet) 

# ELBInfo
<a name="API_ELBInfo"></a>

Information about a Classic 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.

## Contents
<a name="API_ELBInfo_Contents"></a>

 ** name **   <a name="CodeDeploy-Type-ELBInfo-name"></a>
For blue/green deployments, the name of the Classic Load Balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the Classic Load Balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.  
Type: String  
Required: No

## See Also
<a name="API_ELBInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ELBInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ELBInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ELBInfo) 

# ErrorInformation
<a name="API_ErrorInformation"></a>

Information about a deployment error.

## Contents
<a name="API_ErrorInformation_Contents"></a>

 ** code **   <a name="CodeDeploy-Type-ErrorInformation-code"></a>
For more information, see [Error Codes for Amazon CodeDeploy](https://docs.amazonaws.cn/codedeploy/latest/userguide/error-codes.html) in the [Amazon CodeDeploy User Guide](https://docs.amazonaws.cn/codedeploy/latest/userguide).  
The error code:  
+ APPLICATION\$1MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
+ DEPLOYMENT\$1GROUP\$1MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
+ HEALTH\$1CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
+ HEALTH\$1CONSTRAINTS\$1INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
+ IAM\$1ROLE\$1MISSING: The service role cannot be accessed.
+ IAM\$1ROLE\$1PERMISSIONS: The service role does not have the correct permissions.
+ INTERNAL\$1ERROR: There was an internal error.
+ NO\$1EC2\$1SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
+ NO\$1INSTANCES: No instances were specified, or no instances can be found.
+ OVER\$1MAX\$1INSTANCES: The maximum number of instances was exceeded.
+ THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon services.
+ TIMEOUT: The deployment has timed out.
+ REVISION\$1MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
Type: String  
Valid Values: `AGENT_ISSUE | ALARM_ACTIVE | APPLICATION_MISSING | AUTOSCALING_VALIDATION_ERROR | AUTO_SCALING_CONFIGURATION | AUTO_SCALING_IAM_ROLE_PERMISSIONS | CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND | CUSTOMER_APPLICATION_UNHEALTHY | DEPLOYMENT_GROUP_MISSING | ECS_UPDATE_ERROR | ELASTIC_LOAD_BALANCING_INVALID | ELB_INVALID_INSTANCE | HEALTH_CONSTRAINTS | HEALTH_CONSTRAINTS_INVALID | HOOK_EXECUTION_FAILURE | IAM_ROLE_MISSING | IAM_ROLE_PERMISSIONS | INTERNAL_ERROR | INVALID_ECS_SERVICE | INVALID_LAMBDA_CONFIGURATION | INVALID_LAMBDA_FUNCTION | INVALID_REVISION | MANUAL_STOP | MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION | MISSING_ELB_INFORMATION | MISSING_GITHUB_TOKEN | NO_EC2_SUBSCRIPTION | NO_INSTANCES | OVER_MAX_INSTANCES | RESOURCE_LIMIT_EXCEEDED | REVISION_MISSING | THROTTLED | TIMEOUT | CLOUDFORMATION_STACK_FAILURE | INVALID_EKS_CLUSTER | KUBERNETES_UPDATE_ERROR`   
Required: No

 ** message **   <a name="CodeDeploy-Type-ErrorInformation-message"></a>
An accompanying error message.  
Type: String  
Required: No

## See Also
<a name="API_ErrorInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ErrorInformation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ErrorInformation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ErrorInformation) 

# GenericRevisionInfo
<a name="API_GenericRevisionInfo"></a>

Information about an application revision.

## Contents
<a name="API_GenericRevisionInfo_Contents"></a>

 ** deploymentGroups **   <a name="CodeDeploy-Type-GenericRevisionInfo-deploymentGroups"></a>
The deployment groups for which this is the current target revision.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** description **   <a name="CodeDeploy-Type-GenericRevisionInfo-description"></a>
A comment about the revision.  
Type: String  
Required: No

 ** firstUsedTime **   <a name="CodeDeploy-Type-GenericRevisionInfo-firstUsedTime"></a>
When the revision was first used by Amazon CodeDeploy.  
Type: Timestamp  
Required: No

 ** lastUsedTime **   <a name="CodeDeploy-Type-GenericRevisionInfo-lastUsedTime"></a>
When the revision was last used by Amazon CodeDeploy.  
Type: Timestamp  
Required: No

 ** registerTime **   <a name="CodeDeploy-Type-GenericRevisionInfo-registerTime"></a>
When the revision was registered with Amazon CodeDeploy.  
Type: Timestamp  
Required: No

## See Also
<a name="API_GenericRevisionInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/GenericRevisionInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/GenericRevisionInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/GenericRevisionInfo) 

# GitHubLocation
<a name="API_GitHubLocation"></a>

Information about the location of application artifacts stored in GitHub.

## Contents
<a name="API_GitHubLocation_Contents"></a>

 ** commitId **   <a name="CodeDeploy-Type-GitHubLocation-commitId"></a>
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.  
Type: String  
Required: No

 ** repository **   <a name="CodeDeploy-Type-GitHubLocation-repository"></a>
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.   
Specified as account/repository.  
Type: String  
Required: No

## See Also
<a name="API_GitHubLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/GitHubLocation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/GitHubLocation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/GitHubLocation) 

# GreenFleetProvisioningOption
<a name="API_GreenFleetProvisioningOption"></a>

Information about the instances that belong to the replacement environment in a blue/green deployment.

## Contents
<a name="API_GreenFleetProvisioningOption_Contents"></a>

 ** action **   <a name="CodeDeploy-Type-GreenFleetProvisioningOption-action"></a>
The method used to add instances to a replacement environment.  
+  `DISCOVER_EXISTING`: Use instances that already exist or will be created manually.
+  `COPY_AUTO_SCALING_GROUP`: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.
Type: String  
Valid Values: `DISCOVER_EXISTING | COPY_AUTO_SCALING_GROUP`   
Required: No

## See Also
<a name="API_GreenFleetProvisioningOption_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/GreenFleetProvisioningOption) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/GreenFleetProvisioningOption) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/GreenFleetProvisioningOption) 

# InstanceInfo
<a name="API_InstanceInfo"></a>

Information about an on-premises instance.

## Contents
<a name="API_InstanceInfo_Contents"></a>

 ** deregisterTime **   <a name="CodeDeploy-Type-InstanceInfo-deregisterTime"></a>
If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.  
Type: Timestamp  
Required: No

 ** iamSessionArn **   <a name="CodeDeploy-Type-InstanceInfo-iamSessionArn"></a>
The ARN of the IAM session associated with the on-premises instance.  
Type: String  
Required: No

 ** iamUserArn **   <a name="CodeDeploy-Type-InstanceInfo-iamUserArn"></a>
The user ARN associated with the on-premises instance.  
Type: String  
Required: No

 ** instanceArn **   <a name="CodeDeploy-Type-InstanceInfo-instanceArn"></a>
The ARN of the on-premises instance.  
Type: String  
Required: No

 ** instanceName **   <a name="CodeDeploy-Type-InstanceInfo-instanceName"></a>
The name of the on-premises instance.  
Type: String  
Required: No

 ** registerTime **   <a name="CodeDeploy-Type-InstanceInfo-registerTime"></a>
The time at which the on-premises instance was registered.  
Type: Timestamp  
Required: No

 ** tags **   <a name="CodeDeploy-Type-InstanceInfo-tags"></a>
The tags currently associated with the on-premises instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_InstanceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/InstanceInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/InstanceInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/InstanceInfo) 

# InstanceSummary
<a name="API_InstanceSummary"></a>

 *This data type has been deprecated.* 

Information about an instance in a deployment.

## Contents
<a name="API_InstanceSummary_Contents"></a>

 ** deploymentId **   <a name="CodeDeploy-Type-InstanceSummary-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** instanceId **   <a name="CodeDeploy-Type-InstanceSummary-instanceId"></a>
The instance ID.  
Type: String  
Required: No

 ** instanceType **   <a name="CodeDeploy-Type-InstanceSummary-instanceType"></a>
Information about which environment an instance belongs to in a blue/green deployment.  
+ BLUE: The instance is part of the original environment.
+ GREEN: The instance is part of the replacement environment.
Type: String  
Valid Values: `Blue | Green`   
Required: No

 ** lastUpdatedAt **   <a name="CodeDeploy-Type-InstanceSummary-lastUpdatedAt"></a>
A timestamp that indicates when the instance information was last updated.  
Type: Timestamp  
Required: No

 ** lifecycleEvents **   <a name="CodeDeploy-Type-InstanceSummary-lifecycleEvents"></a>
A list of lifecycle events for this instance.  
Type: Array of [LifecycleEvent](API_LifecycleEvent.md) objects  
Required: No

 ** status **   <a name="CodeDeploy-Type-InstanceSummary-status"></a>
 *This member has been deprecated.*   
The deployment status for this instance:  
+  `Pending`: The deployment is pending for this instance.
+  `In Progress`: The deployment is in progress for this instance.
+  `Succeeded`: The deployment has succeeded for this instance.
+  `Failed`: The deployment has failed for this instance.
+  `Skipped`: The deployment has been skipped for this instance.
+  `Unknown`: The deployment status is unknown for this instance.
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready`   
Required: No

## See Also
<a name="API_InstanceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/InstanceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/InstanceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/InstanceSummary) 

# InstanceTarget
<a name="API_InstanceTarget"></a>

 A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform. 

## Contents
<a name="API_InstanceTarget_Contents"></a>

 ** deploymentId **   <a name="CodeDeploy-Type-InstanceTarget-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** instanceLabel **   <a name="CodeDeploy-Type-InstanceTarget-instanceLabel"></a>
 A label that identifies whether the instance is an original target (`BLUE`) or a replacement target (`GREEN`).   
Type: String  
Valid Values: `Blue | Green`   
Required: No

 ** lastUpdatedAt **   <a name="CodeDeploy-Type-InstanceTarget-lastUpdatedAt"></a>
 The date and time when the target instance was updated by a deployment.   
Type: Timestamp  
Required: No

 ** lifecycleEvents **   <a name="CodeDeploy-Type-InstanceTarget-lifecycleEvents"></a>
 The lifecycle events of the deployment to this target instance.   
Type: Array of [LifecycleEvent](API_LifecycleEvent.md) objects  
Required: No

 ** status **   <a name="CodeDeploy-Type-InstanceTarget-status"></a>
 The status an EC2/On-premises deployment's target instance.   
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready`   
Required: No

 ** targetArn **   <a name="CodeDeploy-Type-InstanceTarget-targetArn"></a>
 The Amazon Resource Name (ARN) of the target.   
Type: String  
Required: No

 ** targetId **   <a name="CodeDeploy-Type-InstanceTarget-targetId"></a>
 The unique ID of a deployment target that has a type of `instanceTarget`.   
Type: String  
Required: No

## See Also
<a name="API_InstanceTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/InstanceTarget) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/InstanceTarget) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/InstanceTarget) 

# LambdaFunctionInfo
<a name="API_LambdaFunctionInfo"></a>

 Information about a Lambda function specified in a deployment. 

## Contents
<a name="API_LambdaFunctionInfo_Contents"></a>

 ** currentVersion **   <a name="CodeDeploy-Type-LambdaFunctionInfo-currentVersion"></a>
 The version of a Lambda function that production traffic points to.   
Type: String  
Required: No

 ** functionAlias **   <a name="CodeDeploy-Type-LambdaFunctionInfo-functionAlias"></a>
 The alias of a Lambda function. For more information, see [Amazon Lambda Function Aliases](https://docs.amazonaws.cn/lambda/latest/dg/aliases-intro.html) in the * Amazon Lambda Developer Guide*.  
Type: String  
Required: No

 ** functionName **   <a name="CodeDeploy-Type-LambdaFunctionInfo-functionName"></a>
 The name of a Lambda function.   
Type: String  
Required: No

 ** targetVersion **   <a name="CodeDeploy-Type-LambdaFunctionInfo-targetVersion"></a>
 The version of a Lambda function that production traffic points to after the Lambda function is deployed.   
Type: String  
Required: No

 ** targetVersionWeight **   <a name="CodeDeploy-Type-LambdaFunctionInfo-targetVersionWeight"></a>
 The percentage of production traffic that the target version of a Lambda function receives.   
Type: Double  
Required: No

## See Also
<a name="API_LambdaFunctionInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/LambdaFunctionInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/LambdaFunctionInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/LambdaFunctionInfo) 

# LambdaTarget
<a name="API_LambdaTarget"></a>

 Information about the target Amazon Lambda function during an Amazon Lambda deployment. 

## Contents
<a name="API_LambdaTarget_Contents"></a>

 ** deploymentId **   <a name="CodeDeploy-Type-LambdaTarget-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** lambdaFunctionInfo **   <a name="CodeDeploy-Type-LambdaTarget-lambdaFunctionInfo"></a>
 A `LambdaFunctionInfo` object that describes a target Lambda function.   
Type: [LambdaFunctionInfo](API_LambdaFunctionInfo.md) object  
Required: No

 ** lastUpdatedAt **   <a name="CodeDeploy-Type-LambdaTarget-lastUpdatedAt"></a>
 The date and time when the target Lambda function was updated by a deployment.   
Type: Timestamp  
Required: No

 ** lifecycleEvents **   <a name="CodeDeploy-Type-LambdaTarget-lifecycleEvents"></a>
 The lifecycle events of the deployment to this target Lambda function.   
Type: Array of [LifecycleEvent](API_LifecycleEvent.md) objects  
Required: No

 ** status **   <a name="CodeDeploy-Type-LambdaTarget-status"></a>
 The status an Amazon Lambda deployment's target Lambda function.   
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready`   
Required: No

 ** targetArn **   <a name="CodeDeploy-Type-LambdaTarget-targetArn"></a>
 The Amazon Resource Name (ARN) of the target.   
Type: String  
Required: No

 ** targetId **   <a name="CodeDeploy-Type-LambdaTarget-targetId"></a>
 The unique ID of a deployment target that has a type of `lambdaTarget`.   
Type: String  
Required: No

## See Also
<a name="API_LambdaTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/LambdaTarget) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/LambdaTarget) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/LambdaTarget) 

# LastDeploymentInfo
<a name="API_LastDeploymentInfo"></a>

Information about the most recent attempted or successful deployment to a deployment group.

## Contents
<a name="API_LastDeploymentInfo_Contents"></a>

 ** createTime **   <a name="CodeDeploy-Type-LastDeploymentInfo-createTime"></a>
A timestamp that indicates when the most recent deployment to the deployment group started.  
Type: Timestamp  
Required: No

 ** deploymentId **   <a name="CodeDeploy-Type-LastDeploymentInfo-deploymentId"></a>
 The unique ID of a deployment.   
Type: String  
Required: No

 ** endTime **   <a name="CodeDeploy-Type-LastDeploymentInfo-endTime"></a>
A timestamp that indicates when the most recent deployment to the deployment group was complete.  
Type: Timestamp  
Required: No

 ** status **   <a name="CodeDeploy-Type-LastDeploymentInfo-status"></a>
The status of the most recent deployment.  
Type: String  
Valid Values: `Created | Queued | InProgress | Baking | Succeeded | Failed | Stopped | Ready`   
Required: No

## See Also
<a name="API_LastDeploymentInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/LastDeploymentInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/LastDeploymentInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/LastDeploymentInfo) 

# LifecycleEvent
<a name="API_LifecycleEvent"></a>

Information about a deployment lifecycle event.

## Contents
<a name="API_LifecycleEvent_Contents"></a>

 ** diagnostics **   <a name="CodeDeploy-Type-LifecycleEvent-diagnostics"></a>
Diagnostic information about the deployment lifecycle event.  
Type: [Diagnostics](API_Diagnostics.md) object  
Required: No

 ** endTime **   <a name="CodeDeploy-Type-LifecycleEvent-endTime"></a>
A timestamp that indicates when the deployment lifecycle event ended.  
Type: Timestamp  
Required: No

 ** lifecycleEventName **   <a name="CodeDeploy-Type-LifecycleEvent-lifecycleEventName"></a>
The deployment lifecycle event name, such as `ApplicationStop`, `BeforeInstall`, `AfterInstall`, `ApplicationStart`, or `ValidateService`.  
Type: String  
Required: No

 ** startTime **   <a name="CodeDeploy-Type-LifecycleEvent-startTime"></a>
A timestamp that indicates when the deployment lifecycle event started.  
Type: Timestamp  
Required: No

 ** status **   <a name="CodeDeploy-Type-LifecycleEvent-status"></a>
The deployment lifecycle event status:  
+ Pending: The deployment lifecycle event is pending.
+ InProgress: The deployment lifecycle event is in progress.
+ Succeeded: The deployment lifecycle event ran successfully.
+ Failed: The deployment lifecycle event has failed.
+ Skipped: The deployment lifecycle event has been skipped.
+ Unknown: The deployment lifecycle event is unknown.
Type: String  
Valid Values: `Pending | InProgress | Succeeded | Failed | Skipped | Unknown`   
Required: No

## See Also
<a name="API_LifecycleEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/LifecycleEvent) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/LifecycleEvent) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/LifecycleEvent) 

# LoadBalancerInfo
<a name="API_LoadBalancerInfo"></a>

Information about the Elastic Load Balancing load balancer or target group used in a deployment.

You can use load balancers and target groups in combination. For example, if you have two Classic Load Balancers, and five target groups tied to an Application Load Balancer, you can specify the two Classic Load Balancers in `elbInfoList`, and the five target groups in `targetGroupInfoList`.

## Contents
<a name="API_LoadBalancerInfo_Contents"></a>

 ** elbInfoList **   <a name="CodeDeploy-Type-LoadBalancerInfo-elbInfoList"></a>
An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.   
You can add up to 10 load balancers to the array.
If you're using Application Load Balancers or Network Load Balancers, use the `targetGroupInfoList` array instead of this one.
Type: Array of [ELBInfo](API_ELBInfo.md) objects  
Required: No

 ** targetGroupInfoList **   <a name="CodeDeploy-Type-LoadBalancerInfo-targetGroupInfoList"></a>
An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.  
You can add up to 10 target groups to the array.
If you're using Classic Load Balancers, use the `elbInfoList` array instead of this one.
Type: Array of [TargetGroupInfo](API_TargetGroupInfo.md) objects  
Required: No

 ** targetGroupPairInfoList **   <a name="CodeDeploy-Type-LoadBalancerInfo-targetGroupPairInfoList"></a>
 The target group pair information. This is an array of `TargeGroupPairInfo` objects with a maximum size of one.   
Type: Array of [TargetGroupPairInfo](API_TargetGroupPairInfo.md) objects  
Required: No

## See Also
<a name="API_LoadBalancerInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/LoadBalancerInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/LoadBalancerInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/LoadBalancerInfo) 

# MinimumHealthyHosts
<a name="API_MinimumHealthyHosts"></a>

Information about the minimum number of healthy instances.

## Contents
<a name="API_MinimumHealthyHosts_Contents"></a>

 ** type **   <a name="CodeDeploy-Type-MinimumHealthyHosts-type"></a>
The minimum healthy instance type:  
+  `HOST_COUNT`: The minimum number of healthy instances as an absolute value.
+  `FLEET_PERCENT`: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
In an example of nine instances, if a HOST\$1COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET\$1PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.  
In a call to the `GetDeploymentConfig`, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST\$1CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST\$1CONCURRENCY, only to HOST\$1COUNT or FLEET\$1PERCENT.) In addition, with CodeDeployDefault.OneAtATime, Amazon CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.
For more information, see [Amazon CodeDeploy Instance Health](https://docs.amazonaws.cn/codedeploy/latest/userguide/instances-health.html) in the * Amazon CodeDeploy User Guide*.  
Type: String  
Valid Values: `HOST_COUNT | FLEET_PERCENT`   
Required: No

 ** value **   <a name="CodeDeploy-Type-MinimumHealthyHosts-value"></a>
The minimum healthy instance value.  
Type: Integer  
Required: No

## See Also
<a name="API_MinimumHealthyHosts_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/MinimumHealthyHosts) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/MinimumHealthyHosts) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/MinimumHealthyHosts) 

# MinimumHealthyHostsPerZone
<a name="API_MinimumHealthyHostsPerZone"></a>

Information about the minimum number of healthy instances per Availability Zone.

## Contents
<a name="API_MinimumHealthyHostsPerZone_Contents"></a>

 ** type **   <a name="CodeDeploy-Type-MinimumHealthyHostsPerZone-type"></a>
The `type` associated with the `MinimumHealthyHostsPerZone` option.  
Type: String  
Valid Values: `HOST_COUNT | FLEET_PERCENT`   
Required: No

 ** value **   <a name="CodeDeploy-Type-MinimumHealthyHostsPerZone-value"></a>
The `value` associated with the `MinimumHealthyHostsPerZone` option.  
Type: Integer  
Required: No

## See Also
<a name="API_MinimumHealthyHostsPerZone_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/MinimumHealthyHostsPerZone) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/MinimumHealthyHostsPerZone) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/MinimumHealthyHostsPerZone) 

# OnPremisesTagSet
<a name="API_OnPremisesTagSet"></a>

Information about groups of on-premises instance tags.

## Contents
<a name="API_OnPremisesTagSet_Contents"></a>

 ** onPremisesTagSetList **   <a name="CodeDeploy-Type-OnPremisesTagSet-onPremisesTagSetList"></a>
A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.  
Type: Array of arrays of [TagFilter](API_TagFilter.md) objects  
Required: No

## See Also
<a name="API_OnPremisesTagSet_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/OnPremisesTagSet) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/OnPremisesTagSet) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/OnPremisesTagSet) 

# RawString
<a name="API_RawString"></a>

 *This data type has been deprecated.* 

A revision for an Amazon Lambda deployment that is a YAML-formatted or JSON-formatted string. For Amazon Lambda deployments, the revision is the same as the AppSpec file.

## Contents
<a name="API_RawString_Contents"></a>

 ** content **   <a name="CodeDeploy-Type-RawString-content"></a>
The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.  
Type: String  
Required: No

 ** sha256 **   <a name="CodeDeploy-Type-RawString-sha256"></a>
The SHA256 hash value of the revision content.  
Type: String  
Required: No

## See Also
<a name="API_RawString_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/RawString) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/RawString) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/RawString) 

# RelatedDeployments
<a name="API_RelatedDeployments"></a>

Information about deployments related to the specified deployment.

## Contents
<a name="API_RelatedDeployments_Contents"></a>

 ** autoUpdateOutdatedInstancesDeploymentIds **   <a name="CodeDeploy-Type-RelatedDeployments-autoUpdateOutdatedInstancesDeploymentIds"></a>
The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.  
Type: Array of strings  
Required: No

 ** autoUpdateOutdatedInstancesRootDeploymentId **   <a name="CodeDeploy-Type-RelatedDeployments-autoUpdateOutdatedInstancesRootDeploymentId"></a>
The deployment ID of the root deployment that triggered this deployment.  
Type: String  
Required: No

## See Also
<a name="API_RelatedDeployments_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/RelatedDeployments) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/RelatedDeployments) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/RelatedDeployments) 

# RevisionInfo
<a name="API_RevisionInfo"></a>

Information about an application revision.

## Contents
<a name="API_RevisionInfo_Contents"></a>

 ** genericRevisionInfo **   <a name="CodeDeploy-Type-RevisionInfo-genericRevisionInfo"></a>
Information about an application revision, including usage details and associated deployment groups.  
Type: [GenericRevisionInfo](API_GenericRevisionInfo.md) object  
Required: No

 ** revisionLocation **   <a name="CodeDeploy-Type-RevisionInfo-revisionLocation"></a>
Information about the location and type of an application revision.  
Type: [RevisionLocation](API_RevisionLocation.md) object  
Required: No

## See Also
<a name="API_RevisionInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/RevisionInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/RevisionInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/RevisionInfo) 

# RevisionLocation
<a name="API_RevisionLocation"></a>

Information about the location of an application revision.

## Contents
<a name="API_RevisionLocation_Contents"></a>

 ** appSpecContent **   <a name="CodeDeploy-Type-RevisionLocation-appSpecContent"></a>
 The content of an AppSpec file for an Amazon Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.   
Type: [AppSpecContent](API_AppSpecContent.md) object  
Required: No

 ** gitHubLocation **   <a name="CodeDeploy-Type-RevisionLocation-gitHubLocation"></a>
Information about the location of application artifacts stored in GitHub.  
Type: [GitHubLocation](API_GitHubLocation.md) object  
Required: No

 ** revisionType **   <a name="CodeDeploy-Type-RevisionLocation-revisionType"></a>
The type of application revision:  
+ S3: An application revision stored in Amazon S3.
+ GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
+ String: A YAML-formatted or JSON-formatted string (Amazon Lambda deployments only).
+ AppSpecContent: An `AppSpecContent` object that contains the contents of an AppSpec file for an Amazon Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
Type: String  
Valid Values: `S3 | GitHub | String | AppSpecContent | SystemsManagerPatchBaseline`   
Required: No

 ** s3Location **   <a name="CodeDeploy-Type-RevisionLocation-s3Location"></a>
Information about the location of a revision stored in Amazon S3.   
Type: [S3Location](API_S3Location.md) object  
Required: No

 ** string **   <a name="CodeDeploy-Type-RevisionLocation-string"></a>
 *This member has been deprecated.*   
Information about the location of an Amazon Lambda deployment revision stored as a RawString.  
Type: [RawString](API_RawString.md) object  
Required: No

## See Also
<a name="API_RevisionLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/RevisionLocation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/RevisionLocation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/RevisionLocation) 

# RollbackInfo
<a name="API_RollbackInfo"></a>

Information about a deployment rollback.

## Contents
<a name="API_RollbackInfo_Contents"></a>

 ** rollbackDeploymentId **   <a name="CodeDeploy-Type-RollbackInfo-rollbackDeploymentId"></a>
The ID of the deployment rollback.  
Type: String  
Required: No

 ** rollbackMessage **   <a name="CodeDeploy-Type-RollbackInfo-rollbackMessage"></a>
Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded).   
Type: String  
Required: No

 ** rollbackTriggeringDeploymentId **   <a name="CodeDeploy-Type-RollbackInfo-rollbackTriggeringDeploymentId"></a>
The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.  
Type: String  
Required: No

## See Also
<a name="API_RollbackInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/RollbackInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/RollbackInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/RollbackInfo) 

# S3Location
<a name="API_S3Location"></a>

Information about the location of application artifacts stored in Amazon S3.

## Contents
<a name="API_S3Location_Contents"></a>

 ** bucket **   <a name="CodeDeploy-Type-S3Location-bucket"></a>
The name of the Amazon S3 bucket where the application revision is stored.  
Type: String  
Required: No

 ** bundleType **   <a name="CodeDeploy-Type-S3Location-bundleType"></a>
The file type of the application revision. Must be one of the following:  
+  `tar`: A tar archive file.
+  `tgz`: A compressed tar archive file.
+  `zip`: A zip archive file.
+  `YAML`: A YAML-formatted file.
+  `JSON`: A JSON-formatted file.
Type: String  
Valid Values: `tar | tgz | zip | YAML | JSON`   
Required: No

 ** eTag **   <a name="CodeDeploy-Type-S3Location-eTag"></a>
The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.  
If the ETag is not specified as an input parameter, ETag validation of the object is skipped.  
Type: String  
Required: No

 ** key **   <a name="CodeDeploy-Type-S3Location-key"></a>
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.  
Type: String  
Required: No

 ** version **   <a name="CodeDeploy-Type-S3Location-version"></a>
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.  
If the version is not specified, the system uses the most recent version by default.  
Type: String  
Required: No

## See Also
<a name="API_S3Location_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/S3Location) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/S3Location) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/S3Location) 

# Tag
<a name="API_Tag"></a>

Information about a tag.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="CodeDeploy-Type-Tag-Key"></a>
The tag's key.  
Type: String  
Required: No

 ** Value **   <a name="CodeDeploy-Type-Tag-Value"></a>
The tag's value.  
Type: String  
Required: No

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/Tag) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/Tag) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/Tag) 

# TagFilter
<a name="API_TagFilter"></a>

Information about an on-premises instance tag filter.

## Contents
<a name="API_TagFilter_Contents"></a>

 ** Key **   <a name="CodeDeploy-Type-TagFilter-Key"></a>
The on-premises instance tag filter key.  
Type: String  
Required: No

 ** Type **   <a name="CodeDeploy-Type-TagFilter-Type"></a>
The on-premises instance tag filter type:  
+ KEY\$1ONLY: Key only.
+ VALUE\$1ONLY: Value only.
+ KEY\$1AND\$1VALUE: Key and value.
Type: String  
Valid Values: `KEY_ONLY | VALUE_ONLY | KEY_AND_VALUE`   
Required: No

 ** Value **   <a name="CodeDeploy-Type-TagFilter-Value"></a>
The on-premises instance tag filter value.  
Type: String  
Required: No

## See Also
<a name="API_TagFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TagFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TagFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TagFilter) 

# TargetGroupInfo
<a name="API_TargetGroupInfo"></a>

Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.

## Contents
<a name="API_TargetGroupInfo_Contents"></a>

 ** name **   <a name="CodeDeploy-Type-TargetGroupInfo-name"></a>
For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.   
Type: String  
Required: No

## See Also
<a name="API_TargetGroupInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TargetGroupInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TargetGroupInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TargetGroupInfo) 

# TargetGroupPairInfo
<a name="API_TargetGroupPairInfo"></a>

 Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified. 

## Contents
<a name="API_TargetGroupPairInfo_Contents"></a>

 ** prodTrafficRoute **   <a name="CodeDeploy-Type-TargetGroupPairInfo-prodTrafficRoute"></a>
 The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.   
Type: [TrafficRoute](API_TrafficRoute.md) object  
Required: No

 ** targetGroups **   <a name="CodeDeploy-Type-TargetGroupPairInfo-targetGroups"></a>
 One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.   
Type: Array of [TargetGroupInfo](API_TargetGroupInfo.md) objects  
Required: No

 ** testTrafficRoute **   <a name="CodeDeploy-Type-TargetGroupPairInfo-testTrafficRoute"></a>
 An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.   
Type: [TrafficRoute](API_TrafficRoute.md) object  
Required: No

## See Also
<a name="API_TargetGroupPairInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TargetGroupPairInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TargetGroupPairInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TargetGroupPairInfo) 

# TargetInstances
<a name="API_TargetInstances"></a>

Information about the instances to be used in the replacement environment in a blue/green deployment.

## Contents
<a name="API_TargetInstances_Contents"></a>

 ** autoScalingGroups **   <a name="CodeDeploy-Type-TargetInstances-autoScalingGroups"></a>
The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.  
Type: Array of strings  
Required: No

 ** ec2TagSet **   <a name="CodeDeploy-Type-TargetInstances-ec2TagSet"></a>
Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as `tagFilters`.  
Type: [EC2TagSet](API_EC2TagSet.md) object  
Required: No

 ** tagFilters **   <a name="CodeDeploy-Type-TargetInstances-tagFilters"></a>
The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as `ec2TagSet`.  
Type: Array of [EC2TagFilter](API_EC2TagFilter.md) objects  
Required: No

## See Also
<a name="API_TargetInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TargetInstances) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TargetInstances) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TargetInstances) 

# TimeBasedCanary
<a name="API_TimeBasedCanary"></a>

A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

## Contents
<a name="API_TimeBasedCanary_Contents"></a>

 ** canaryInterval **   <a name="CodeDeploy-Type-TimeBasedCanary-canaryInterval"></a>
The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment.  
Type: Integer  
Required: No

 ** canaryPercentage **   <a name="CodeDeploy-Type-TimeBasedCanary-canaryPercentage"></a>
The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment.  
Type: Integer  
Required: No

## See Also
<a name="API_TimeBasedCanary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TimeBasedCanary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TimeBasedCanary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TimeBasedCanary) 

# TimeBasedLinear
<a name="API_TimeBasedLinear"></a>

A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

## Contents
<a name="API_TimeBasedLinear_Contents"></a>

 ** linearInterval **   <a name="CodeDeploy-Type-TimeBasedLinear-linearInterval"></a>
The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment.  
Type: Integer  
Required: No

 ** linearPercentage **   <a name="CodeDeploy-Type-TimeBasedLinear-linearPercentage"></a>
The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment.  
Type: Integer  
Required: No

## See Also
<a name="API_TimeBasedLinear_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TimeBasedLinear) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TimeBasedLinear) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TimeBasedLinear) 

# TimeRange
<a name="API_TimeRange"></a>

Information about a time range.

## Contents
<a name="API_TimeRange_Contents"></a>

 ** end **   <a name="CodeDeploy-Type-TimeRange-end"></a>
The end time of the time range.  
Specify null to leave the end time open-ended.
Type: Timestamp  
Required: No

 ** start **   <a name="CodeDeploy-Type-TimeRange-start"></a>
The start time of the time range.  
Specify null to leave the start time open-ended.
Type: Timestamp  
Required: No

## See Also
<a name="API_TimeRange_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TimeRange) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TimeRange) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TimeRange) 

# TrafficRoute
<a name="API_TrafficRoute"></a>

 Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group. 

## Contents
<a name="API_TrafficRoute_Contents"></a>

 ** listenerArns **   <a name="CodeDeploy-Type-TrafficRoute-listenerArns"></a>
 The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.   
Type: Array of strings  
Required: No

## See Also
<a name="API_TrafficRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TrafficRoute) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TrafficRoute) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TrafficRoute) 

# TrafficRoutingConfig
<a name="API_TrafficRoutingConfig"></a>

The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Amazon Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.

## Contents
<a name="API_TrafficRoutingConfig_Contents"></a>

 ** timeBasedCanary **   <a name="CodeDeploy-Type-TrafficRoutingConfig-timeBasedCanary"></a>
A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.  
Type: [TimeBasedCanary](API_TimeBasedCanary.md) object  
Required: No

 ** timeBasedLinear **   <a name="CodeDeploy-Type-TrafficRoutingConfig-timeBasedLinear"></a>
A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.  
Type: [TimeBasedLinear](API_TimeBasedLinear.md) object  
Required: No

 ** type **   <a name="CodeDeploy-Type-TrafficRoutingConfig-type"></a>
The type of traffic shifting (`TimeBasedCanary` or `TimeBasedLinear`) used by a deployment configuration.  
Type: String  
Valid Values: `TimeBasedCanary | TimeBasedLinear | TimeBasedFlexible | AllAtOnce`   
Required: No

## See Also
<a name="API_TrafficRoutingConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TrafficRoutingConfig) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TrafficRoutingConfig) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TrafficRoutingConfig) 

# TriggerConfig
<a name="API_TriggerConfig"></a>

Information about notification triggers for the deployment group.

## Contents
<a name="API_TriggerConfig_Contents"></a>

 ** triggerEvents **   <a name="CodeDeploy-Type-TriggerConfig-triggerEvents"></a>
The event type or types for which notifications are triggered.  
Type: Array of strings  
Valid Values: `DeploymentStart | DeploymentSuccess | DeploymentFailure | DeploymentStop | DeploymentRollback | DeploymentReady | InstanceStart | InstanceSuccess | InstanceFailure | InstanceReady`   
Required: No

 ** triggerName **   <a name="CodeDeploy-Type-TriggerConfig-triggerName"></a>
The name of the notification trigger.  
Type: String  
Required: No

 ** triggerTargetArn **   <a name="CodeDeploy-Type-TriggerConfig-triggerTargetArn"></a>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.  
Type: String  
Required: No

## See Also
<a name="API_TriggerConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/TriggerConfig) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/TriggerConfig) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/TriggerConfig) 

# ZonalConfig
<a name="API_ZonalConfig"></a>

Configure the `ZonalConfig` object if you want Amazon CodeDeploy to deploy your application to one [Availability Zone](https://docs.amazonaws.cn/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) at a time, within an Amazon Region. By deploying to one Availability Zone at a time, you can expose your deployment to a progressively larger audience as confidence in the deployment's performance and viability grows. If you don't configure the `ZonalConfig` object, CodeDeploy deploys your application to a random selection of hosts across a Region.

For more information about the zonal configuration feature, see [zonal configuration](https://docs.amazonaws.cn/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide*.

## Contents
<a name="API_ZonalConfig_Contents"></a>

 ** firstZoneMonitorDurationInSeconds **   <a name="CodeDeploy-Type-ZonalConfig-firstZoneMonitorDurationInSeconds"></a>
The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the *first* Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for `firstZoneMonitorDurationInSeconds`, then CodeDeploy uses the `monitorDurationInSeconds` value for the first Availability Zone.  
For more information about the zonal configuration feature, see [zonal configuration](https://docs.amazonaws.cn/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide*.  
Type: Long  
Required: No

 ** minimumHealthyHostsPerZone **   <a name="CodeDeploy-Type-ZonalConfig-minimumHealthyHostsPerZone"></a>
The number or percentage of instances that must remain available per Availability Zone during a deployment. This option works in conjunction with the `MinimumHealthyHosts` option. For more information, see [About the minimum number of healthy hosts per Availability Zone](https://docs.amazonaws.cn/codedeploy/latest/userguide/instances-health.html#minimum-healthy-hosts-az) in the *CodeDeploy User Guide*.  
If you don't specify the `minimumHealthyHostsPerZone` option, then CodeDeploy uses a default value of `0` percent.  
For more information about the zonal configuration feature, see [zonal configuration](https://docs.amazonaws.cn/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide*.  
Type: [MinimumHealthyHostsPerZone](API_MinimumHealthyHostsPerZone.md) object  
Required: No

 ** monitorDurationInSeconds **   <a name="CodeDeploy-Type-ZonalConfig-monitorDurationInSeconds"></a>
The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a `monitorDurationInSeconds`, CodeDeploy starts deploying to the next Availability Zone immediately.  
For more information about the zonal configuration feature, see [zonal configuration](https://docs.amazonaws.cn/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide*.  
Type: Long  
Required: No

## See Also
<a name="API_ZonalConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codedeploy-2014-10-06/ZonalConfig) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codedeploy-2014-10-06/ZonalConfig) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codedeploy-2014-10-06/ZonalConfig)