2023/12/07 - AWS CodeDeploy - 9 updated api methods
Changes This release adds support for two new CodeDeploy features: 1) zonal deployments for Amazon EC2 in-place deployments, 2) deployments triggered by Auto Scaling group termination lifecycle hook events.
{'deploymentGroupsInfo': {'autoScalingGroups': {'terminationHook': 'string'},
'terminationHookEnabled': 'boolean'}}
Gets information about one or more deployment groups.
See also: AWS API Documentation
Request Syntax
client.batch_get_deployment_groups(
applicationName='string',
deploymentGroupNames=[
'string',
]
)
string
[REQUIRED]
The name of an CodeDeploy application associated with the applicable user or Amazon Web Services account.
list
[REQUIRED]
The names of the deployment groups.
(string) --
dict
Response Syntax
{
'deploymentGroupsInfo': [
{
'applicationName': 'string',
'deploymentGroupId': 'string',
'deploymentGroupName': 'string',
'deploymentConfigName': 'string',
'ec2TagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'onPremisesInstanceTagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'autoScalingGroups': [
{
'name': 'string',
'hook': 'string',
'terminationHook': 'string'
},
],
'serviceRoleArn': 'string',
'targetRevision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'triggerConfigurations': [
{
'triggerName': 'string',
'triggerTargetArn': 'string',
'triggerEvents': [
'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
]
},
],
'alarmConfiguration': {
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
},
'autoRollbackConfiguration': {
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
'deploymentStyle': {
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
'outdatedInstancesStrategy': 'UPDATE'|'IGNORE',
'blueGreenDeploymentConfiguration': {
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
'loadBalancerInfo': {
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
'lastSuccessfulDeployment': {
'deploymentId': 'string',
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'endTime': datetime(2015, 1, 1),
'createTime': datetime(2015, 1, 1)
},
'lastAttemptedDeployment': {
'deploymentId': 'string',
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'endTime': datetime(2015, 1, 1),
'createTime': datetime(2015, 1, 1)
},
'ec2TagSet': {
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
'onPremisesTagSet': {
'onPremisesTagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
'computePlatform': 'Server'|'Lambda'|'ECS',
'ecsServices': [
{
'serviceName': 'string',
'clusterName': 'string'
},
],
'terminationHookEnabled': True|False
},
],
'errorMessage': 'string'
}
Response Structure
(dict) --
Represents the output of a BatchGetDeploymentGroups operation.
deploymentGroupsInfo (list) --
Information about the deployment groups.
(dict) --
Information about a deployment group.
applicationName (string) --
The application name.
deploymentGroupId (string) --
The deployment group ID.
deploymentGroupName (string) --
The deployment group name.
deploymentConfigName (string) --
The deployment configuration name.
ec2TagFilters (list) --
The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
onPremisesInstanceTagFilters (list) --
The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
autoScalingGroups (list) --
A list of associated Auto Scaling groups.
(dict) --
Information about an Auto Scaling group.
name (string) --
The Auto Scaling group name.
hook (string) --
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 in the CodeDeploy User Guide .
terminationHook (string) --
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 in the CodeDeploy User Guide .
serviceRoleArn (string) --
A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide .
targetRevision (dict) --
Information about the deployment group's target revision, including type and location.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
triggerConfigurations (list) --
Information about triggers associated with the deployment group.
(dict) --
Information about notification triggers for the deployment group.
triggerName (string) --
The name of the notification trigger.
triggerTargetArn (string) --
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
triggerEvents (list) --
The event type or types for which notifications are triggered.
(string) --
alarmConfiguration (dict) --
A list of alarms associated with the deployment group.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
autoRollbackConfiguration (dict) --
Information about the automatic rollback configuration associated with the deployment group.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
deploymentStyle (dict) --
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.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
outdatedInstancesStrategy (string) --
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.
blueGreenDeploymentConfiguration (dict) --
Information about blue/green deployment options for a deployment group.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
loadBalancerInfo (dict) --
Information about the load balancer to use in a deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
lastSuccessfulDeployment (dict) --
Information about the most recent successful deployment to the deployment group.
deploymentId (string) --
The unique ID of a deployment.
status (string) --
The status of the most recent deployment.
endTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group was complete.
createTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group started.
lastAttemptedDeployment (dict) --
Information about the most recent attempted deployment to the deployment group.
deploymentId (string) --
The unique ID of a deployment.
status (string) --
The status of the most recent deployment.
endTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group was complete.
createTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group started.
ec2TagSet (dict) --
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.
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
onPremisesTagSet (dict) --
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.
onPremisesTagSetList (list) --
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.
(list) --
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
computePlatform (string) --
The destination platform type for the deployment (Lambda , Server , or ECS ).
ecsServices (list) --
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> .
(dict) --
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
serviceName (string) --
The name of the target Amazon ECS service.
clusterName (string) --
The name of the cluster that the Amazon ECS service is associated with.
terminationHookEnabled (boolean) --
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 in the CodeDeploy User Guide .
errorMessage (string) --
Information about errors that might have occurred during the API call.
{'deploymentsInfo': {'creator': {'autoscalingTermination'}}}
Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
See also: AWS API Documentation
Request Syntax
client.batch_get_deployments(
deploymentIds=[
'string',
]
)
list
[REQUIRED]
A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
(string) --
dict
Response Syntax
{
'deploymentsInfo': [
{
'applicationName': 'string',
'deploymentGroupName': 'string',
'deploymentConfigName': 'string',
'deploymentId': 'string',
'previousRevision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'revision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'errorInformation': {
'code': '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',
'message': 'string'
},
'createTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'completeTime': datetime(2015, 1, 1),
'deploymentOverview': {
'Pending': 123,
'InProgress': 123,
'Succeeded': 123,
'Failed': 123,
'Skipped': 123,
'Ready': 123
},
'description': 'string',
'creator': 'user'|'autoscaling'|'codeDeployRollback'|'CodeDeploy'|'CodeDeployAutoUpdate'|'CloudFormation'|'CloudFormationRollback'|'autoscalingTermination',
'ignoreApplicationStopFailures': True|False,
'autoRollbackConfiguration': {
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
'updateOutdatedInstancesOnly': True|False,
'rollbackInfo': {
'rollbackDeploymentId': 'string',
'rollbackTriggeringDeploymentId': 'string',
'rollbackMessage': 'string'
},
'deploymentStyle': {
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
'targetInstances': {
'tagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'autoScalingGroups': [
'string',
],
'ec2TagSet': {
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
}
},
'instanceTerminationWaitTimeStarted': True|False,
'blueGreenDeploymentConfiguration': {
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
'loadBalancerInfo': {
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
'additionalDeploymentStatusInfo': 'string',
'fileExistsBehavior': 'DISALLOW'|'OVERWRITE'|'RETAIN',
'deploymentStatusMessages': [
'string',
],
'computePlatform': 'Server'|'Lambda'|'ECS',
'externalId': 'string',
'relatedDeployments': {
'autoUpdateOutdatedInstancesRootDeploymentId': 'string',
'autoUpdateOutdatedInstancesDeploymentIds': [
'string',
]
},
'overrideAlarmConfiguration': {
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
}
},
]
}
Response Structure
(dict) --
Represents the output of a BatchGetDeployments operation.
deploymentsInfo (list) --
Information about the deployments.
(dict) --
Information about a deployment.
applicationName (string) --
The application name.
deploymentGroupName (string) --
The deployment group name.
deploymentConfigName (string) --
The deployment configuration name.
deploymentId (string) --
The unique ID of a deployment.
previousRevision (dict) --
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
revision (dict) --
Information about the location of stored application artifacts and the service from which to retrieve them.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
status (string) --
The current state of the deployment as a whole.
errorInformation (dict) --
Information about any error associated with this deployment.
code (string) --
For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide .
The error code:
APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
IAM_ROLE_MISSING: The service role cannot be accessed.
IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
INTERNAL_ERROR: There was an internal error.
NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
NO_INSTANCES: No instances were specified, or no instances can be found.
OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.
TIMEOUT: The deployment has timed out.
REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
message (string) --
An accompanying error message.
createTime (datetime) --
A timestamp that indicates when the deployment was created.
startTime (datetime) --
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.
completeTime (datetime) --
A timestamp that indicates when the deployment was complete.
deploymentOverview (dict) --
A summary of the deployment status of the instances in the deployment.
Pending (integer) --
The number of instances in the deployment in a pending state.
InProgress (integer) --
The number of instances in which the deployment is in progress.
Succeeded (integer) --
The number of instances in the deployment to which revisions have been successfully deployed.
Failed (integer) --
The number of instances in the deployment in a failed state.
Skipped (integer) --
The number of instances in the deployment in a skipped state.
Ready (integer) --
The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
description (string) --
A comment about the deployment.
creator (string) --
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.
ignoreApplicationStopFailures (boolean) --
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 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.
autoRollbackConfiguration (dict) --
Information about the automatic rollback configuration associated with the deployment.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
updateOutdatedInstancesOnly (boolean) --
Indicates whether only instances that are not running the latest application revision are to be deployed to.
rollbackInfo (dict) --
Information about a deployment rollback.
rollbackDeploymentId (string) --
The ID of the deployment rollback.
rollbackTriggeringDeploymentId (string) --
The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
rollbackMessage (string) --
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).
deploymentStyle (dict) --
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.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
targetInstances (dict) --
Information about the instances that belong to the replacement environment in a blue/green deployment.
tagFilters (list) --
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 .
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
autoScalingGroups (list) --
The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
(string) --
ec2TagSet (dict) --
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 .
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
instanceTerminationWaitTimeStarted (boolean) --
Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.
blueGreenDeploymentConfiguration (dict) --
Information about blue/green deployment options for this deployment.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
loadBalancerInfo (dict) --
Information about the load balancer used in the deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
additionalDeploymentStatusInfo (string) --
Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
fileExistsBehavior (string) --
Information about how 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.
deploymentStatusMessages (list) --
Messages that contain information about the status of a deployment.
(string) --
computePlatform (string) --
The destination platform type for the deployment (Lambda , Server , or ECS ).
externalId (string) --
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
relatedDeployments (dict) --
Information about deployments related to the specified deployment.
autoUpdateOutdatedInstancesRootDeploymentId (string) --
The deployment ID of the root deployment that triggered this deployment.
autoUpdateOutdatedInstancesDeploymentIds (list) --
The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.
(string) --
overrideAlarmConfiguration (dict) --
Information about alarms associated with a deployment or deployment group.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
{'zonalConfig': {'firstZoneMonitorDurationInSeconds': 'long',
'minimumHealthyHostsPerZone': {'type': 'HOST_COUNT | '
'FLEET_PERCENT',
'value': 'integer'},
'monitorDurationInSeconds': 'long'}}
Creates a deployment configuration.
See also: AWS API Documentation
Request Syntax
client.create_deployment_config(
deploymentConfigName='string',
minimumHealthyHosts={
'type': 'HOST_COUNT'|'FLEET_PERCENT',
'value': 123
},
trafficRoutingConfig={
'type': 'TimeBasedCanary'|'TimeBasedLinear'|'AllAtOnce',
'timeBasedCanary': {
'canaryPercentage': 123,
'canaryInterval': 123
},
'timeBasedLinear': {
'linearPercentage': 123,
'linearInterval': 123
}
},
computePlatform='Server'|'Lambda'|'ECS',
zonalConfig={
'firstZoneMonitorDurationInSeconds': 123,
'monitorDurationInSeconds': 123,
'minimumHealthyHostsPerZone': {
'type': 'HOST_COUNT'|'FLEET_PERCENT',
'value': 123
}
}
)
string
[REQUIRED]
The name of the deployment configuration to create.
dict
The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
type (string) --
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_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
Note
In a call to the GetDeploymentConfig , CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, 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 CodeDeploy Instance Health in the CodeDeploy User Guide .
value (integer) --
The minimum healthy instance value.
dict
The configuration that specifies how the deployment traffic is routed.
type (string) --
The type of traffic shifting (TimeBasedCanary or TimeBasedLinear ) used by a deployment configuration.
timeBasedCanary (dict) --
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.
canaryPercentage (integer) --
The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
canaryInterval (integer) --
The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
timeBasedLinear (dict) --
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.
linearPercentage (integer) --
The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
linearInterval (integer) --
The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
string
The destination platform type for the deployment (Lambda , Server , or ECS ).
dict
Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .
firstZoneMonitorDurationInSeconds (integer) --
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 in the CodeDeploy User Guide .
monitorDurationInSeconds (integer) --
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 in the CodeDeploy User Guide .
minimumHealthyHostsPerZone (dict) --
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 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 in the CodeDeploy User Guide .
type (string) --
The type associated with the MinimumHealthyHostsPerZone option.
value (integer) --
The value associated with the MinimumHealthyHostsPerZone option.
dict
Response Syntax
{
'deploymentConfigId': 'string'
}
Response Structure
(dict) --
Represents the output of a CreateDeploymentConfig operation.
deploymentConfigId (string) --
A unique deployment configuration ID.
{'terminationHookEnabled': 'boolean'}
Creates a deployment group to which application revisions are deployed.
See also: AWS API Documentation
Request Syntax
client.create_deployment_group(
applicationName='string',
deploymentGroupName='string',
deploymentConfigName='string',
ec2TagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
onPremisesInstanceTagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
autoScalingGroups=[
'string',
],
serviceRoleArn='string',
triggerConfigurations=[
{
'triggerName': 'string',
'triggerTargetArn': 'string',
'triggerEvents': [
'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
]
},
],
alarmConfiguration={
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
},
autoRollbackConfiguration={
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
outdatedInstancesStrategy='UPDATE'|'IGNORE',
deploymentStyle={
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
blueGreenDeploymentConfiguration={
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
loadBalancerInfo={
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
ec2TagSet={
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
ecsServices=[
{
'serviceName': 'string',
'clusterName': 'string'
},
],
onPremisesTagSet={
'onPremisesTagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
terminationHookEnabled=True|False
)
string
[REQUIRED]
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
string
[REQUIRED]
The name of a new deployment group for the specified application.
string
If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.
For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide .
list
The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
list
The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet .
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
list
A list of associated Amazon EC2 Auto Scaling groups.
(string) --
string
[REQUIRED]
A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
list
Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide .
(dict) --
Information about notification triggers for the deployment group.
triggerName (string) --
The name of the notification trigger.
triggerTargetArn (string) --
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
triggerEvents (list) --
The event type or types for which notifications are triggered.
(string) --
dict
Information to add about Amazon CloudWatch alarms when the deployment group is created.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
dict
Configuration information for an automatic rollback that is added when a deployment group is created.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
string
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.
dict
Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
dict
Information about blue/green deployment options for a deployment group.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
dict
Information about the load balancer used in a deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
dict
Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters .
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
list
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> .
(dict) --
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
serviceName (string) --
The name of the target Amazon ECS service.
clusterName (string) --
The name of the cluster that the Amazon ECS service is associated with.
dict
Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters .
onPremisesTagSetList (list) --
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.
(list) --
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
list
The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
(dict) --
Information about a tag.
Key (string) --
The tag's key.
Value (string) --
The tag's value.
boolean
This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide .
Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.
For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide .
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide .
dict
Response Syntax
{
'deploymentGroupId': 'string'
}
Response Structure
(dict) --
Represents the output of a CreateDeploymentGroup operation.
deploymentGroupId (string) --
A unique deployment group ID.
{'hooksNotCleanedUp': {'terminationHook': 'string'}}
Deletes a deployment group.
See also: AWS API Documentation
Request Syntax
client.delete_deployment_group(
applicationName='string',
deploymentGroupName='string'
)
string
[REQUIRED]
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
string
[REQUIRED]
The name of a deployment group for the specified application.
dict
Response Syntax
{
'hooksNotCleanedUp': [
{
'name': 'string',
'hook': 'string',
'terminationHook': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a DeleteDeploymentGroup operation.
hooksNotCleanedUp (list) --
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
(dict) --
Information about an Auto Scaling group.
name (string) --
The Auto Scaling group name.
hook (string) --
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 in the CodeDeploy User Guide .
terminationHook (string) --
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 in the CodeDeploy User Guide .
{'deploymentInfo': {'creator': {'autoscalingTermination'}}}
Gets information about a deployment.
Note
The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
deploymentId='string'
)
string
[REQUIRED]
The unique ID of a deployment associated with the user or Amazon Web Services account.
dict
Response Syntax
{
'deploymentInfo': {
'applicationName': 'string',
'deploymentGroupName': 'string',
'deploymentConfigName': 'string',
'deploymentId': 'string',
'previousRevision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'revision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'errorInformation': {
'code': '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',
'message': 'string'
},
'createTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'completeTime': datetime(2015, 1, 1),
'deploymentOverview': {
'Pending': 123,
'InProgress': 123,
'Succeeded': 123,
'Failed': 123,
'Skipped': 123,
'Ready': 123
},
'description': 'string',
'creator': 'user'|'autoscaling'|'codeDeployRollback'|'CodeDeploy'|'CodeDeployAutoUpdate'|'CloudFormation'|'CloudFormationRollback'|'autoscalingTermination',
'ignoreApplicationStopFailures': True|False,
'autoRollbackConfiguration': {
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
'updateOutdatedInstancesOnly': True|False,
'rollbackInfo': {
'rollbackDeploymentId': 'string',
'rollbackTriggeringDeploymentId': 'string',
'rollbackMessage': 'string'
},
'deploymentStyle': {
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
'targetInstances': {
'tagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'autoScalingGroups': [
'string',
],
'ec2TagSet': {
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
}
},
'instanceTerminationWaitTimeStarted': True|False,
'blueGreenDeploymentConfiguration': {
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
'loadBalancerInfo': {
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
'additionalDeploymentStatusInfo': 'string',
'fileExistsBehavior': 'DISALLOW'|'OVERWRITE'|'RETAIN',
'deploymentStatusMessages': [
'string',
],
'computePlatform': 'Server'|'Lambda'|'ECS',
'externalId': 'string',
'relatedDeployments': {
'autoUpdateOutdatedInstancesRootDeploymentId': 'string',
'autoUpdateOutdatedInstancesDeploymentIds': [
'string',
]
},
'overrideAlarmConfiguration': {
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
}
}
}
Response Structure
(dict) --
Represents the output of a GetDeployment operation.
deploymentInfo (dict) --
Information about the deployment.
applicationName (string) --
The application name.
deploymentGroupName (string) --
The deployment group name.
deploymentConfigName (string) --
The deployment configuration name.
deploymentId (string) --
The unique ID of a deployment.
previousRevision (dict) --
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
revision (dict) --
Information about the location of stored application artifacts and the service from which to retrieve them.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
status (string) --
The current state of the deployment as a whole.
errorInformation (dict) --
Information about any error associated with this deployment.
code (string) --
For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide .
The error code:
APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.
DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.
HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
IAM_ROLE_MISSING: The service role cannot be accessed.
IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
INTERNAL_ERROR: There was an internal error.
NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
NO_INSTANCES: No instances were specified, or no instances can be found.
OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.
TIMEOUT: The deployment has timed out.
REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.
message (string) --
An accompanying error message.
createTime (datetime) --
A timestamp that indicates when the deployment was created.
startTime (datetime) --
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.
completeTime (datetime) --
A timestamp that indicates when the deployment was complete.
deploymentOverview (dict) --
A summary of the deployment status of the instances in the deployment.
Pending (integer) --
The number of instances in the deployment in a pending state.
InProgress (integer) --
The number of instances in which the deployment is in progress.
Succeeded (integer) --
The number of instances in the deployment to which revisions have been successfully deployed.
Failed (integer) --
The number of instances in the deployment in a failed state.
Skipped (integer) --
The number of instances in the deployment in a skipped state.
Ready (integer) --
The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
description (string) --
A comment about the deployment.
creator (string) --
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.
ignoreApplicationStopFailures (boolean) --
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 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.
autoRollbackConfiguration (dict) --
Information about the automatic rollback configuration associated with the deployment.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
updateOutdatedInstancesOnly (boolean) --
Indicates whether only instances that are not running the latest application revision are to be deployed to.
rollbackInfo (dict) --
Information about a deployment rollback.
rollbackDeploymentId (string) --
The ID of the deployment rollback.
rollbackTriggeringDeploymentId (string) --
The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
rollbackMessage (string) --
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).
deploymentStyle (dict) --
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.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
targetInstances (dict) --
Information about the instances that belong to the replacement environment in a blue/green deployment.
tagFilters (list) --
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 .
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
autoScalingGroups (list) --
The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
(string) --
ec2TagSet (dict) --
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 .
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
instanceTerminationWaitTimeStarted (boolean) --
Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.
blueGreenDeploymentConfiguration (dict) --
Information about blue/green deployment options for this deployment.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
loadBalancerInfo (dict) --
Information about the load balancer used in the deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
additionalDeploymentStatusInfo (string) --
Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
fileExistsBehavior (string) --
Information about how 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.
deploymentStatusMessages (list) --
Messages that contain information about the status of a deployment.
(string) --
computePlatform (string) --
The destination platform type for the deployment (Lambda , Server , or ECS ).
externalId (string) --
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
relatedDeployments (dict) --
Information about deployments related to the specified deployment.
autoUpdateOutdatedInstancesRootDeploymentId (string) --
The deployment ID of the root deployment that triggered this deployment.
autoUpdateOutdatedInstancesDeploymentIds (list) --
The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.
(string) --
overrideAlarmConfiguration (dict) --
Information about alarms associated with a deployment or deployment group.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
{'deploymentConfigInfo': {'zonalConfig': {'firstZoneMonitorDurationInSeconds': 'long',
'minimumHealthyHostsPerZone': {'type': 'HOST_COUNT '
'| '
'FLEET_PERCENT',
'value': 'integer'},
'monitorDurationInSeconds': 'long'}}}
Gets information about a deployment configuration.
See also: AWS API Documentation
Request Syntax
client.get_deployment_config(
deploymentConfigName='string'
)
string
[REQUIRED]
The name of a deployment configuration associated with the user or Amazon Web Services account.
dict
Response Syntax
{
'deploymentConfigInfo': {
'deploymentConfigId': 'string',
'deploymentConfigName': 'string',
'minimumHealthyHosts': {
'type': 'HOST_COUNT'|'FLEET_PERCENT',
'value': 123
},
'createTime': datetime(2015, 1, 1),
'computePlatform': 'Server'|'Lambda'|'ECS',
'trafficRoutingConfig': {
'type': 'TimeBasedCanary'|'TimeBasedLinear'|'AllAtOnce',
'timeBasedCanary': {
'canaryPercentage': 123,
'canaryInterval': 123
},
'timeBasedLinear': {
'linearPercentage': 123,
'linearInterval': 123
}
},
'zonalConfig': {
'firstZoneMonitorDurationInSeconds': 123,
'monitorDurationInSeconds': 123,
'minimumHealthyHostsPerZone': {
'type': 'HOST_COUNT'|'FLEET_PERCENT',
'value': 123
}
}
}
}
Response Structure
(dict) --
Represents the output of a GetDeploymentConfig operation.
deploymentConfigInfo (dict) --
Information about the deployment configuration.
deploymentConfigId (string) --
The deployment configuration ID.
deploymentConfigName (string) --
The deployment configuration name.
minimumHealthyHosts (dict) --
Information about the number or percentage of minimum healthy instances.
type (string) --
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_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.
Note
In a call to the GetDeploymentConfig , CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, 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 CodeDeploy Instance Health in the CodeDeploy User Guide .
value (integer) --
The minimum healthy instance value.
createTime (datetime) --
The time at which the deployment configuration was created.
computePlatform (string) --
The destination platform type for the deployment (Lambda , Server , or ECS ).
trafficRoutingConfig (dict) --
The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.
type (string) --
The type of traffic shifting (TimeBasedCanary or TimeBasedLinear ) used by a deployment configuration.
timeBasedCanary (dict) --
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.
canaryPercentage (integer) --
The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
canaryInterval (integer) --
The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
timeBasedLinear (dict) --
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.
linearPercentage (integer) --
The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
linearInterval (integer) --
The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
zonalConfig (dict) --
Information about a zonal configuration.
firstZoneMonitorDurationInSeconds (integer) --
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 in the CodeDeploy User Guide .
monitorDurationInSeconds (integer) --
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 in the CodeDeploy User Guide .
minimumHealthyHostsPerZone (dict) --
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 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 in the CodeDeploy User Guide .
type (string) --
The type associated with the MinimumHealthyHostsPerZone option.
value (integer) --
The value associated with the MinimumHealthyHostsPerZone option.
{'deploymentGroupInfo': {'autoScalingGroups': {'terminationHook': 'string'},
'terminationHookEnabled': 'boolean'}}
Gets information about a deployment group.
See also: AWS API Documentation
Request Syntax
client.get_deployment_group(
applicationName='string',
deploymentGroupName='string'
)
string
[REQUIRED]
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
string
[REQUIRED]
The name of a deployment group for the specified application.
dict
Response Syntax
{
'deploymentGroupInfo': {
'applicationName': 'string',
'deploymentGroupId': 'string',
'deploymentGroupName': 'string',
'deploymentConfigName': 'string',
'ec2TagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'onPremisesInstanceTagFilters': [
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
'autoScalingGroups': [
{
'name': 'string',
'hook': 'string',
'terminationHook': 'string'
},
],
'serviceRoleArn': 'string',
'targetRevision': {
'revisionType': 'S3'|'GitHub'|'String'|'AppSpecContent',
's3Location': {
'bucket': 'string',
'key': 'string',
'bundleType': 'tar'|'tgz'|'zip'|'YAML'|'JSON',
'version': 'string',
'eTag': 'string'
},
'gitHubLocation': {
'repository': 'string',
'commitId': 'string'
},
'string': {
'content': 'string',
'sha256': 'string'
},
'appSpecContent': {
'content': 'string',
'sha256': 'string'
}
},
'triggerConfigurations': [
{
'triggerName': 'string',
'triggerTargetArn': 'string',
'triggerEvents': [
'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
]
},
],
'alarmConfiguration': {
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
},
'autoRollbackConfiguration': {
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
'deploymentStyle': {
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
'outdatedInstancesStrategy': 'UPDATE'|'IGNORE',
'blueGreenDeploymentConfiguration': {
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
'loadBalancerInfo': {
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
'lastSuccessfulDeployment': {
'deploymentId': 'string',
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'endTime': datetime(2015, 1, 1),
'createTime': datetime(2015, 1, 1)
},
'lastAttemptedDeployment': {
'deploymentId': 'string',
'status': 'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
'endTime': datetime(2015, 1, 1),
'createTime': datetime(2015, 1, 1)
},
'ec2TagSet': {
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
'onPremisesTagSet': {
'onPremisesTagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
'computePlatform': 'Server'|'Lambda'|'ECS',
'ecsServices': [
{
'serviceName': 'string',
'clusterName': 'string'
},
],
'terminationHookEnabled': True|False
}
}
Response Structure
(dict) --
Represents the output of a GetDeploymentGroup operation.
deploymentGroupInfo (dict) --
Information about the deployment group.
applicationName (string) --
The application name.
deploymentGroupId (string) --
The deployment group ID.
deploymentGroupName (string) --
The deployment group name.
deploymentConfigName (string) --
The deployment configuration name.
ec2TagFilters (list) --
The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
onPremisesInstanceTagFilters (list) --
The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
autoScalingGroups (list) --
A list of associated Auto Scaling groups.
(dict) --
Information about an Auto Scaling group.
name (string) --
The Auto Scaling group name.
hook (string) --
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 in the CodeDeploy User Guide .
terminationHook (string) --
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 in the CodeDeploy User Guide .
serviceRoleArn (string) --
A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide .
targetRevision (dict) --
Information about the deployment group's target revision, including type and location.
revisionType (string) --
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 (Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3Location (dict) --
Information about the location of a revision stored in Amazon S3.
bucket (string) --
The name of the Amazon S3 bucket where the application revision is stored.
key (string) --
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
bundleType (string) --
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.
version (string) --
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.
eTag (string) --
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.
gitHubLocation (dict) --
Information about the location of application artifacts stored in GitHub.
repository (string) --
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.
commitId (string) --
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
string (dict) --
Information about the location of an Lambda deployment revision stored as a RawString.
content (string) --
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.
sha256 (string) --
The SHA256 hash value of the revision content.
appSpecContent (dict) --
The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.
content (string) --
The YAML-formatted or JSON-formatted revision string.
For an 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.
sha256 (string) --
The SHA256 hash value of the revision content.
triggerConfigurations (list) --
Information about triggers associated with the deployment group.
(dict) --
Information about notification triggers for the deployment group.
triggerName (string) --
The name of the notification trigger.
triggerTargetArn (string) --
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
triggerEvents (list) --
The event type or types for which notifications are triggered.
(string) --
alarmConfiguration (dict) --
A list of alarms associated with the deployment group.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
autoRollbackConfiguration (dict) --
Information about the automatic rollback configuration associated with the deployment group.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
deploymentStyle (dict) --
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.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
outdatedInstancesStrategy (string) --
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.
blueGreenDeploymentConfiguration (dict) --
Information about blue/green deployment options for a deployment group.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
loadBalancerInfo (dict) --
Information about the load balancer to use in a deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
lastSuccessfulDeployment (dict) --
Information about the most recent successful deployment to the deployment group.
deploymentId (string) --
The unique ID of a deployment.
status (string) --
The status of the most recent deployment.
endTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group was complete.
createTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group started.
lastAttemptedDeployment (dict) --
Information about the most recent attempted deployment to the deployment group.
deploymentId (string) --
The unique ID of a deployment.
status (string) --
The status of the most recent deployment.
endTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group was complete.
createTime (datetime) --
A timestamp that indicates when the most recent deployment to the deployment group started.
ec2TagSet (dict) --
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.
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
onPremisesTagSet (dict) --
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.
onPremisesTagSetList (list) --
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.
(list) --
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
computePlatform (string) --
The destination platform type for the deployment (Lambda , Server , or ECS ).
ecsServices (list) --
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> .
(dict) --
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
serviceName (string) --
The name of the target Amazon ECS service.
clusterName (string) --
The name of the cluster that the Amazon ECS service is associated with.
terminationHookEnabled (boolean) --
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 in the CodeDeploy User Guide .
{'terminationHookEnabled': 'boolean'}
Response {'hooksNotCleanedUp': {'terminationHook': 'string'}}
Changes information about a deployment group.
See also: AWS API Documentation
Request Syntax
client.update_deployment_group(
applicationName='string',
currentDeploymentGroupName='string',
newDeploymentGroupName='string',
deploymentConfigName='string',
ec2TagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
onPremisesInstanceTagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
autoScalingGroups=[
'string',
],
serviceRoleArn='string',
triggerConfigurations=[
{
'triggerName': 'string',
'triggerTargetArn': 'string',
'triggerEvents': [
'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
]
},
],
alarmConfiguration={
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
},
autoRollbackConfiguration={
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
outdatedInstancesStrategy='UPDATE'|'IGNORE',
deploymentStyle={
'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
},
blueGreenDeploymentConfiguration={
'terminateBlueInstancesOnDeploymentSuccess': {
'action': 'TERMINATE'|'KEEP_ALIVE',
'terminationWaitTimeInMinutes': 123
},
'deploymentReadyOption': {
'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
'waitTimeInMinutes': 123
},
'greenFleetProvisioningOption': {
'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
}
},
loadBalancerInfo={
'elbInfoList': [
{
'name': 'string'
},
],
'targetGroupInfoList': [
{
'name': 'string'
},
],
'targetGroupPairInfoList': [
{
'targetGroups': [
{
'name': 'string'
},
],
'prodTrafficRoute': {
'listenerArns': [
'string',
]
},
'testTrafficRoute': {
'listenerArns': [
'string',
]
}
},
]
},
ec2TagSet={
'ec2TagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
ecsServices=[
{
'serviceName': 'string',
'clusterName': 'string'
},
],
onPremisesTagSet={
'onPremisesTagSetList': [
[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
]
},
terminationHookEnabled=True|False
)
string
[REQUIRED]
The application name that corresponds to the deployment group to update.
string
[REQUIRED]
The current name of the deployment group.
string
The new name of the deployment group, if you want to change it.
string
The replacement deployment configuration name to use, if you want to change it.
list
The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
list
The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
list
The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
To keep the Auto Scaling groups, enter their names or do not specify this parameter.
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide .
(string) --
string
A replacement ARN for the service role, if you want to change it.
list
Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide .
(dict) --
Information about notification triggers for the deployment group.
triggerName (string) --
The name of the notification trigger.
triggerTargetArn (string) --
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
triggerEvents (list) --
The event type or types for which notifications are triggered.
(string) --
dict
Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
enabled (boolean) --
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure (boolean) --
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
true : The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
false : The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
alarms (list) --
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
(dict) --
Information about an alarm.
name (string) --
The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
dict
Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
enabled (boolean) --
Indicates whether a defined automatic rollback configuration is currently enabled.
events (list) --
The event type or types that trigger a rollback.
(string) --
string
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.
dict
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.
deploymentType (string) --
Indicates whether to run an in-place deployment or a blue/green deployment.
deploymentOption (string) --
Indicates whether to route deployment traffic behind a load balancer.
dict
Information about blue/green deployment options for a deployment group.
terminateBlueInstancesOnDeploymentSuccess (dict) --
Information about whether to terminate instances in the original fleet during a blue/green deployment.
action (string) --
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.
terminationWaitTimeInMinutes (integer) --
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).
deploymentReadyOption (dict) --
Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
actionOnTimeout (string) --
Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
waitTimeInMinutes (integer) --
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 .
greenFleetProvisioningOption (dict) --
Information about how instances are provisioned for a replacement environment in a blue/green deployment.
action (string) --
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.
dict
Information about the load balancer used in a deployment.
elbInfoList (list) --
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.
Note
You can add up to 10 load balancers to the array.
Note
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupInfoList (list) --
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.
Note
You can add up to 10 target groups to the array.
Note
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
(dict) --
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.
name (string) --
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.
targetGroupPairInfoList (list) --
The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
(dict) --
Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
targetGroups (list) --
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.
(dict) --
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.
name (string) --
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.
prodTrafficRoute (dict) --
The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
listenerArns (list) --
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.
(string) --
testTrafficRoute (dict) --
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.
listenerArns (list) --
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.
(string) --
dict
Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
ec2TagSetList (list) --
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.
(list) --
(dict) --
Information about an EC2 tag filter.
Key (string) --
The tag filter key.
Value (string) --
The tag filter value.
Type (string) --
The tag filter type:
KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.
list
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> .
(dict) --
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
serviceName (string) --
The name of the target Amazon ECS service.
clusterName (string) --
The name of the cluster that the Amazon ECS service is associated with.
dict
Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
onPremisesTagSetList (list) --
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.
(list) --
(dict) --
Information about an on-premises instance tag filter.
Key (string) --
The on-premises instance tag filter key.
Value (string) --
The on-premises instance tag filter value.
Type (string) --
The on-premises instance tag filter type:
KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.
boolean
This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide .
Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.
For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide .
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide .
dict
Response Syntax
{
'hooksNotCleanedUp': [
{
'name': 'string',
'hook': 'string',
'terminationHook': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of an UpdateDeploymentGroup operation.
hooksNotCleanedUp (list) --
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.
(dict) --
Information about an Auto Scaling group.
name (string) --
The Auto Scaling group name.
hook (string) --
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 in the CodeDeploy User Guide .
terminationHook (string) --
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 in the CodeDeploy User Guide .