A low-level client representing AWS CodeDeploy
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.
CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
Application : A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group : A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
Deployment configuration : A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment : The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
Application revisions : For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
CodeDeploy Information Resources
client = session.create_client('codedeploy')
These are the available methods:
Adds tags to on-premises instances.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_on_premises_instances(
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
instanceNames=[
'string',
]
)
tags (list) –
[REQUIRED]
The tag key-value pairs to add to the on-premises instances.
Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
instanceNames (list) –
[REQUIRED]
The names of the on-premises instances to which to add tags.
(string) –
None
Exceptions
Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_application_revisions(
applicationName='string',
revisions=[
{
'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'
}
},
]
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application about which to get revision information.
revisions (list) –
[REQUIRED]
An array of RevisionLocation
objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation
objects you can specify is 25.
(dict) –
Information about the location of an application revision.
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.
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.
dict
Response Syntax
{
'applicationName': 'string',
'errorMessage': 'string',
'revisions': [
{
'revisionLocation': {
'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'
}
},
'genericRevisionInfo': {
'description': 'string',
'deploymentGroups': [
'string',
],
'firstUsedTime': datetime(2015, 1, 1),
'lastUsedTime': datetime(2015, 1, 1),
'registerTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) –
Represents the output of a BatchGetApplicationRevisions
operation.
applicationName (string) –
The name of the application that corresponds to the revisions.
errorMessage (string) –
Information about errors that might have occurred during the API call.
revisions (list) –
Additional information about the revisions, including the type and location.
(dict) –
Information about an application revision.
revisionLocation (dict) –
Information about the location and type of an application revision.
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.
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.
genericRevisionInfo (dict) –
Information about an application revision, including usage details and associated deployment groups.
description (string) –
A comment about the revision.
deploymentGroups (list) –
The deployment groups for which this is the current target revision.
(string) –
firstUsedTime (datetime) –
When the revision was first used by CodeDeploy.
lastUsedTime (datetime) –
When the revision was last used by CodeDeploy.
registerTime (datetime) –
When the revision was registered with CodeDeploy.
Exceptions
Gets information about one or more applications. The maximum number of applications that can be returned is 100.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_applications(
applicationNames=[
'string',
]
)
applicationNames (list) –
[REQUIRED]
A list of application names separated by spaces. The maximum number of application names you can specify is 100.
(string) –
dict
Response Syntax
{
'applicationsInfo': [
{
'applicationId': 'string',
'applicationName': 'string',
'createTime': datetime(2015, 1, 1),
'linkedToGitHub': True|False,
'gitHubAccountName': 'string',
'computePlatform': 'Server'|'Lambda'|'ECS'
},
]
}
Response Structure
(dict) –
Represents the output of a BatchGetApplications
operation.
applicationsInfo (list) –
Information about the applications.
(dict) –
Information about an application.
applicationId (string) –
The application ID.
applicationName (string) –
The application name.
createTime (datetime) –
The time at which the application was created.
linkedToGitHub (boolean) –
True if the user has authenticated with GitHub for the specified application. Otherwise, false.
gitHubAccountName (string) –
The name for a connection to a GitHub account.
computePlatform (string) –
The destination platform type for deployment of the application (Lambda
or Server
).
Exceptions
Gets information about one or more deployment groups.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_deployment_groups(
applicationName='string',
deploymentGroupNames=[
'string',
]
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.
deploymentGroupNames (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'
},
],
'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'
},
]
},
],
'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) –
An Auto Scaling lifecycle event hook name.
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.
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 balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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.
errorMessage (string) –
Information about errors that might have occurred during the API call.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
Note
This method works, but is deprecated. Use BatchGetDeploymentTargets
instead.
Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets
works with all compute platforms. The maximum number of instances that can be returned is 25.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_deployment_instances(
deploymentId='string',
instanceIds=[
'string',
]
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment.
instanceIds (list) –
[REQUIRED]
The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
(string) –
dict
Response Syntax
{
'instancesSummary': [
{
'deploymentId': 'string',
'instanceId': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'instanceType': 'Blue'|'Green'
},
],
'errorMessage': 'string'
}
Response Structure
(dict) –
Represents the output of a BatchGetDeploymentInstances
operation.
instancesSummary (list) –
Information about the instance.
(dict) –
Information about an instance in a deployment.
deploymentId (string) –
The unique ID of a deployment.
instanceId (string) –
The instance ID.
status (string) –
The deployment status for this instance:
Pending
: The deployment is pending for this instance.
In Progress
: The deployment is in progress for this instance.
Succeeded
: The deployment has succeeded for this instance.
Failed
: The deployment has failed for this instance.
Skipped
: The deployment has been skipped for this instance.
Unknown
: The deployment status is unknown for this instance.
lastUpdatedAt (datetime) –
A timestamp that indicates when the instance information was last updated.
lifecycleEvents (list) –
A list of lifecycle events for this instance.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
instanceType (string) –
Information about which environment an instance belongs to in a blue/green deployment.
BLUE: The instance is part of the original environment.
GREEN: The instance is part of the replacement environment.
errorMessage (string) –
Information about errors that might have occurred during the API call.
Exceptions
Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances
. The maximum number of targets that can be returned is 25.
The type of targets returned depends on the deployment’s compute platform or deployment method:
EC2/On-premises : Information about Amazon EC2 instance targets.
Lambda : Information about Lambda functions targets.
Amazon ECS : Information about Amazon ECS service targets.
CloudFormation : Information about targets of blue/green deployments initiated by a CloudFormation stack update.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_deployment_targets(
deploymentId='string',
targetIds=[
'string',
]
)
deploymentId (string) – The unique ID of a deployment.
targetIds (list) –
The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is instanceTarget
.
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget
.
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>
. Their target type is ecsTarget
.
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget
.
(string) –
dict
Response Syntax
{
'deploymentTargets': [
{
'deploymentTargetType': 'InstanceTarget'|'LambdaTarget'|'ECSTarget'|'CloudFormationTarget',
'instanceTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'instanceLabel': 'Blue'|'Green'
},
'lambdaTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'lambdaFunctionInfo': {
'functionName': 'string',
'functionAlias': 'string',
'currentVersion': 'string',
'targetVersion': 'string',
'targetVersionWeight': 123.0
}
},
'ecsTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'taskSetsInfo': [
{
'identifer': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'status': 'string',
'trafficWeight': 123.0,
'targetGroup': {
'name': 'string'
},
'taskSetLabel': 'Blue'|'Green'
},
]
},
'cloudFormationTarget': {
'deploymentId': 'string',
'targetId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'resourceType': 'string',
'targetVersionWeight': 123.0
}
},
]
}
Response Structure
(dict) –
deploymentTargets (list) –
A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment’ compute platform.
EC2/On-premises : Each target object is an Amazon EC2 or on-premises instance.
Lambda : The target object is a specific version of an Lambda function.
Amazon ECS : The target object is an Amazon ECS service.
CloudFormation : The target object is an CloudFormation blue/green deployment.
(dict) –
Information about the deployment target.
deploymentTargetType (string) –
The deployment type that is specific to the deployment’s compute platform or deployments initiated by a CloudFormation stack update.
instanceTarget (dict) –
Information about the target for a deployment that uses the EC2/On-premises compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of instanceTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
status (string) –
The status an EC2/On-premises deployment’s target instance.
lastUpdatedAt (datetime) –
The date and time when the target instance was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target instance.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
instanceLabel (string) –
A label that identifies whether the instance is an original target (BLUE
) or a replacement target (GREEN
).
lambdaTarget (dict) –
Information about the target for a deployment that uses the Lambda compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of lambdaTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
status (string) –
The status an Lambda deployment’s target Lambda function.
lastUpdatedAt (datetime) –
The date and time when the target Lambda function was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target Lambda function.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
lambdaFunctionInfo (dict) –
A LambdaFunctionInfo
object that describes a target Lambda function.
functionName (string) –
The name of a Lambda function.
functionAlias (string) –
The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide .
currentVersion (string) –
The version of a Lambda function that production traffic points to.
targetVersion (string) –
The version of a Lambda function that production traffic points to after the Lambda function is deployed.
targetVersionWeight (float) –
The percentage of production traffic that the target version of a Lambda function receives.
ecsTarget (dict) –
Information about the target for a deployment that uses the Amazon ECS compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of ecsTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
lastUpdatedAt (datetime) –
The date and time when the target Amazon ECS application was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target Amazon ECS application.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
status (string) –
The status an Amazon ECS deployment’s target ECS application.
taskSetsInfo (list) –
The ECSTaskSet
objects associated with the ECS target.
(dict) –
Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.
identifer (string) –
A unique ID of an ECSTaskSet
.
desiredCount (integer) –
The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.
pendingCount (integer) –
The number of tasks in the task set that are in the PENDING
status during an Amazon ECS deployment. A task in the PENDING
state is preparing to enter the RUNNING
state. A task set enters the PENDING
status when it launches for the first time, or when it is restarted after being in the STOPPED
state.
runningCount (integer) –
The number of tasks in the task set that are in the RUNNING
status during an Amazon ECS deployment. A task in the RUNNING
state is running and ready for use.
status (string) –
The status of the task set. There are three valid task set statuses:
PRIMARY
: Indicates the task set is serving production traffic.
ACTIVE
: Indicates the task set is not serving production traffic.
DRAINING
: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
trafficWeight (float) –
The percentage of traffic served by this task set.
targetGroup (dict) –
The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
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.
taskSetLabel (string) –
A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).
cloudFormationTarget (dict) –
Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.
deploymentId (string) –
The unique ID of an CloudFormation blue/green deployment.
targetId (string) –
The unique ID of a deployment target that has a type of CloudFormationTarget
.
lastUpdatedAt (datetime) –
The date and time when the target application was updated by an CloudFormation blue/green deployment.
lifecycleEvents (list) –
The lifecycle events of the CloudFormation blue/green deployment to this target application.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
status (string) –
The status of an CloudFormation blue/green deployment’s target application.
resourceType (string) –
The resource type for the CloudFormation blue/green deployment.
targetVersionWeight (float) –
The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.
Exceptions
CodeDeploy.Client.exceptions.DeploymentDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentTargetIdRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentTargetIdException
CodeDeploy.Client.exceptions.DeploymentTargetDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentTargetListSizeExceededException
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
response = client.batch_get_deployments(
deploymentIds=[
'string',
]
)
deploymentIds (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',
'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.
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.
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 balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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.
Exceptions
Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_on_premises_instances(
instanceNames=[
'string',
]
)
instanceNames (list) –
[REQUIRED]
The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
(string) –
dict
Response Syntax
{
'instanceInfos': [
{
'instanceName': 'string',
'iamSessionArn': 'string',
'iamUserArn': 'string',
'instanceArn': 'string',
'registerTime': datetime(2015, 1, 1),
'deregisterTime': datetime(2015, 1, 1),
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) –
Represents the output of a BatchGetOnPremisesInstances
operation.
instanceInfos (list) –
Information about the on-premises instances.
(dict) –
Information about an on-premises instance.
instanceName (string) –
The name of the on-premises instance.
iamSessionArn (string) –
The ARN of the IAM session associated with the on-premises instance.
iamUserArn (string) –
The IAM user ARN associated with the on-premises instance.
instanceArn (string) –
The ARN of the on-premises instance.
registerTime (datetime) –
The time at which the on-premises instance was registered.
deregisterTime (datetime) –
If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
tags (list) –
The tags currently associated with the on-premises instance.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
Exceptions
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
See also: AWS API Documentation
Request Syntax
response = client.continue_deployment(
deploymentId='string',
deploymentWaitType='READY_WAIT'|'TERMINATION_WAIT'
)
deploymentId (string) – The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
deploymentWaitType (string) – The status of the deployment’s waiting period. READY_WAIT
indicates that the deployment is ready to start shifting traffic. TERMINATION_WAIT
indicates that the traffic is shifted, but the original target is not terminated.
None
Exceptions
CodeDeploy.Client.exceptions.DeploymentDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentAlreadyCompletedException
CodeDeploy.Client.exceptions.DeploymentIsNotInReadyStateException
CodeDeploy.Client.exceptions.UnsupportedActionForDeploymentTypeException
CodeDeploy.Client.exceptions.InvalidDeploymentWaitTypeException
CodeDeploy.Client.exceptions.InvalidDeploymentStatusException
Creates an application.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
applicationName='string',
computePlatform='Server'|'Lambda'|'ECS',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
applicationName (string) –
[REQUIRED]
The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.
computePlatform (string) – The destination platform type for the deployment (Lambda
, Server
, or ECS
).
tags (list) –
The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
dict
Response Syntax
{
'applicationId': 'string'
}
Response Structure
(dict) –
Represents the output of a CreateApplication
operation.
applicationId (string) –
A unique application ID.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationAlreadyExistsException
CodeDeploy.Client.exceptions.ApplicationLimitExceededException
CodeDeploy.Client.exceptions.InvalidComputePlatformException
Deploys an application revision through the specified deployment group.
See also: AWS API Documentation
Request Syntax
response = client.create_deployment(
applicationName='string',
deploymentGroupName='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'
}
},
deploymentConfigName='string',
description='string',
ignoreApplicationStopFailures=True|False,
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'
},
],
]
}
},
autoRollbackConfiguration={
'enabled': True|False,
'events': [
'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
]
},
updateOutdatedInstancesOnly=True|False,
fileExistsBehavior='DISALLOW'|'OVERWRITE'|'RETAIN',
overrideAlarmConfiguration={
'enabled': True|False,
'ignorePollAlarmFailure': True|False,
'alarms': [
{
'name': 'string'
},
]
}
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName (string) – The name of the deployment group.
revision (dict) –
The type and location of the revision to deploy.
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.
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.
deploymentConfigName (string) –
The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault
.``OneAtATime`` is used by default.
description (string) – A comment about the deployment.
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.
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.
autoRollbackConfiguration (dict) –
Configuration information for an automatic rollback that is added when a deployment 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) –
updateOutdatedInstancesOnly (boolean) – Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
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.
The fileExistsBehavior
parameter takes any of the following values:
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.
overrideAlarmConfiguration (dict) –
Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment
to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.
Note
If you specify an overrideAlarmConfiguration
, you need the UpdateDeploymentGroup
IAM permission when calling CreateDeployment
.
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
Response Syntax
{
'deploymentId': 'string'
}
Response Structure
(dict) –
Represents the output of a CreateDeployment
operation.
deploymentId (string) –
The unique ID of a deployment.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentLimitExceededException
CodeDeploy.Client.exceptions.InvalidTargetInstancesException
CodeDeploy.Client.exceptions.InvalidAutoRollbackConfigException
CodeDeploy.Client.exceptions.InvalidLoadBalancerInfoException
CodeDeploy.Client.exceptions.InvalidFileExistsBehaviorException
CodeDeploy.Client.exceptions.InvalidAutoScalingGroupException
CodeDeploy.Client.exceptions.InvalidUpdateOutdatedInstancesOnlyValueException
CodeDeploy.Client.exceptions.InvalidIgnoreApplicationStopFailuresValueException
CodeDeploy.Client.exceptions.InvalidGitHubAccountTokenException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException
Creates a deployment configuration.
See also: AWS API Documentation
Request Syntax
response = 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'
)
deploymentConfigName (string) –
[REQUIRED]
The name of the deployment configuration to create.
minimumHealthyHosts (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.
trafficRoutingConfig (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.
computePlatform (string) – The destination platform type for the deployment (Lambda
, Server
, or ECS
).
dict
Response Syntax
{
'deploymentConfigId': 'string'
}
Response Structure
(dict) –
Represents the output of a CreateDeploymentConfig
operation.
deploymentConfigId (string) –
A unique deployment configuration ID.
Exceptions
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.DeploymentConfigNameRequiredException
CodeDeploy.Client.exceptions.DeploymentConfigAlreadyExistsException
CodeDeploy.Client.exceptions.InvalidMinimumHealthyHostValueException
CodeDeploy.Client.exceptions.DeploymentConfigLimitExceededException
CodeDeploy.Client.exceptions.InvalidComputePlatformException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException
Creates a deployment group to which application revisions are deployed.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName (string) –
[REQUIRED]
The name of a new deployment group for the specified application.
deploymentConfigName (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 .
ec2TagFilters (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.
onPremisesInstanceTagFilters (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.
autoScalingGroups (list) –
A list of associated Amazon EC2 Auto Scaling groups.
(string) –
serviceRoleArn (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.
triggerConfigurations (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) –
alarmConfiguration (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.
autoRollbackConfiguration (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) –
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.
deploymentStyle (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.
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 used in a deployment.
elbInfoList (list) –
An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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) –
ec2TagSet (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.
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.
onPremisesTagSet (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.
tags (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.
dict
Response Syntax
{
'deploymentGroupId': 'string'
}
Response Structure
(dict) –
Represents the output of a CreateDeploymentGroup
operation.
deploymentGroupId (string) –
A unique deployment group ID.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupAlreadyExistsException
CodeDeploy.Client.exceptions.InvalidAutoScalingGroupException
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupLimitExceededException
CodeDeploy.Client.exceptions.LifecycleHookLimitExceededException
CodeDeploy.Client.exceptions.TriggerTargetsLimitExceededException
CodeDeploy.Client.exceptions.InvalidAutoRollbackConfigException
CodeDeploy.Client.exceptions.InvalidLoadBalancerInfoException
CodeDeploy.Client.exceptions.InvalidDeploymentStyleException
CodeDeploy.Client.exceptions.InvalidBlueGreenDeploymentConfigurationException
CodeDeploy.Client.exceptions.InvalidEC2TagCombinationException
CodeDeploy.Client.exceptions.InvalidOnPremisesTagCombinationException
CodeDeploy.Client.exceptions.TagSetListLimitExceededException
CodeDeploy.Client.exceptions.InvalidTargetGroupPairException
CodeDeploy.Client.exceptions.ECSServiceMappingLimitExceededException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException
Deletes an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
applicationName='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
None
Exceptions
Deletes a deployment configuration.
Note
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_deployment_config(
deploymentConfigName='string'
)
deploymentConfigName (string) –
[REQUIRED]
The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
None
Exceptions
Deletes a deployment group.
See also: AWS API Documentation
Request Syntax
response = client.delete_deployment_group(
applicationName='string',
deploymentGroupName='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName (string) –
[REQUIRED]
The name of a deployment group for the specified application.
dict
Response Syntax
{
'hooksNotCleanedUp': [
{
'name': 'string',
'hook': '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) –
An Auto Scaling lifecycle event hook name.
Exceptions
Deletes a GitHub account connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_git_hub_account_token(
tokenName='string'
)
tokenName (string) – The name of the GitHub account connection to delete.
dict
Response Syntax
{
'tokenName': 'string'
}
Response Structure
(dict) –
Represents the output of a DeleteGitHubAccountToken
operation.
tokenName (string) –
The name of the GitHub account connection that was deleted.
Exceptions
Deletes resources linked to an external ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_resources_by_external_id(
externalId='string'
)
externalId (string) – The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.
dict
Response Syntax
{}
Response Structure
(dict) –
Deregisters an on-premises instance.
See also: AWS API Documentation
Request Syntax
response = client.deregister_on_premises_instance(
instanceName='string'
)
instanceName (string) –
[REQUIRED]
The name of the on-premises instance to deregister.
None
Exceptions
Gets information about an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application(
applicationName='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
dict
Response Syntax
{
'application': {
'applicationId': 'string',
'applicationName': 'string',
'createTime': datetime(2015, 1, 1),
'linkedToGitHub': True|False,
'gitHubAccountName': 'string',
'computePlatform': 'Server'|'Lambda'|'ECS'
}
}
Response Structure
(dict) –
Represents the output of a GetApplication
operation.
application (dict) –
Information about the application.
applicationId (string) –
The application ID.
applicationName (string) –
The application name.
createTime (datetime) –
The time at which the application was created.
linkedToGitHub (boolean) –
True if the user has authenticated with GitHub for the specified application. Otherwise, false.
gitHubAccountName (string) –
The name for a connection to a GitHub account.
computePlatform (string) –
The destination platform type for deployment of the application (Lambda
or Server
).
Exceptions
Gets information about an application revision.
See also: AWS API Documentation
Request Syntax
response = client.get_application_revision(
applicationName='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'
}
}
)
applicationName (string) –
[REQUIRED]
The name of the application that corresponds to the revision.
revision (dict) –
[REQUIRED]
Information about the application revision to get, 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.
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.
dict
Response Syntax
{
'applicationName': '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'
}
},
'revisionInfo': {
'description': 'string',
'deploymentGroups': [
'string',
],
'firstUsedTime': datetime(2015, 1, 1),
'lastUsedTime': datetime(2015, 1, 1),
'registerTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) –
Represents the output of a GetApplicationRevision
operation.
applicationName (string) –
The name of the application that corresponds to the revision.
revision (dict) –
Additional information about the 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.
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.
revisionInfo (dict) –
General information about the revision.
description (string) –
A comment about the revision.
deploymentGroups (list) –
The deployment groups for which this is the current target revision.
(string) –
firstUsedTime (datetime) –
When the revision was first used by CodeDeploy.
lastUsedTime (datetime) –
When the revision was last used by CodeDeploy.
registerTime (datetime) –
When the revision was registered with CodeDeploy.
Exceptions
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
response = client.get_deployment(
deploymentId='string'
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment associated with the IAM 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',
'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.
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.
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 balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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.
Exceptions
Gets information about a deployment configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment_config(
deploymentConfigName='string'
)
deploymentConfigName (string) –
[REQUIRED]
The name of a deployment configuration associated with the IAM 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
}
}
}
}
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 instance.
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.
Exceptions
Gets information about a deployment group.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment_group(
applicationName='string',
deploymentGroupName='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName (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'
},
],
'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'
},
]
}
}
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) –
An Auto Scaling lifecycle event hook name.
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.
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 balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
Gets information about an instance as part of a deployment.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment_instance(
deploymentId='string',
instanceId='string'
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment.
instanceId (string) –
[REQUIRED]
The unique ID of an instance in the deployment group.
dict
Response Syntax
{
'instanceSummary': {
'deploymentId': 'string',
'instanceId': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'instanceType': 'Blue'|'Green'
}
}
Response Structure
(dict) –
Represents the output of a GetDeploymentInstance
operation.
instanceSummary (dict) –
Information about the instance.
deploymentId (string) –
The unique ID of a deployment.
instanceId (string) –
The instance ID.
status (string) –
The deployment status for this instance:
Pending
: The deployment is pending for this instance.
In Progress
: The deployment is in progress for this instance.
Succeeded
: The deployment has succeeded for this instance.
Failed
: The deployment has failed for this instance.
Skipped
: The deployment has been skipped for this instance.
Unknown
: The deployment status is unknown for this instance.
lastUpdatedAt (datetime) –
A timestamp that indicates when the instance information was last updated.
lifecycleEvents (list) –
A list of lifecycle events for this instance.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
instanceType (string) –
Information about which environment an instance belongs to in a blue/green deployment.
BLUE: The instance is part of the original environment.
GREEN: The instance is part of the replacement environment.
Exceptions
Returns information about a deployment target.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment_target(
deploymentId='string',
targetId='string'
)
deploymentId (string) – The unique ID of a deployment.
targetId (string) – The unique ID of a deployment target.
dict
Response Syntax
{
'deploymentTarget': {
'deploymentTargetType': 'InstanceTarget'|'LambdaTarget'|'ECSTarget'|'CloudFormationTarget',
'instanceTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'instanceLabel': 'Blue'|'Green'
},
'lambdaTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'lambdaFunctionInfo': {
'functionName': 'string',
'functionAlias': 'string',
'currentVersion': 'string',
'targetVersion': 'string',
'targetVersionWeight': 123.0
}
},
'ecsTarget': {
'deploymentId': 'string',
'targetId': 'string',
'targetArn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'taskSetsInfo': [
{
'identifer': 'string',
'desiredCount': 123,
'pendingCount': 123,
'runningCount': 123,
'status': 'string',
'trafficWeight': 123.0,
'targetGroup': {
'name': 'string'
},
'taskSetLabel': 'Blue'|'Green'
},
]
},
'cloudFormationTarget': {
'deploymentId': 'string',
'targetId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'lifecycleEvents': [
{
'lifecycleEventName': 'string',
'diagnostics': {
'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
'scriptName': 'string',
'message': 'string',
'logTail': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
},
],
'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
'resourceType': 'string',
'targetVersionWeight': 123.0
}
}
}
Response Structure
(dict) –
deploymentTarget (dict) –
A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target’s type (instanceTarget
, lambdaTarget
, or ecsTarget
).
deploymentTargetType (string) –
The deployment type that is specific to the deployment’s compute platform or deployments initiated by a CloudFormation stack update.
instanceTarget (dict) –
Information about the target for a deployment that uses the EC2/On-premises compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of instanceTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
status (string) –
The status an EC2/On-premises deployment’s target instance.
lastUpdatedAt (datetime) –
The date and time when the target instance was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target instance.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
instanceLabel (string) –
A label that identifies whether the instance is an original target (BLUE
) or a replacement target (GREEN
).
lambdaTarget (dict) –
Information about the target for a deployment that uses the Lambda compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of lambdaTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
status (string) –
The status an Lambda deployment’s target Lambda function.
lastUpdatedAt (datetime) –
The date and time when the target Lambda function was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target Lambda function.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
lambdaFunctionInfo (dict) –
A LambdaFunctionInfo
object that describes a target Lambda function.
functionName (string) –
The name of a Lambda function.
functionAlias (string) –
The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide .
currentVersion (string) –
The version of a Lambda function that production traffic points to.
targetVersion (string) –
The version of a Lambda function that production traffic points to after the Lambda function is deployed.
targetVersionWeight (float) –
The percentage of production traffic that the target version of a Lambda function receives.
ecsTarget (dict) –
Information about the target for a deployment that uses the Amazon ECS compute platform.
deploymentId (string) –
The unique ID of a deployment.
targetId (string) –
The unique ID of a deployment target that has a type of ecsTarget
.
targetArn (string) –
The Amazon Resource Name (ARN) of the target.
lastUpdatedAt (datetime) –
The date and time when the target Amazon ECS application was updated by a deployment.
lifecycleEvents (list) –
The lifecycle events of the deployment to this target Amazon ECS application.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
status (string) –
The status an Amazon ECS deployment’s target ECS application.
taskSetsInfo (list) –
The ECSTaskSet
objects associated with the ECS target.
(dict) –
Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.
identifer (string) –
A unique ID of an ECSTaskSet
.
desiredCount (integer) –
The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.
pendingCount (integer) –
The number of tasks in the task set that are in the PENDING
status during an Amazon ECS deployment. A task in the PENDING
state is preparing to enter the RUNNING
state. A task set enters the PENDING
status when it launches for the first time, or when it is restarted after being in the STOPPED
state.
runningCount (integer) –
The number of tasks in the task set that are in the RUNNING
status during an Amazon ECS deployment. A task in the RUNNING
state is running and ready for use.
status (string) –
The status of the task set. There are three valid task set statuses:
PRIMARY
: Indicates the task set is serving production traffic.
ACTIVE
: Indicates the task set is not serving production traffic.
DRAINING
: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
trafficWeight (float) –
The percentage of traffic served by this task set.
targetGroup (dict) –
The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
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.
taskSetLabel (string) –
A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).
cloudFormationTarget (dict) –
Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.
deploymentId (string) –
The unique ID of an CloudFormation blue/green deployment.
targetId (string) –
The unique ID of a deployment target that has a type of CloudFormationTarget
.
lastUpdatedAt (datetime) –
The date and time when the target application was updated by an CloudFormation blue/green deployment.
lifecycleEvents (list) –
The lifecycle events of the CloudFormation blue/green deployment to this target application.
(dict) –
Information about a deployment lifecycle event.
lifecycleEventName (string) –
The deployment lifecycle event name, such as ApplicationStop
, BeforeInstall
, AfterInstall
, ApplicationStart
, or ValidateService
.
diagnostics (dict) –
Diagnostic information about the deployment lifecycle event.
errorCode (string) –
The associated error code:
Success: The specified script ran.
ScriptMissing: The specified script was not found in the specified location.
ScriptNotExecutable: The specified script is not a recognized executable file type.
ScriptTimedOut: The specified script did not finish running in the specified time period.
ScriptFailed: The specified script failed to run as expected.
UnknownError: The specified script did not run for an unknown reason.
scriptName (string) –
The name of the script.
message (string) –
The message associated with the error.
logTail (string) –
The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
startTime (datetime) –
A timestamp that indicates when the deployment lifecycle event started.
endTime (datetime) –
A timestamp that indicates when the deployment lifecycle event ended.
status (string) –
The deployment lifecycle event status:
Pending: The deployment lifecycle event is pending.
InProgress: The deployment lifecycle event is in progress.
Succeeded: The deployment lifecycle event ran successfully.
Failed: The deployment lifecycle event has failed.
Skipped: The deployment lifecycle event has been skipped.
Unknown: The deployment lifecycle event is unknown.
status (string) –
The status of an CloudFormation blue/green deployment’s target application.
resourceType (string) –
The resource type for the CloudFormation blue/green deployment.
targetVersionWeight (float) –
The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.
Exceptions
Gets information about an on-premises instance.
See also: AWS API Documentation
Request Syntax
response = client.get_on_premises_instance(
instanceName='string'
)
instanceName (string) –
[REQUIRED]
The name of the on-premises instance about which to get information.
dict
Response Syntax
{
'instanceInfo': {
'instanceName': 'string',
'iamSessionArn': 'string',
'iamUserArn': 'string',
'instanceArn': 'string',
'registerTime': datetime(2015, 1, 1),
'deregisterTime': datetime(2015, 1, 1),
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) –
Represents the output of a GetOnPremisesInstance
operation.
instanceInfo (dict) –
Information about the on-premises instance.
instanceName (string) –
The name of the on-premises instance.
iamSessionArn (string) –
The ARN of the IAM session associated with the on-premises instance.
iamUserArn (string) –
The IAM user ARN associated with the on-premises instance.
instanceArn (string) –
The ARN of the on-premises instance.
registerTime (datetime) –
The time at which the on-premises instance was registered.
deregisterTime (datetime) –
If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
tags (list) –
The tags currently associated with the on-premises instance.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Lists information about revisions for an application.
See also: AWS API Documentation
Request Syntax
response = client.list_application_revisions(
applicationName='string',
sortBy='registerTime'|'firstUsedTime'|'lastUsedTime',
sortOrder='ascending'|'descending',
s3Bucket='string',
s3KeyPrefix='string',
deployed='include'|'exclude'|'ignore',
nextToken='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
sortBy (string) –
The column name to use to sort the list results:
registerTime
: Sort by the time the revisions were registered with CodeDeploy.
firstUsedTime
: Sort by the time the revisions were first used in a deployment.
lastUsedTime
: Sort by the time the revisions were last used in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
sortOrder (string) –
The order in which to sort the list results:
ascending
: ascending order.
descending
: descending order.
If not specified, the results are sorted in ascending order.
If set to null, the results are sorted in an arbitrary order.
s3Bucket (string) –
An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user’s buckets are searched.
s3KeyPrefix (string) – A key prefix for the set of Amazon S3 objects to limit the search for revisions.
deployed (string) –
Whether to list revisions based on whether the revision is the target revision of a deployment group:
include
: List revisions that are target revisions of a deployment group.
exclude
: Do not list revisions that are target revisions of a deployment group.
ignore
: List all revisions.
nextToken (string) – An identifier returned from the previous ListApplicationRevisions
call. It can be used to return the next set of applications in the list.
dict
Response Syntax
{
'revisions': [
{
'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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListApplicationRevisions
operation.
revisions (list) –
A list of locations that contain the matching revisions.
(dict) –
Information about the location of an application revision.
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.
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.
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
Exceptions
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.InvalidBucketNameFilterException
CodeDeploy.Client.exceptions.InvalidKeyPrefixFilterException
CodeDeploy.Client.exceptions.BucketNameFilterRequiredException
CodeDeploy.Client.exceptions.InvalidDeployedStateFilterException
Lists the applications registered with the IAM user or Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
nextToken='string'
)
nextToken (string) – An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
dict
Response Syntax
{
'applications': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListApplications operation.
applications (list) –
A list of application names.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.
Exceptions
Lists the deployment configurations with the IAM user or Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_configs(
nextToken='string'
)
nextToken (string) – An identifier returned from the previous ListDeploymentConfigs
call. It can be used to return the next set of deployment configurations in the list.
dict
Response Syntax
{
'deploymentConfigsList': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentConfigs
operation.
deploymentConfigsList (list) –
A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime
.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
Exceptions
Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_groups(
applicationName='string',
nextToken='string'
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
nextToken (string) – An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
dict
Response Syntax
{
'applicationName': 'string',
'deploymentGroups': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentGroups
operation.
applicationName (string) –
The application name.
deploymentGroups (list) –
A list of deployment group names.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
Exceptions
Note
The newer BatchGetDeploymentTargets
should be used instead because it works with all compute types. ListDeploymentInstances
throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.
Lists the instance for a deployment associated with the IAM user or Amazon Web Services account.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_instances(
deploymentId='string',
nextToken='string',
instanceStatusFilter=[
'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
],
instanceTypeFilter=[
'Blue'|'Green',
]
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment.
nextToken (string) – An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
instanceStatusFilter (list) –
A subset of instances to list by status:
Pending
: Include those instances with pending deployments.
InProgress
: Include those instances where deployments are still in progress.
Succeeded
: Include those instances with successful deployments.
Failed
: Include those instances with failed deployments.
Skipped
: Include those instances with skipped deployments.
Unknown
: Include those instances with deployments in an unknown state.
(string) –
instanceTypeFilter (list) –
The set of instances in a blue/green deployment, either those in the original environment (“BLUE”) or those in the replacement environment (“GREEN”), for which you want to view instance information.
(string) –
dict
Response Syntax
{
'instancesList': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentInstances
operation.
instancesList (list) –
A list of instance IDs.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
Exceptions
Returns an array of target IDs that are associated a deployment.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_targets(
deploymentId='string',
nextToken='string',
targetFilters={
'string': [
'string',
]
}
)
deploymentId (string) – The unique ID of a deployment.
nextToken (string) – A token identifier returned from the previous ListDeploymentTargets
call. It can be used to return the next set of deployment targets in the list.
targetFilters (dict) –
A key used to filter the returned targets. The two valid values are:
TargetStatus
- A TargetStatus
filter string can be Failed
, InProgress
, Pending
, Ready
, Skipped
, Succeeded
, or Unknown
.
ServerInstanceLabel
- A ServerInstanceLabel
filter string can be Blue
or Green
.
(string) –
(list) –
(string) –
dict
Response Syntax
{
'targetIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
targetIds (list) –
The unique IDs of deployment targets.
(string) –
nextToken (string) –
If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets
call to return the next set of deployment targets in the list.
Exceptions
Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_deployments(
applicationName='string',
deploymentGroupName='string',
externalId='string',
includeOnlyStatuses=[
'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
],
createTimeRange={
'start': datetime(2015, 1, 1),
'end': datetime(2015, 1, 1)
},
nextToken='string'
)
applicationName (string) –
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
Note
If applicationName
is specified, then deploymentGroupName
must be specified. If it is not specified, then deploymentGroupName
must not be specified.
deploymentGroupName (string) –
The name of a deployment group for the specified application.
Note
If deploymentGroupName
is specified, then applicationName
must be specified. If it is not specified, then applicationName
must not be specified.
externalId (string) – The unique ID of an external resource for returning deployments linked to the external resource.
includeOnlyStatuses (list) –
A subset of deployments to list by status:
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
(string) –
createTimeRange (dict) –
A time range (start and end) for returning a subset of the list of deployments.
start (datetime) –
The start time of the time range.
Note
Specify null to leave the start time open-ended.
end (datetime) –
The end time of the time range.
Note
Specify null to leave the end time open-ended.
nextToken (string) – An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
dict
Response Syntax
{
'deployments': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeployments
operation.
deployments (list) –
A list of deployment IDs.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentStatusException
Lists the names of stored connections to GitHub accounts.
See also: AWS API Documentation
Request Syntax
response = client.list_git_hub_account_token_names(
nextToken='string'
)
nextToken (string) – An identifier returned from the previous ListGitHubAccountTokenNames
call. It can be used to return the next set of names in the list.
dict
Response Syntax
{
'tokenNameList': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListGitHubAccountTokenNames
operation.
tokenNameList (list) –
A list of names of connections to GitHub accounts.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames
call to return the next set of names in the list.
Exceptions
Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
See also: AWS API Documentation
Request Syntax
response = client.list_on_premises_instances(
registrationStatus='Registered'|'Deregistered',
tagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
nextToken='string'
)
registrationStatus (string) –
The registration status of the on-premises instances:
Deregistered
: Include deregistered on-premises instances in the resulting list.
Registered
: Include registered on-premises instances in the resulting list.
tagFilters (list) –
The on-premises instance tags that are used to restrict the on-premises instance names returned.
(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.
nextToken (string) – An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
dict
Response Syntax
{
'instanceNames': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) –
Represents the output of the list on-premises instances operation.
instanceNames (list) –
The list of matching on-premises instance names.
(string) –
nextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
Exceptions
Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string',
NextToken='string'
)
ResourceArn (string) –
[REQUIRED]
The ARN of a CodeDeploy resource. ListTagsForResource
returns all the tags associated with the resource that is identified by the ResourceArn
.
NextToken (string) – An identifier returned from the previous ListTagsForResource
call. It can be used to return the next set of applications in the list.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Tags (list) –
A list of tags returned by ListTagsForResource
. The tags are associated with the resource identified by the input ResourceArn
parameter.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
NextToken (string) –
If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
Exceptions
Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic
and AfterAllowTraffic
. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall
, AfterInstall
, AfterAllowTestTraffic
, BeforeAllowTraffic
, and AfterAllowTraffic
. Lambda validation functions return Succeeded
or Failed
. For more information, see AppSpec ‘hooks’ Section for an Lambda Deployment and AppSpec ‘hooks’ Section for an Amazon ECS Deployment .
See also: AWS API Documentation
Request Syntax
response = client.put_lifecycle_event_hook_execution_status(
deploymentId='string',
lifecycleEventHookExecutionId='string',
status='Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
)
deploymentId (string) – The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
lifecycleEventHookExecutionId (string) – The execution ID of a deployment’s lifecycle hook. A deployment lifecycle hook is specified in the hooks
section of the AppSpec file.
status (string) – The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only Succeeded
and Failed
can be passed successfully in your API call.
dict
Response Syntax
{
'lifecycleEventHookExecutionId': 'string'
}
Response Structure
(dict) –
lifecycleEventHookExecutionId (string) –
The execution ID of the lifecycle event hook. A hook is specified in the hooks
section of the deployment’s AppSpec file.
Exceptions
CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionStatusException
CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionIdException
CodeDeploy.Client.exceptions.LifecycleEventAlreadyCompletedException
CodeDeploy.Client.exceptions.DeploymentDoesNotExistException
CodeDeploy.Client.exceptions.UnsupportedActionForDeploymentTypeException
Registers with CodeDeploy a revision for the specified application.
See also: AWS API Documentation
Request Syntax
response = client.register_application_revision(
applicationName='string',
description='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'
}
}
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
description (string) – A comment about the revision.
revision (dict) –
[REQUIRED]
Information about the application revision to register, 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.
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.
None
Exceptions
Registers an on-premises instance.
Note
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
See also: AWS API Documentation
Request Syntax
response = client.register_on_premises_instance(
instanceName='string',
iamSessionArn='string',
iamUserArn='string'
)
instanceName (string) –
[REQUIRED]
The name of the on-premises instance to register.
iamSessionArn (string) – The ARN of the IAM session to associate with the on-premises instance.
iamUserArn (string) – The ARN of the IAM user to associate with the on-premises instance.
None
Exceptions
Removes one or more tags from one or more on-premises instances.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_on_premises_instances(
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
instanceNames=[
'string',
]
)
tags (list) –
[REQUIRED]
The tag key-value pairs to remove from the on-premises instances.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
instanceNames (list) –
[REQUIRED]
The names of the on-premises instances from which to remove tags.
(string) –
None
Exceptions
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.skip_wait_time_for_instance_termination(
deploymentId='string'
)
deploymentId (string) – The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
None
Exceptions
Attempts to stop an ongoing deployment.
See also: AWS API Documentation
Request Syntax
response = client.stop_deployment(
deploymentId='string',
autoRollbackEnabled=True|False
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment.
autoRollbackEnabled (boolean) – Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
dict
Response Syntax
{
'status': 'Pending'|'Succeeded',
'statusMessage': 'string'
}
Response Structure
(dict) –
Represents the output of a StopDeployment
operation.
status (string) –
The status of the stop deployment operation:
Pending: The stop operation is pending.
Succeeded: The stop operation was successful.
statusMessage (string) –
An accompanying status message.
Exceptions
Associates the list of tags in the input Tags
parameter with the resource identified by the ResourceArn
input parameter.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
ResourceArn (string) –
[REQUIRED]
The ARN of a resource, such as a CodeDeploy application or deployment group.
Tags (list) –
[REQUIRED]
A list of tags that TagResource
associates with a resource. The resource is identified by the ResourceArn
input parameter.
(dict) –
Information about a tag.
Key (string) –
The tag’s key.
Value (string) –
The tag’s value.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Disassociates a resource from a list of tags. The resource is identified by the ResourceArn
input parameter. The tags are identified by the list of keys in the TagKeys
input parameter.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys
input parameter.
TagKeys (list) –
[REQUIRED]
A list of keys of Tag
objects. The Tag
objects identified by the keys are disassociated from the resource specified by the ResourceArn
input parameter.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Changes the name of an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
applicationName='string',
newApplicationName='string'
)
applicationName (string) – The current name of the application you want to change.
newApplicationName (string) – The new name to give the application.
None
Exceptions
Changes information about a deployment group.
See also: AWS API Documentation
Request Syntax
response = 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'
},
],
]
}
)
applicationName (string) –
[REQUIRED]
The application name that corresponds to the deployment group to update.
currentDeploymentGroupName (string) –
[REQUIRED]
The current name of the deployment group.
newDeploymentGroupName (string) – The new name of the deployment group, if you want to change it.
deploymentConfigName (string) – The replacement deployment configuration name to use, if you want to change it.
ec2TagFilters (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.
onPremisesInstanceTagFilters (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.
autoScalingGroups (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) –
serviceRoleArn (string) – A replacement ARN for the service role, if you want to change it.
triggerConfigurations (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) –
alarmConfiguration (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.
autoRollbackConfiguration (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) –
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.
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.
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 used in a deployment.
elbInfoList (list) –
An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.
Note
Adding more than one load balancer to the array is not supported.
(dict) –
Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
name (string) –
For blue/green deployments, the name of the 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 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 group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.
Note
Adding more than one target group to the array is not supported.
(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) –
ec2TagSet (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.
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.
onPremisesTagSet (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.
dict
Response Syntax
{
'hooksNotCleanedUp': [
{
'name': 'string',
'hook': '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) –
An Auto Scaling lifecycle event hook name.
Exceptions
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupAlreadyExistsException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.InvalidAutoScalingGroupException
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
CodeDeploy.Client.exceptions.LifecycleHookLimitExceededException
CodeDeploy.Client.exceptions.TriggerTargetsLimitExceededException
CodeDeploy.Client.exceptions.InvalidAutoRollbackConfigException
CodeDeploy.Client.exceptions.InvalidLoadBalancerInfoException
CodeDeploy.Client.exceptions.InvalidDeploymentStyleException
CodeDeploy.Client.exceptions.InvalidBlueGreenDeploymentConfigurationException
CodeDeploy.Client.exceptions.InvalidEC2TagCombinationException
CodeDeploy.Client.exceptions.InvalidOnPremisesTagCombinationException
CodeDeploy.Client.exceptions.TagSetListLimitExceededException
CodeDeploy.Client.exceptions.InvalidTargetGroupPairException
CodeDeploy.Client.exceptions.ECSServiceMappingLimitExceededException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
CodeDeploy.Client.exceptions.ApplicationAlreadyExistsException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.ApplicationLimitExceededException
CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.BucketNameFilterRequiredException
CodeDeploy.Client.exceptions.DeploymentAlreadyCompletedException
CodeDeploy.Client.exceptions.DeploymentAlreadyStartedException
CodeDeploy.Client.exceptions.DeploymentConfigAlreadyExistsException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentConfigLimitExceededException
CodeDeploy.Client.exceptions.DeploymentConfigNameRequiredException
CodeDeploy.Client.exceptions.DeploymentDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupAlreadyExistsException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentGroupLimitExceededException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.DeploymentIsNotInReadyStateException
CodeDeploy.Client.exceptions.DeploymentLimitExceededException
CodeDeploy.Client.exceptions.DeploymentTargetDoesNotExistException
CodeDeploy.Client.exceptions.DeploymentTargetIdRequiredException
CodeDeploy.Client.exceptions.DeploymentTargetListSizeExceededException
CodeDeploy.Client.exceptions.ECSServiceMappingLimitExceededException
CodeDeploy.Client.exceptions.GitHubAccountTokenDoesNotExistException
CodeDeploy.Client.exceptions.GitHubAccountTokenNameRequiredException
CodeDeploy.Client.exceptions.IamSessionArnAlreadyRegisteredException
CodeDeploy.Client.exceptions.IamUserArnAlreadyRegisteredException
CodeDeploy.Client.exceptions.InstanceNameAlreadyRegisteredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.InvalidAutoRollbackConfigException
CodeDeploy.Client.exceptions.InvalidAutoScalingGroupException
CodeDeploy.Client.exceptions.InvalidBlueGreenDeploymentConfigurationException
CodeDeploy.Client.exceptions.InvalidBucketNameFilterException
CodeDeploy.Client.exceptions.InvalidComputePlatformException
CodeDeploy.Client.exceptions.InvalidDeployedStateFilterException
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.InvalidDeploymentInstanceTypeException
CodeDeploy.Client.exceptions.InvalidDeploymentStatusException
CodeDeploy.Client.exceptions.InvalidDeploymentStyleException
CodeDeploy.Client.exceptions.InvalidDeploymentTargetIdException
CodeDeploy.Client.exceptions.InvalidDeploymentWaitTypeException
CodeDeploy.Client.exceptions.InvalidEC2TagCombinationException
CodeDeploy.Client.exceptions.InvalidFileExistsBehaviorException
CodeDeploy.Client.exceptions.InvalidGitHubAccountTokenException
CodeDeploy.Client.exceptions.InvalidGitHubAccountTokenNameException
CodeDeploy.Client.exceptions.InvalidIgnoreApplicationStopFailuresValueException
CodeDeploy.Client.exceptions.InvalidKeyPrefixFilterException
CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionIdException
CodeDeploy.Client.exceptions.InvalidLifecycleEventHookExecutionStatusException
CodeDeploy.Client.exceptions.InvalidLoadBalancerInfoException
CodeDeploy.Client.exceptions.InvalidMinimumHealthyHostValueException
CodeDeploy.Client.exceptions.InvalidOnPremisesTagCombinationException
CodeDeploy.Client.exceptions.InvalidRegistrationStatusException
CodeDeploy.Client.exceptions.InvalidTargetFilterNameException
CodeDeploy.Client.exceptions.InvalidTargetGroupPairException
CodeDeploy.Client.exceptions.InvalidTargetInstancesException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException
CodeDeploy.Client.exceptions.InvalidUpdateOutdatedInstancesOnlyValueException
CodeDeploy.Client.exceptions.LifecycleEventAlreadyCompletedException
CodeDeploy.Client.exceptions.LifecycleHookLimitExceededException
CodeDeploy.Client.exceptions.MultipleIamArnsProvidedException
CodeDeploy.Client.exceptions.TagSetListLimitExceededException
CodeDeploy.Client.exceptions.TriggerTargetsLimitExceededException
CodeDeploy.Client.exceptions.UnsupportedActionForDeploymentTypeException
The maximum number of alarms for a deployment group (10) was exceeded.
Example
try:
...
except client.exceptions.AlarmsLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum number of alarms for a deployment group (10) was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An application with the specified name with the IAM user or Amazon Web Services account already exists.
Example
try:
...
except client.exceptions.ApplicationAlreadyExistsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An application with the specified name with the IAM user or Amazon Web Services account already exists.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The application does not exist with the IAM user or Amazon Web Services account.
Example
try:
...
except client.exceptions.ApplicationDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The application does not exist with the IAM user or Amazon Web Services account.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
More applications were attempted to be created than are allowed.
Example
try:
...
except client.exceptions.ApplicationLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
More applications were attempted to be created than are allowed.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The minimum number of required application names was not specified.
Example
try:
...
except client.exceptions.ApplicationNameRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The minimum number of required application names was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
Example
try:
...
except client.exceptions.ArnNotSupportedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The maximum number of names or IDs allowed for this request (100) was exceeded.
Example
try:
...
except client.exceptions.BatchLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum number of names or IDs allowed for this request (100) was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A bucket name is required, but was not provided.
Example
try:
...
except client.exceptions.BucketNameFilterRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A bucket name is required, but was not provided.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment is already complete.
Example
try:
...
except client.exceptions.DeploymentAlreadyCompletedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment is already complete.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A deployment to a target was attempted while another deployment was in progress.
Example
try:
...
except client.exceptions.DeploymentAlreadyStartedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A deployment to a target was attempted while another deployment was in progress.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A deployment configuration with the specified name with the IAM user or Amazon Web Services account already exists.
Example
try:
...
except client.exceptions.DeploymentConfigAlreadyExistsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A deployment configuration with the specified name with the IAM user or Amazon Web Services account already exists.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment configuration does not exist with the IAM user or Amazon Web Services account.
Example
try:
...
except client.exceptions.DeploymentConfigDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment configuration does not exist with the IAM user or Amazon Web Services account.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment configuration is still in use.
Example
try:
...
except client.exceptions.DeploymentConfigInUseException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment configuration is still in use.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment configurations limit was exceeded.
Example
try:
...
except client.exceptions.DeploymentConfigLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment configurations limit was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment configuration name was not specified.
Example
try:
...
except client.exceptions.DeploymentConfigNameRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment configuration name was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment with the IAM user or Amazon Web Services account does not exist.
Example
try:
...
except client.exceptions.DeploymentDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment with the IAM user or Amazon Web Services account does not exist.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A deployment group with the specified name with the IAM user or Amazon Web Services account already exists.
Example
try:
...
except client.exceptions.DeploymentGroupAlreadyExistsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A deployment group with the specified name with the IAM user or Amazon Web Services account already exists.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The named deployment group with the IAM user or Amazon Web Services account does not exist.
Example
try:
...
except client.exceptions.DeploymentGroupDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The named deployment group with the IAM user or Amazon Web Services account does not exist.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment groups limit was exceeded.
Example
try:
...
except client.exceptions.DeploymentGroupLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment groups limit was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment group name was not specified.
Example
try:
...
except client.exceptions.DeploymentGroupNameRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment group name was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
At least one deployment ID must be specified.
Example
try:
...
except client.exceptions.DeploymentIdRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
At least one deployment ID must be specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment does not have a status of Ready and can’t continue yet.
Example
try:
...
except client.exceptions.DeploymentIsNotInReadyStateException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment does not have a status of Ready and can’t continue yet.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The number of allowed deployments was exceeded.
Example
try:
...
except client.exceptions.DeploymentLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The number of allowed deployments was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified deployment has not started.
Example
try:
...
except client.exceptions.DeploymentNotStartedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified deployment has not started.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The provided target ID does not belong to the attempted deployment.
Example
try:
...
except client.exceptions.DeploymentTargetDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The provided target ID does not belong to the attempted deployment.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A deployment target ID was not provided.
Example
try:
...
except client.exceptions.DeploymentTargetIdRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A deployment target ID was not provided.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
Example
try:
...
except client.exceptions.DeploymentTargetListSizeExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The description is too long.
Example
try:
...
except client.exceptions.DescriptionTooLongException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The description is too long.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
Example
try:
...
except client.exceptions.ECSServiceMappingLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
No GitHub account connection exists with the named specified in the call.
Example
try:
...
except client.exceptions.GitHubAccountTokenDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
No GitHub account connection exists with the named specified in the call.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The call is missing a required GitHub account connection name.
Example
try:
...
except client.exceptions.GitHubAccountTokenNameRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The call is missing a required GitHub account connection name.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.
Example
try:
...
except client.exceptions.IamArnRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The request included an IAM session ARN that has already been used to register a different instance.
Example
try:
...
except client.exceptions.IamSessionArnAlreadyRegisteredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The request included an IAM session ARN that has already been used to register a different instance.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified IAM user ARN is already registered with an on-premises instance.
Example
try:
...
except client.exceptions.IamUserArnAlreadyRegisteredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified IAM user ARN is already registered with an on-premises instance.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An IAM user ARN was not specified.
Example
try:
...
except client.exceptions.IamUserArnRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An IAM user ARN was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified instance does not exist in the deployment group.
Example
try:
...
except client.exceptions.InstanceDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified instance does not exist in the deployment group.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The instance ID was not specified.
Example
try:
...
except client.exceptions.InstanceIdRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The instance ID was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The maximum number of allowed on-premises instances in a single call was exceeded.
Example
try:
...
except client.exceptions.InstanceLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum number of allowed on-premises instances in a single call was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified on-premises instance name is already registered.
Example
try:
...
except client.exceptions.InstanceNameAlreadyRegisteredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified on-premises instance name is already registered.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An on-premises instance name was not specified.
Example
try:
...
except client.exceptions.InstanceNameRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An on-premises instance name was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified on-premises instance is not registered.
Example
try:
...
except client.exceptions.InstanceNotRegisteredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified on-premises instance is not registered.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The format of the alarm configuration is invalid. Possible causes include:
The alarm list is null.
The alarm object is null.
The alarm name is empty or null or exceeds the limit of 255 characters.
Two alarms with the same name have been specified.
The alarm configuration is enabled, but the alarm list is empty.
Example
try:
...
except client.exceptions.InvalidAlarmConfigException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The format of the alarm configuration is invalid. Possible causes include:
The alarm list is null.
The alarm object is null.
The alarm name is empty or null or exceeds the limit of 255 characters.
Two alarms with the same name have been specified.
The alarm configuration is enabled, but the alarm list is empty.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The application name was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidApplicationNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The application name was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified ARN is not in a valid format.
Example
try:
...
except client.exceptions.InvalidArnException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified ARN is not in a valid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
Example
try:
...
except client.exceptions.InvalidAutoRollbackConfigException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The Auto Scaling group was specified in an invalid format or does not exist.
Example
try:
...
except client.exceptions.InvalidAutoScalingGroupException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The Auto Scaling group was specified in an invalid format or does not exist.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig .
Example
try:
...
except client.exceptions.InvalidBlueGreenDeploymentConfigurationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig .
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The bucket name either doesn’t exist or was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidBucketNameFilterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The bucket name either doesn’t exist or was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The computePlatform is invalid. The computePlatform should be Lambda
, Server
, or ECS
.
Example
try:
...
except client.exceptions.InvalidComputePlatformException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The computePlatform is invalid. The computePlatform should be Lambda
, Server
, or ECS
.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployed state filter was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidDeployedStateFilterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployed state filter was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment configuration name was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidDeploymentConfigNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment configuration name was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The deployment group name was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidDeploymentGroupNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The deployment group name was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
At least one of the deployment IDs was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidDeploymentIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
At least one of the deployment IDs was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
Example
try:
...
except client.exceptions.InvalidDeploymentInstanceTypeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified deployment status doesn’t exist or cannot be determined.
Example
try:
...
except client.exceptions.InvalidDeploymentStatusException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified deployment status doesn’t exist or cannot be determined.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An invalid deployment style was specified. Valid deployment types include “IN_PLACE” and “BLUE_GREEN.” Valid deployment options include “WITH_TRAFFIC_CONTROL” and “WITHOUT_TRAFFIC_CONTROL.”
Example
try:
...
except client.exceptions.InvalidDeploymentStyleException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An invalid deployment style was specified. Valid deployment types include “IN_PLACE” and “BLUE_GREEN.” Valid deployment options include “WITH_TRAFFIC_CONTROL” and “WITHOUT_TRAFFIC_CONTROL.”
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The target ID provided was not valid.
Example
try:
...
except client.exceptions.InvalidDeploymentTargetIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The target ID provided was not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The wait type is invalid.
Example
try:
...
except client.exceptions.InvalidDeploymentWaitTypeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The wait type is invalid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
Example
try:
...
except client.exceptions.InvalidEC2TagCombinationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The tag was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidEC2TagException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The tag was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The Amazon ECS service identifier is not valid.
Example
try:
...
except client.exceptions.InvalidECSServiceException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The Amazon ECS service identifier is not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The external ID was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidExternalIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The external ID was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren’t part of the previous successful deployment. Valid values include “DISALLOW,” “OVERWRITE,” and “RETAIN.”
Example
try:
...
except client.exceptions.InvalidFileExistsBehaviorException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren’t part of the previous successful deployment. Valid values include “DISALLOW,” “OVERWRITE,” and “RETAIN.”
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The GitHub token is not valid.
Example
try:
...
except client.exceptions.InvalidGitHubAccountTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The GitHub token is not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The format of the specified GitHub account connection name is invalid.
Example
try:
...
except client.exceptions.InvalidGitHubAccountTokenNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The format of the specified GitHub account connection name is invalid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The IAM session ARN was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidIamSessionArnException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The IAM session ARN was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The IAM user ARN was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidIamUserArnException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The IAM user ARN was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The IgnoreApplicationStopFailures value is invalid. For Lambda deployments, false
is expected. For EC2/On-premises deployments, true
or false
is expected.
Example
try:
...
except client.exceptions.InvalidIgnoreApplicationStopFailuresValueException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The IgnoreApplicationStopFailures value is invalid. For Lambda deployments, false
is expected. For EC2/On-premises deployments, true
or false
is expected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The input was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidInputException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The input was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Example
try:
...
except client.exceptions.InvalidInstanceIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The on-premises instance name was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidInstanceNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The on-premises instance name was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified instance status does not exist.
Example
try:
...
except client.exceptions.InvalidInstanceStatusException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified instance status does not exist.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An invalid instance type was specified for instances in a blue/green deployment. Valid values include “Blue” for an original environment and “Green” for a replacement environment.
Example
try:
...
except client.exceptions.InvalidInstanceTypeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An invalid instance type was specified for instances in a blue/green deployment. Valid values include “Blue” for an original environment and “Green” for a replacement environment.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified key prefix filter was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidKeyPrefixFilterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified key prefix filter was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A lifecycle event hook is invalid. Review the hooks
section in your AppSpec file to ensure the lifecycle events and hooks
functions are valid.
Example
try:
...
except client.exceptions.InvalidLifecycleEventHookExecutionIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A lifecycle event hook is invalid. Review the hooks
section in your AppSpec file to ensure the lifecycle events and hooks
functions are valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded
or Failed
.
Example
try:
...
except client.exceptions.InvalidLifecycleEventHookExecutionStatusException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded
or Failed
.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An invalid load balancer name, or no load balancer name, was specified.
Example
try:
...
except client.exceptions.InvalidLoadBalancerInfoException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An invalid load balancer name, or no load balancer name, was specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The minimum healthy instance value was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidMinimumHealthyHostValueException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The minimum healthy instance value was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The next token was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidNextTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The next token was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
Example
try:
...
except client.exceptions.InvalidOnPremisesTagCombinationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An invalid operation was detected.
Example
try:
...
except client.exceptions.InvalidOperationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An invalid operation was detected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The registration status was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidRegistrationStatusException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The registration status was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The revision was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidRevisionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The revision was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
Example
try:
...
except client.exceptions.InvalidRoleException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The column name to sort by is either not present or was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidSortByException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The column name to sort by is either not present or was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The sort order was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidSortOrderException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The sort order was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The tag was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidTagException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The tag was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The tag filter was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidTagFilterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The tag filter was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified tags are not valid.
Example
try:
...
except client.exceptions.InvalidTagsToAddException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified tags are not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A target is not valid.
Example
try:
...
except client.exceptions.InvalidTargetException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A target is not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The target filter name is invalid.
Example
try:
...
except client.exceptions.InvalidTargetFilterNameException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The target filter name is invalid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A target group pair associated with this deployment is not valid.
Example
try:
...
except client.exceptions.InvalidTargetGroupPairException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A target group pair associated with this deployment is not valid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The target instance configuration is invalid. Possible causes include:
Configuration data for target instances was entered for an in-place deployment.
The limit of 10 tags for a tag type was exceeded.
The combined length of the tag names exceeded the limit.
A specified tag is not currently applied to any instances.
Example
try:
...
except client.exceptions.InvalidTargetInstancesException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The target instance configuration is invalid. Possible causes include:
Configuration data for target instances was entered for an in-place deployment.
The limit of 10 tags for a tag type was exceeded.
The combined length of the tag names exceeded the limit.
A specified tag is not currently applied to any instances.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified time range was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidTimeRangeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified time range was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The configuration that specifies how traffic is routed during a deployment is invalid.
Example
try:
...
except client.exceptions.InvalidTrafficRoutingConfigurationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The configuration that specifies how traffic is routed during a deployment is invalid.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The trigger was specified in an invalid format.
Example
try:
...
except client.exceptions.InvalidTriggerConfigException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The trigger was specified in an invalid format.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The UpdateOutdatedInstancesOnly value is invalid. For Lambda deployments, false
is expected. For EC2/On-premises deployments, true
or false
is expected.
Example
try:
...
except client.exceptions.InvalidUpdateOutdatedInstancesOnlyValueException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The UpdateOutdatedInstancesOnly value is invalid. For Lambda deployments, false
is expected. For EC2/On-premises deployments, true
or false
is expected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An attempt to return the status of an already completed lifecycle event occurred.
Example
try:
...
except client.exceptions.LifecycleEventAlreadyCompletedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An attempt to return the status of an already completed lifecycle event occurred.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The limit for lifecycle hooks was exceeded.
Example
try:
...
except client.exceptions.LifecycleHookLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The limit for lifecycle hooks was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.
Example
try:
...
except client.exceptions.MultipleIamArnsProvidedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The API used does not support the deployment.
Example
try:
...
except client.exceptions.OperationNotSupportedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The API used does not support the deployment.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The ARN of a resource is required, but was not found.
Example
try:
...
except client.exceptions.ResourceArnRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The ARN of a resource is required, but was not found.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified resource could not be validated.
Example
try:
...
except client.exceptions.ResourceValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The specified resource could not be validated.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The named revision does not exist with the IAM user or Amazon Web Services account.
Example
try:
...
except client.exceptions.RevisionDoesNotExistException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The named revision does not exist with the IAM user or Amazon Web Services account.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The revision ID was not specified.
Example
try:
...
except client.exceptions.RevisionRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The revision ID was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The role ID was not specified.
Example
try:
...
except client.exceptions.RoleRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The role ID was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The maximum allowed number of tags was exceeded.
Example
try:
...
except client.exceptions.TagLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum allowed number of tags was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A tag was not specified.
Example
try:
...
except client.exceptions.TagRequiredException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A tag was not specified.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
Example
try:
...
except client.exceptions.TagSetListLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
An API function was called too frequently.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
An API function was called too frequently.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The maximum allowed number of triggers was exceeded.
Example
try:
...
except client.exceptions.TriggerTargetsLimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The maximum allowed number of triggers was exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
A call was submitted that is not supported for the specified deployment type.
Example
try:
...
except client.exceptions.UnsupportedActionForDeploymentTypeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
A call was submitted that is not supported for the specified deployment type.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
paginator = client.get_paginator('list_application_revisions')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_application_revisions()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
applicationName='string',
sortBy='registerTime'|'firstUsedTime'|'lastUsedTime',
sortOrder='ascending'|'descending',
s3Bucket='string',
s3KeyPrefix='string',
deployed='include'|'exclude'|'ignore',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
sortBy (string) –
The column name to use to sort the list results:
registerTime
: Sort by the time the revisions were registered with CodeDeploy.
firstUsedTime
: Sort by the time the revisions were first used in a deployment.
lastUsedTime
: Sort by the time the revisions were last used in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
sortOrder (string) –
The order in which to sort the list results:
ascending
: ascending order.
descending
: descending order.
If not specified, the results are sorted in ascending order.
If set to null, the results are sorted in an arbitrary order.
s3Bucket (string) –
An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user’s buckets are searched.
s3KeyPrefix (string) – A key prefix for the set of Amazon S3 objects to limit the search for revisions.
deployed (string) –
Whether to list revisions based on whether the revision is the target revision of a deployment group:
include
: List revisions that are target revisions of a deployment group.
exclude
: Do not list revisions that are target revisions of a deployment group.
ignore
: List all revisions.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'revisions': [
{
'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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListApplicationRevisions
operation.
revisions (list) –
A list of locations that contain the matching revisions.
(dict) –
Information about the location of an application revision.
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.
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.
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_applications')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_applications()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'applications': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListApplications operation.
applications (list) –
A list of application names.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_deployment_configs')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployment_configs()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'deploymentConfigsList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentConfigs
operation.
deploymentConfigsList (list) –
A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime
.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_deployment_groups')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployment_groups()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
applicationName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
applicationName (string) –
[REQUIRED]
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'applicationName': 'string',
'deploymentGroups': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentGroups
operation.
applicationName (string) –
The application name.
deploymentGroups (list) –
A list of deployment group names.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_deployment_instances')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployment_instances()
.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
deploymentId='string',
instanceStatusFilter=[
'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
],
instanceTypeFilter=[
'Blue'|'Green',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment.
instanceStatusFilter (list) –
A subset of instances to list by status:
Pending
: Include those instances with pending deployments.
InProgress
: Include those instances where deployments are still in progress.
Succeeded
: Include those instances with successful deployments.
Failed
: Include those instances with failed deployments.
Skipped
: Include those instances with skipped deployments.
Unknown
: Include those instances with deployments in an unknown state.
(string) –
instanceTypeFilter (list) –
The set of instances in a blue/green deployment, either those in the original environment (“BLUE”) or those in the replacement environment (“GREEN”), for which you want to view instance information.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'instancesList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeploymentInstances
operation.
instancesList (list) –
A list of instance IDs.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_deployment_targets')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployment_targets()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
deploymentId='string',
targetFilters={
'string': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
deploymentId (string) – The unique ID of a deployment.
targetFilters (dict) –
A key used to filter the returned targets. The two valid values are:
TargetStatus
- A TargetStatus
filter string can be Failed
, InProgress
, Pending
, Ready
, Skipped
, Succeeded
, or Unknown
.
ServerInstanceLabel
- A ServerInstanceLabel
filter string can be Blue
or Green
.
(string) –
(list) –
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'targetIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
targetIds (list) –
The unique IDs of deployment targets.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_deployments')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployments()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
applicationName='string',
deploymentGroupName='string',
externalId='string',
includeOnlyStatuses=[
'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
],
createTimeRange={
'start': datetime(2015, 1, 1),
'end': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
applicationName (string) –
The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
Note
If applicationName
is specified, then deploymentGroupName
must be specified. If it is not specified, then deploymentGroupName
must not be specified.
deploymentGroupName (string) –
The name of a deployment group for the specified application.
Note
If deploymentGroupName
is specified, then applicationName
must be specified. If it is not specified, then applicationName
must not be specified.
externalId (string) – The unique ID of an external resource for returning deployments linked to the external resource.
includeOnlyStatuses (list) –
A subset of deployments to list by status:
Created
: Include created deployments in the resulting list.
Queued
: Include queued deployments in the resulting list.
In Progress
: Include in-progress deployments in the resulting list.
Succeeded
: Include successful deployments in the resulting list.
Failed
: Include failed deployments in the resulting list.
Stopped
: Include stopped deployments in the resulting list.
(string) –
createTimeRange (dict) –
A time range (start and end) for returning a subset of the list of deployments.
start (datetime) –
The start time of the time range.
Note
Specify null to leave the start time open-ended.
end (datetime) –
The end time of the time range.
Note
Specify null to leave the end time open-ended.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'deployments': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListDeployments
operation.
deployments (list) –
A list of deployment IDs.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_git_hub_account_token_names')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_git_hub_account_token_names()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'tokenNameList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of a ListGitHubAccountTokenNames
operation.
tokenNameList (list) –
A list of names of connections to GitHub accounts.
(string) –
NextToken (string) –
A token to resume pagination.
paginator = client.get_paginator('list_on_premises_instances')
Creates an iterator that will paginate through responses from CodeDeploy.Client.list_on_premises_instances()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registrationStatus='Registered'|'Deregistered',
tagFilters=[
{
'Key': 'string',
'Value': 'string',
'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
},
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
registrationStatus (string) –
The registration status of the on-premises instances:
Deregistered
: Include deregistered on-premises instances in the resulting list.
Registered
: Include registered on-premises instances in the resulting list.
tagFilters (list) –
The on-premises instance tags that are used to restrict the on-premises instance names returned.
(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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'instanceNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) –
Represents the output of the list on-premises instances operation.
instanceNames (list) –
The list of matching on-premises instance names.
(string) –
NextToken (string) –
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('deployment_successful')
Polls CodeDeploy.Client.get_deployment()
every 15 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
deploymentId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
deploymentId (string) –
[REQUIRED]
The unique ID of a deployment associated with the IAM user or Amazon Web Services account.
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
Delay (integer) –
The amount of time in seconds to wait between attempts. Default: 15
MaxAttempts (integer) –
The maximum number of attempts to be made. Default: 120
None