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.

The names of the on-premises instances to which to add tags.

The name of an CodeDeploy application about which to get revision information.

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.

The name of the application that corresponds to the revisions.

Information about errors that might have occurred during the API call.

Additional information about the revisions, including the type and location.

The response's http status code.

A list of application names separated by spaces. The maximum number of application names you can specify is 100.

Information about the applications.

The response's http status code.

The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.

The names of the deployment groups.

Information about the deployment groups.

Information about errors that might have occurred during the API call.

The response's http status code.

The unique ID of a deployment.

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.

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.

The response's http status code.

A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.

Information about the deployments.

The response's http status code.

The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

Information about the on-premises instances.

The response's http status code.

The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.

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.

The destination platform type for the deployment (Lambda, Server, or ECS).

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.

The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.

A unique application ID.

The response's http status code.

Configuration information for an automatic rollback that is added when a deployment is created.

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.

The name of the deployment group.

A comment about the deployment.

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.

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.

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.

If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

The type and location of the revision to deploy.

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

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The unique ID of a deployment.

The response's http status code.

The destination platform type for the deployment (Lambda, Server, or ECS).

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.

The configuration that specifies how the deployment traffic is routed.

The name of the deployment configuration to create.

A unique deployment configuration ID.

The response's http status code.

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Configuration information for an automatic rollback that is added when a deployment group is created.

A list of associated Amazon EC2 Auto Scaling groups.

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

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.

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.

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.

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.

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>.

Information about the load balancer used in a deployment.

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.

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.

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.

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.

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.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The name of a new deployment group for the specified application.

A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

A unique deployment group ID.

The response's http status code.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The name of a deployment configuration associated with the IAM user or Amazon Web Services account.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The name of a deployment group for the specified application.

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.

The response's http status code.

The name of the GitHub account connection to delete.

The name of the GitHub account connection that was deleted.

The response's http status code.

The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.

The response's http status code.

The name of the on-premises instance to deregister.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Information about the application.

The response's http status code.

The name of the application that corresponds to the revision.

Information about the application revision to get, including type and location.

The name of the application that corresponds to the revision.

Additional information about the revision, including type and location.

General information about the revision.

The response's http status code.

The unique ID of a deployment associated with the IAM user or Amazon Web Services account.

Information about the deployment.

The response's http status code.

The name of a deployment configuration associated with the IAM user or Amazon Web Services account.

Information about the deployment configuration.

The response's http status code.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The name of a deployment group for the specified application.

Information about the deployment group.

The response's http status code.

The unique ID of a deployment.

The unique ID of a deployment target.

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).

The response's http status code.

The name of the on-premises instance about which to get information.

Information about the on-premises instance.

The response's http status code.

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.

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

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.

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.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

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.

A list of locations that contain the matching revisions.

The response's http status code.

An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.

A list of application names.

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.

The response's http status code.

An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.

A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.

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.

The response's http status code.

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.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

The application name.

A list of deployment group names.

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.

The response's http status code.

The unique ID of a deployment.

A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

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.

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.

The unique IDs of deployment targets.

The response's http status code.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

A time range (start and end) for returning a subset of the list of deployments.

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

The unique ID of an external resource for returning deployments linked to the external resource.

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.

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

A list of deployment IDs.

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.

The response's http status code.

An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.

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.

A list of names of connections to GitHub accounts.

The response's http status code.

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.

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.

The on-premises instance tags that are used to restrict the on-premises instance names returned.

The list of matching on-premises instance names.

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.

The response's http status code.

An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.

The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.

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.

A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter.

The response's http status code.

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

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.

The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.

The response's http status code.

A comment about the revision.

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.

Information about the application revision to register, including type and location.

The ARN of the IAM session to associate with the on-premises instance.

The ARN of the IAM user to associate with the on-premises instance.

The name of the on-premises instance to register.

The tag key-value pairs to remove from the on-premises instances.

The names of the on-premises instances from which to remove tags.

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

The unique ID of a deployment.

The status of the stop deployment operation:

• Pending: The stop operation is pending.
• Succeeded: The stop operation was successful.

An accompanying status message.

The response's http status code.

The ARN of a resource, such as a CodeDeploy application or deployment group.

A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.

The response's http status code.

The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter.

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.

The response's http status code.

The current name of the application you want to change.

The new name to give the application.

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

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.

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

The replacement deployment configuration name to use, if you want to change it.

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.

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.

Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

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>.

Information about the load balancer used in a deployment.

The new name of the deployment group, if you want to change it.

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.

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

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.

A replacement ARN for the service role, if you want to change it.

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.

The application name that corresponds to the deployment group to update.

The current name of the deployment group.

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.

The response's http status code.

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.

Indicates whether the alarm configuration is enabled.

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.

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.

The SHA256 hash value of the revision content.

The application ID.

The application name.

The destination platform type for deployment of the application (Lambda or Server).

The time at which the application was created.

The name for a connection to a GitHub account.

True if the user has authenticated with GitHub for the specified application. Otherwise, false.

Indicates whether a defined automatic rollback configuration is currently enabled.

The event type or types that trigger a rollback.

An Auto Scaling lifecycle event hook name.

The Auto Scaling group name.

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

Information about whether to terminate instances in the original fleet during a blue/green deployment.

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.

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).

The unique ID of an CloudFormation blue/green deployment.

The date and time when the target application was updated by an CloudFormation blue/green deployment.

The lifecycle events of the CloudFormation blue/green deployment to this target application.

The resource type for the CloudFormation blue/green deployment.

The status of an CloudFormation blue/green deployment's target application.

The unique ID of a deployment target that has a type of CloudFormationTarget.

The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.

The destination platform type for the deployment (Lambda, Server, or ECS).

The time at which the deployment configuration was created.

The deployment configuration ID.

The deployment configuration name.

Information about the number or percentage of minimum healthy instance.

The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.

A list of alarms associated with the deployment group.

The application name.

Information about the automatic rollback configuration associated with the deployment group.

A list of associated Auto Scaling groups.

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

The destination platform type for the deployment (Lambda, Server, or ECS).

The deployment configuration name.

The deployment group ID.

The deployment group name.

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.

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

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.

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>.

Information about the most recent attempted deployment to the deployment group.

Information about the most recent successful deployment to the deployment group.

Information about the load balancer to use in a deployment.

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

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.

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.

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.

Information about the deployment group's target revision, including type and location.

Information about triggers associated with the deployment group.

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

The application name.

Information about the automatic rollback configuration associated with the deployment.

Information about blue/green deployment options for this deployment.

A timestamp that indicates when the deployment was complete.

The destination platform type for the deployment (Lambda, Server, or ECS).

A timestamp that indicates when the deployment was created.

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.

The deployment configuration name.

The deployment group name.

The unique ID of a deployment.

A summary of the deployment status of the instances in the deployment.

Messages that contain information about the status of a deployment.

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.

A comment about the deployment.

Information about any error associated with this deployment.

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

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.

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.

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.

Information about the load balancer used in the deployment.

Undocumented member.

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

Undocumented member.

Information about the location of stored application artifacts and the service from which to retrieve them.

Information about a deployment rollback.

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.

The current state of the deployment as a whole.

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

Indicates whether only instances that are not running the latest application revision are to be deployed to.

The number of instances in the deployment in a failed state.

The number of instances in which the deployment is in progress.

The number of instances in the deployment in a pending state.

The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.

The number of instances in the deployment in a skipped state.

The number of instances in the deployment to which revisions have been successfully deployed.

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.

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.

Indicates whether to route deployment traffic behind a load balancer.

Indicates whether to run an in-place deployment or a blue/green deployment.

Undocumented member.

The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.

Information about the target for a deployment that uses the Amazon ECS compute platform.

Information about the target for a deployment that uses the EC2/On-premises compute platform.

Information about the target for a deployment that uses the Lambda compute platform.

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.

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

The message associated with the error.

The name of the script.

The tag filter key.

The tag filter type:

• KEY_ONLY: Key only.
• VALUE_ONLY: Value only.
• KEY_AND_VALUE: Key and value.

The tag filter value.

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.

The name of the cluster that the Amazon ECS service is associated with.

The name of the target Amazon ECS service.

The unique ID of a deployment.

The date and time when the target Amazon ECS application was updated by a deployment.

The lifecycle events of the deployment to this target Amazon ECS application.

The status an Amazon ECS deployment's target ECS application.

The Amazon Resource Name (ARN) of the target.

The unique ID of a deployment target that has a type of ecsTarget.

The ECSTaskSet objects associated with the ECS target.

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.

A unique ID of an ECSTaskSet.

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.

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.

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.

The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

The percentage of traffic served by this task set.

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.

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.

An accompanying error message.

The deployment groups for which this is the current target revision.

A comment about the revision.

When the revision was first used by CodeDeploy.

When the revision was last used by CodeDeploy.

When the revision was registered with CodeDeploy.

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

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.

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.

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

The ARN of the IAM session associated with the on-premises instance.

The IAM user ARN associated with the on-premises instance.

The ARN of the on-premises instance.

The name of the on-premises instance.

The time at which the on-premises instance was registered.

The tags currently associated with the on-premises instance.

The unique ID of a deployment.

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

The date and time when the target instance was updated by a deployment.

The lifecycle events of the deployment to this target instance.

The status an EC2/On-premises deployment's target instance.

The Amazon Resource Name (ARN) of the target.

The unique ID of a deployment target that has a type of instanceTarget.

The version of a Lambda function that production traffic points to.

The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.

The name of a Lambda function.

The version of a Lambda function that production traffic points to after the Lambda function is deployed.

The percentage of production traffic that the target version of a Lambda function receives.

The unique ID of a deployment.

A LambdaFunctionInfo object that describes a target Lambda function.

The date and time when the target Lambda function was updated by a deployment.

The lifecycle events of the deployment to this target Lambda function.

The status an Lambda deployment's target Lambda function.

The Amazon Resource Name (ARN) of the target.

The unique ID of a deployment target that has a type of lambdaTarget.

A timestamp that indicates when the most recent deployment to the deployment group started.

The unique ID of a deployment.

A timestamp that indicates when the most recent deployment to the deployment group was complete.

The status of the most recent deployment.

Diagnostic information about the deployment lifecycle event.

A timestamp that indicates when the deployment lifecycle event ended.

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

A timestamp that indicates when the deployment lifecycle event started.

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.

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.

Adding more than one load balancer to the array is not supported.

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.

Adding more than one target group to the array is not supported.

The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

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.

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.

The minimum healthy instance value.

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.

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.

The SHA256 hash value of the revision content.

The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.

The deployment ID of the root deployment that triggered this deployment.

Information about an application revision, including usage details and associated deployment groups.

Information about the location and type of an application revision.

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.

Information about the location of application artifacts stored in GitHub.

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.

Information about the location of a revision stored in Amazon S3.

Information about the location of an Lambda deployment revision stored as a RawString.

The ID of the deployment rollback.

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).

The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.

The name of the Amazon S3 bucket where the application revision is stored.

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.

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.

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

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.

The tag's key.

The tag's value.

The on-premises instance tag filter key.

The on-premises instance tag filter type:

• KEY_ONLY: Key only.
• VALUE_ONLY: Value only.
• KEY_AND_VALUE: Key and value.

The on-premises instance tag filter value.

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.

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

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.

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.

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

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.

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.

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

The end time of the time range.

Specify null to leave the end time open-ended.

The start time of the time range.

Specify null to leave the start time open-ended.

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.

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.

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.

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

The event type or types for which notifications are triggered.