Smaws_Client_CodeDeploy.Typestype nonrec wait_time_in_seconds = Smaws_Lib.CoreTypes.Int64.ttype nonrec minimum_healthy_hosts_per_zone = {value : minimum_healthy_hosts_per_zone_value option;The value associated with the MinimumHealthyHostsPerZone option.
type_ : minimum_healthy_hosts_per_zone_type option;The type associated with the MinimumHealthyHostsPerZone option.
}Information about the minimum number of healthy instances per Availability Zone.
type nonrec zonal_config = {minimum_healthy_hosts_per_zone : minimum_healthy_hosts_per_zone option;The number or percentage of instances that must remain available per Availability Zone during a deployment. This option works in conjunction with the MinimumHealthyHosts option. For more information, see About the minimum number of healthy hosts per Availability Zone in the CodeDeploy User Guide.
If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 percent.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
*)monitor_duration_in_seconds : wait_time_in_seconds option;The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a monitorDurationInSeconds, CodeDeploy starts deploying to the next Availability Zone immediately.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
*)first_zone_monitor_duration_in_seconds : wait_time_in_seconds option;The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds, then CodeDeploy uses the monitorDurationInSeconds value for the first Availability Zone.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
*)}Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region. By deploying to one Availability Zone at a time, you can expose your deployment to a progressively larger audience as confidence in the deployment's performance and viability grows. If you don't configure the ZonalConfig object, CodeDeploy deploys your application to a random selection of hosts across a Region.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
type nonrec auto_scaling_group = {termination_hook : auto_scaling_group_hook option;The name of the termination hook that CodeDeploy installed into the Auto Scaling group.
For more information about the termination hook, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.
*)hook : auto_scaling_group_hook option;The name of the launch hook that CodeDeploy installed into the Auto Scaling group.
For more information about the launch hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.
*)name : auto_scaling_group_name option;The Auto Scaling group name.
*)}Information about an Auto Scaling group.
type nonrec auto_scaling_group_list = auto_scaling_group listtype nonrec update_deployment_group_output = {hooks_not_cleaned_up : auto_scaling_group_list option;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.
*)}Represents the output of an UpdateDeploymentGroup operation.
type nonrec ec2_tag_filter = {type_ : ec2_tag_filter_type option;The tag filter type:
KEY_ONLY: Key only.VALUE_ONLY: Value only.KEY_AND_VALUE: Key and value.value : value option;The tag filter value.
*)key : key option;The tag filter key.
*)}Information about an EC2 tag filter.
type nonrec ec2_tag_filter_list = ec2_tag_filter listtype nonrec tag_filter = {type_ : tag_filter_type option;The on-premises instance tag filter type:
value : value option;The on-premises instance tag filter value.
*)key : key option;The on-premises instance tag filter key.
*)}Information about an on-premises instance tag filter.
type nonrec tag_filter_list = tag_filter listtype nonrec auto_scaling_group_name_list = auto_scaling_group_name listtype nonrec trigger_event_type_list = trigger_event_type listtype nonrec trigger_config = {trigger_events : trigger_event_type_list option;The event type or types for which notifications are triggered.
*)trigger_target_arn : trigger_target_arn option;The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
*)trigger_name : trigger_name option;The name of the notification trigger.
*)}Information about notification triggers for the deployment group.
type nonrec trigger_config_list = trigger_config listtype nonrec alarm = {name : alarm_name option;The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
*)}Information about an alarm.
type nonrec alarm_list = alarm listtype nonrec alarm_configuration = {alarms : alarm_list option;A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*)ignore_poll_alarm_failure : boolean_ option;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.enabled : boolean_ option;Indicates whether the alarm configuration is enabled.
*)}Information about alarms associated with a deployment or deployment group.
type nonrec auto_rollback_events_list = auto_rollback_event listtype nonrec auto_rollback_configuration = {events : auto_rollback_events_list option;The event type or types that trigger a rollback.
*)enabled : boolean_ option;Indicates whether a defined automatic rollback configuration is currently enabled.
*)}Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.
type nonrec deployment_style = {deployment_option : deployment_option option;Indicates whether to route deployment traffic behind a load balancer.
*)deployment_type : deployment_type option;Indicates whether to run an in-place deployment or a blue/green 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.
type nonrec blue_instance_termination_option = {termination_wait_time_in_minutes : duration option;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).
*)action : instance_action option;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.}Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does not apply to Lambda deployments.
type nonrec deployment_ready_option = {wait_time_in_minutes : duration option;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.
action_on_timeout : deployment_ready_action option;Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.}Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
type nonrec green_fleet_provisioning_option = {action : green_fleet_provisioning_action option;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.}Information about the instances that belong to the replacement environment in a blue/green deployment.
type nonrec blue_green_deployment_configuration = {green_fleet_provisioning_option : green_fleet_provisioning_option option;Information about how instances are provisioned for a replacement environment in a blue/green deployment.
*)deployment_ready_option : deployment_ready_option option;Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
*)terminate_blue_instances_on_deployment_success : blue_instance_termination_option
option;Information about whether to terminate instances in the original fleet during a blue/green deployment.
*)}Information about blue/green deployment options for a deployment group.
type nonrec elb_info = {name : elb_name option;For blue/green deployments, the name of the Classic Load Balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the Classic Load Balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
*)}Information about a Classic Load Balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
type nonrec elb_info_list = elb_info listtype nonrec target_group_info = {name : target_group_name option;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.
*)}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.
type nonrec target_group_info_list = target_group_info listtype nonrec listener_arn_list = listener_arn listtype nonrec traffic_route = {listener_arns : listener_arn_list option;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.
*)}Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group.
type nonrec target_group_pair_info = {test_traffic_route : traffic_route option;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.
*)prod_traffic_route : traffic_route option;The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
*)target_groups : target_group_info_list option;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.
*)}Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
type nonrec target_group_pair_info_list = target_group_pair_info listtype nonrec load_balancer_info = {target_group_pair_info_list : target_group_pair_info_list option;The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
target_group_info_list : target_group_info_list option;An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.
You can add up to 10 target groups to the array.
If you're using Classic Load Balancers, use the elbInfoList array instead of this one.
elb_info_list : elb_info_list option;An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.
You can add up to 10 load balancers to the array.
If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
}Information about the Elastic Load Balancing load balancer or target group used in a deployment.
You can use load balancers and target groups in combination. For example, if you have two Classic Load Balancers, and five target groups tied to an Application Load Balancer, you can specify the two Classic Load Balancers in elbInfoList, and the five target groups in targetGroupInfoList.
type nonrec ec2_tag_set_list = ec2_tag_filter_list listtype nonrec ec2_tag_set = {ec2_tag_set_list : ec2_tag_set_list option;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.
*)}Information about groups of Amazon EC2 instance tags.
type nonrec ecs_service = {cluster_name : ecs_cluster_name option;The name of the cluster that the Amazon ECS service is associated with.
*)service_name : ecs_service_name option;The name of the target Amazon ECS service.
*)}Contains the service and cluster names used to identify an Amazon ECS deployment's target.
type nonrec ecs_service_list = ecs_service listtype nonrec on_premises_tag_set_list = tag_filter_list listtype nonrec on_premises_tag_set = {on_premises_tag_set_list : on_premises_tag_set_list option;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.
*)}Information about groups of on-premises instance tags.
type nonrec update_deployment_group_input = {termination_hook_enabled : nullable_boolean option;This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.
Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.
For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.
*)on_premises_tag_set : on_premises_tag_set option;Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
*)ecs_services : ecs_service_list option;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
:.
*)ec2_tag_set : ec2_tag_set option;Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
*)load_balancer_info : load_balancer_info option;Information about the load balancer used in a deployment.
*)blue_green_deployment_configuration : blue_green_deployment_configuration
option;Information about blue/green deployment options for a deployment group.
*)deployment_style : deployment_style option;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.
*)outdated_instances_strategy : outdated_instances_strategy option;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.
auto_rollback_configuration : auto_rollback_configuration option;Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
*)alarm_configuration : alarm_configuration option;Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
*)trigger_configurations : trigger_config_list option;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.
*)service_role_arn : role option;A replacement ARN for the service role, if you want to change it.
*)auto_scaling_groups : auto_scaling_group_name_list option;The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
on_premises_instance_tag_filters : tag_filter_list option;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.
*)ec2_tag_filters : ec2_tag_filter_list option;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.
*)deployment_config_name : deployment_config_name option;The replacement deployment configuration name to use, if you want to change it.
*)new_deployment_group_name : deployment_group_name option;The new name of the deployment group, if you want to change it.
*)current_deployment_group_name : deployment_group_name;The current name of the deployment group.
*)application_name : application_name;The application name that corresponds to the deployment group to update.
*)}Represents the input of an UpdateDeploymentGroup operation.
type nonrec trigger_targets_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The maximum allowed number of triggers was exceeded.
type nonrec throttling_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An API function was called too frequently.
type nonrec tag_set_list_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
type nonrec lifecycle_hook_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The limit for lifecycle hooks was exceeded.
type nonrec invalid_trigger_config_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The trigger was specified in an invalid format.
type nonrec invalid_traffic_routing_configuration_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The configuration that specifies how traffic is routed during a deployment is invalid.
type nonrec invalid_target_group_pair_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A target group pair associated with this deployment is not valid.
type nonrec invalid_tag_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The tag was specified in an invalid format.
type nonrec invalid_role_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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.
type nonrec invalid_on_premises_tag_combination_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
type nonrec invalid_load_balancer_info_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An invalid load balancer name, or no load balancer name, was specified.
type nonrec invalid_input_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The input was specified in an invalid format.
type nonrec invalid_ecs_service_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The Amazon ECS service identifier is not valid.
type nonrec invalid_ec2_tag_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The tag was specified in an invalid format.
type nonrec invalid_ec2_tag_combination_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
type nonrec invalid_deployment_style_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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."
type nonrec invalid_deployment_group_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment group name was specified in an invalid format.
type nonrec invalid_deployment_config_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment configuration name was specified in an invalid format.
type nonrec invalid_blue_green_deployment_configuration_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
type nonrec invalid_auto_scaling_group_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The Auto Scaling group was specified in an invalid format or does not exist.
type nonrec invalid_auto_rollback_config_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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.
type nonrec invalid_application_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The application name was specified in an invalid format.
type nonrec invalid_alarm_config_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The format of the alarm configuration is invalid. Possible causes include:
type nonrec ecs_service_mapping_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
type nonrec deployment_group_name_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment group name was not specified.
type nonrec deployment_group_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The named deployment group with the user or Amazon Web Services account does not exist.
type nonrec deployment_group_already_exists_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A deployment group with the specified name with the user or Amazon Web Services account already exists.
type nonrec deployment_config_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment configuration does not exist with the user or Amazon Web Services account.
type nonrec application_name_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The minimum number of required application names was not specified.
type nonrec application_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The application does not exist with the user or Amazon Web Services account.
type nonrec alarms_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The maximum number of alarms for a deployment group (10) was exceeded.
type nonrec update_application_input = {new_application_name : application_name option;The new name to give the application.
*)application_name : application_name option;The current name of the application you want to change.
*)}Represents the input of an UpdateApplication operation.
type nonrec application_already_exists_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An application with the specified name with the user or Amazon Web Services account already exists.
type nonrec tag_key_list = key listtype nonrec untag_resource_input = {tag_keys : tag_key_list;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.
resource_arn : arn;The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the TagKeys input parameter.
}type nonrec tag_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A tag was not specified.
type nonrec resource_arn_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The ARN of a resource is required, but was not found.
type nonrec invalid_arn_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified ARN is not in a valid format.
type nonrec arn_not_supported_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
type nonrec unsupported_action_for_deployment_type_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A call was submitted that is not supported for the specified deployment type.
type nonrec time_based_canary = {canary_interval : wait_time_in_mins option;The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
canary_percentage : percentage option;The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
}A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
type nonrec time_based_linear = {linear_interval : wait_time_in_mins option;The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
linear_percentage : percentage option;The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
}A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
type nonrec traffic_routing_config = {time_based_linear : time_based_linear option;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.
*)time_based_canary : time_based_canary option;A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.
*)type_ : traffic_routing_type option;The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.
}The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
type nonrec time_range = {end_ : timestamp option;The end time of the time range.
Specify null to leave the end time open-ended.
*)start : timestamp option;The start time of the time range.
Specify null to leave the start time open-ended.
*)}Information about a time range.
type nonrec target_instances = {ec2_tag_set : ec2_tag_set option;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.
auto_scaling_groups : auto_scaling_group_name_list option;The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
*)tag_filters : ec2_tag_filter_list option;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.
}Information about the instances to be used in the replacement environment in a blue/green deployment.
type nonrec target_id_list = target_id listtype nonrec filter_value_list = filter_value listtype nonrec target_filters = (target_filter_name * filter_value_list) listInformation about a tag.
type nonrec tag_list = tag listtype nonrec tag_resource_input = {resource_arn : arn;The ARN of a resource, such as a CodeDeploy application or deployment group.
*)}type nonrec tag_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The maximum allowed number of tags was exceeded.
type nonrec stop_deployment_output = {status_message : message option;An accompanying status message.
*)status : stop_status option;The status of the stop deployment operation:
}Represents the output of a StopDeployment operation.
type nonrec stop_deployment_input = {auto_rollback_enabled : nullable_boolean option;Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
*)deployment_id : deployment_id;The unique ID of a deployment.
*)}Represents the input of a StopDeployment operation.
type nonrec invalid_deployment_id_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}At least one of the deployment IDs was specified in an invalid format.
type nonrec deployment_id_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}At least one deployment ID must be specified.
type nonrec deployment_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment with the user or Amazon Web Services account does not exist.
type nonrec deployment_already_completed_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment is already complete.
type nonrec skip_wait_time_for_instance_termination_input = {deployment_id : deployment_id option;The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
*)}type nonrec deployment_not_started_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified deployment has not started.
type nonrec s3_location = {e_tag : e_tag option;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.
*)version : version_id option;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.
*)bundle_type : bundle_type option;The file type of the application revision. Must be one of the following:
tar: A tar archive file.tgz: A compressed tar archive file.zip: A zip archive file.YAML: A YAML-formatted file.JSON: A JSON-formatted file.key : s3_key option;The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
*)bucket : s3_bucket option;The name of the Amazon S3 bucket where the application revision is stored.
*)}Information about the location of application artifacts stored in Amazon S3.
type nonrec rollback_info = {rollback_message : description option;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).
*)rollback_triggering_deployment_id : deployment_id option;The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.
*)rollback_deployment_id : deployment_id option;The ID of the deployment rollback.
*)}Information about a deployment rollback.
type nonrec role_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The role ID was not specified.
type nonrec revision_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The revision ID was not specified.
type nonrec git_hub_location = {commit_id : commit_id option;The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
*)repository : repository option;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.
*)}Information about the location of application artifacts stored in GitHub.
type nonrec raw_string = {sha256 : raw_string_sha256 option;The SHA256 hash value of the revision content.
*)content : raw_string_content option;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.
*)}A revision for an Lambda deployment that is a YAML-formatted or JSON-formatted string. For Lambda deployments, the revision is the same as the AppSpec file.
type nonrec app_spec_content = {sha256 : raw_string_sha256 option;The SHA256 hash value of the revision content.
*)content : raw_string_content option;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.
}A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated RawString data type.
type nonrec revision_location = {app_spec_content : app_spec_content option;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.
*)string_ : raw_string option;Information about the location of an Lambda deployment revision stored as a RawString.
*)git_hub_location : git_hub_location option;Information about the location of application artifacts stored in GitHub.
*)s3_location : s3_location option;Information about the location of a revision stored in Amazon S3.
*)revision_type : revision_location_type option;The type of application revision:
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 an application revision.
type nonrec revision_location_list = revision_location listtype nonrec deployment_groups_list = deployment_group_name listtype nonrec generic_revision_info = {register_time : timestamp option;When the revision was registered with CodeDeploy.
*)last_used_time : timestamp option;When the revision was last used by CodeDeploy.
*)first_used_time : timestamp option;When the revision was first used by CodeDeploy.
*)deployment_groups : deployment_groups_list option;The deployment groups for which this is the current target revision.
*)description : description option;A comment about the revision.
*)}Information about an application revision.
type nonrec revision_info = {generic_revision_info : generic_revision_info option;Information about an application revision, including usage details and associated deployment groups.
*)revision_location : revision_location option;Information about the location and type of an application revision.
*)}Information about an application revision.
type nonrec revision_info_list = revision_info listtype nonrec revision_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The named revision does not exist with the user or Amazon Web Services account.
type nonrec resource_validation_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified resource could not be validated.
type nonrec instance_name_list = instance_name listRepresents the input of a RemoveTagsFromOnPremisesInstances operation.
type nonrec invalid_instance_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The on-premises instance name was specified in an invalid format.
type nonrec instance_not_registered_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified on-premises instance is not registered.
type nonrec instance_name_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An on-premises instance name was not specified.
type nonrec instance_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The maximum number of allowed on-premises instances in a single call was exceeded.
type nonrec deployments_list = deployment_id listInformation about deployments related to the specified deployment.
type nonrec register_on_premises_instance_input = {iam_user_arn : iam_user_arn option;The ARN of the user to associate with the on-premises instance.
*)iam_session_arn : iam_session_arn option;The ARN of the IAM session to associate with the on-premises instance.
*)instance_name : instance_name;The name of the on-premises instance to register.
*)}Represents the input of the register on-premises instance operation.
type nonrec multiple_iam_arns_provided_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}Both an user ARN and an IAM session ARN were included in the request. Use only one ARN type.
type nonrec invalid_iam_user_arn_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The user ARN was specified in an invalid format.
type nonrec invalid_iam_session_arn_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The IAM session ARN was specified in an invalid format.
type nonrec instance_name_already_registered_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified on-premises instance name is already registered.
type nonrec iam_user_arn_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An user ARN was not specified.
type nonrec iam_user_arn_already_registered_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified user ARN is already registered with an on-premises instance.
type nonrec iam_session_arn_already_registered_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The request included an IAM session ARN that has already been used to register a different instance.
type nonrec iam_arn_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.
type nonrec register_application_revision_input = {revision : revision_location;Information about the application revision to register, including type and location.
*)description : description option;A comment about the revision.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a RegisterApplicationRevision operation.
type nonrec invalid_revision_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The revision was specified in an invalid format.
type nonrec description_too_long_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The description is too long.
type nonrec put_lifecycle_event_hook_execution_status_output = {lifecycle_event_hook_execution_id : lifecycle_event_hook_execution_id option;The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.
}type nonrec put_lifecycle_event_hook_execution_status_input = {status : lifecycle_event_status option;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.
lifecycle_event_hook_execution_id : lifecycle_event_hook_execution_id option;The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.
deployment_id : deployment_id option;The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
*)}type nonrec lifecycle_event_already_completed_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An attempt to return the status of an already completed lifecycle event occurred.
type nonrec invalid_lifecycle_event_hook_execution_status_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded or Failed.
type nonrec invalid_lifecycle_event_hook_execution_id_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A lifecycle event hook is invalid. Review the hooks section in your AppSpec file to ensure the lifecycle events and hooks functions are valid.
type nonrec operation_not_supported_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The API used does not support the deployment.
type nonrec minimum_healthy_hosts = {value : minimum_healthy_hosts_value option;The minimum healthy instance value.
*)type_ : minimum_healthy_hosts_type option;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.
*)}Information about the minimum number of healthy instances.
type nonrec list_on_premises_instances_output = {next_token : next_token option;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.
*)instance_names : instance_name_list option;The list of matching on-premises instance names.
*)}Represents the output of the list on-premises instances operation.
type nonrec list_on_premises_instances_input = {next_token : next_token option;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.
*)tag_filters : tag_filter_list option;The on-premises instance tags that are used to restrict the on-premises instance names returned.
*)registration_status : registration_status option;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.}Represents the input of a ListOnPremisesInstances operation.
type nonrec invalid_tag_filter_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The tag filter was specified in an invalid format.
type nonrec invalid_registration_status_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The registration status was specified in an invalid format.
type nonrec invalid_next_token_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The next token was specified in an invalid format.
type nonrec git_hub_account_token_name_list = git_hub_account_token_name listtype nonrec list_git_hub_account_token_names_output = {next_token : next_token option;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.
token_name_list : git_hub_account_token_name_list option;A list of names of connections to GitHub accounts.
*)}Represents the output of a ListGitHubAccountTokenNames operation.
type nonrec list_git_hub_account_token_names_input = {next_token : next_token option;An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.
}Represents the input of a ListGitHubAccountTokenNames operation.
type nonrec list_deployments_output = {next_token : next_token option;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.
*)deployments : deployments_list option;A list of deployment IDs.
*)}Represents the output of a ListDeployments operation.
type nonrec deployment_status_list = deployment_status listtype nonrec list_deployments_input = {next_token : next_token option;An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
*)create_time_range : time_range option;A time range (start and end) for returning a subset of the list of deployments.
*)include_only_statuses : deployment_status_list option;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.external_id : external_id option;The unique ID of an external resource for returning deployments linked to the external resource.
*)deployment_group_name : deployment_group_name option;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.
application_name : application_name option;The name of an CodeDeploy application associated with the 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.
}Represents the input of a ListDeployments operation.
type nonrec invalid_time_range_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified time range was specified in an invalid format.
type nonrec invalid_external_id_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The external ID was specified in an invalid format.
type nonrec invalid_deployment_status_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified deployment status doesn't exist or cannot be determined.
type nonrec list_deployment_targets_output = {next_token : next_token option;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.
target_ids : target_id_list option;The unique IDs of deployment targets.
*)}type nonrec list_deployment_targets_input = {target_filters : target_filters option;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.next_token : next_token option;A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.
deployment_id : deployment_id;The unique ID of a deployment.
*)}type nonrec invalid_target_filter_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The target filter name is invalid.
type nonrec invalid_instance_type_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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.
type nonrec invalid_instance_status_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified instance status does not exist.
type nonrec invalid_deployment_instance_type_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
type nonrec instances_list = instance_id listtype nonrec list_deployment_instances_output = {next_token : next_token option;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.
*)instances_list : instances_list option;A list of instance IDs.
*)}Represents the output of a ListDeploymentInstances operation.
type nonrec instance_status_list = instance_status listtype nonrec instance_type_list = instance_type listtype nonrec list_deployment_instances_input = {instance_type_filter : instance_type_list option;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.
*)instance_status_filter : instance_status_list option;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.next_token : next_token option;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.
*)deployment_id : deployment_id;The unique ID of a deployment.
*)}Represents the input of a ListDeploymentInstances operation.
type nonrec invalid_compute_platform_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.
type nonrec list_deployment_groups_output = {next_token : next_token option;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.
*)deployment_groups : deployment_groups_list option;A list of deployment group names.
*)application_name : application_name option;The application name.
*)}Represents the output of a ListDeploymentGroups operation.
type nonrec list_deployment_groups_input = {next_token : next_token option;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.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a ListDeploymentGroups operation.
type nonrec deployment_configs_list = deployment_config_name listtype nonrec list_deployment_configs_output = {next_token : next_token option;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.
*)deployment_configs_list : deployment_configs_list option;A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.
}Represents the output of a ListDeploymentConfigs operation.
type nonrec list_deployment_configs_input = {next_token : next_token option;An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.
}Represents the input of a ListDeploymentConfigs operation.
type nonrec applications_list = application_name listtype nonrec list_applications_output = {next_token : next_token option;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.
*)applications : applications_list option;A list of application names.
*)}Represents the output of a ListApplications operation.
type nonrec list_applications_input = {next_token : next_token option;An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
*)}Represents the input of a ListApplications operation.
type nonrec list_application_revisions_output = {next_token : next_token option;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.
*)revisions : revision_location_list option;A list of locations that contain the matching revisions.
*)}Represents the output of a ListApplicationRevisions operation.
type nonrec list_application_revisions_input = {next_token : next_token option;An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.
deployed : list_state_filter_action option;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.s3_key_prefix : s3_key option;A key prefix for the set of Amazon S3 objects to limit the search for revisions.
*)s3_bucket : s3_bucket option;An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user's buckets are searched.
*)sort_order : sort_order option;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.
*)sort_by : application_revision_sort_by option;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.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a ListApplicationRevisions operation.
type nonrec invalid_sort_order_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The sort order was specified in an invalid format.
type nonrec invalid_sort_by_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The column name to sort by is either not present or was specified in an invalid format.
type nonrec invalid_key_prefix_filter_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified key prefix filter was specified in an invalid format.
type nonrec invalid_deployed_state_filter_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployed state filter was specified in an invalid format.
type nonrec invalid_bucket_name_filter_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The bucket name either doesn't exist or was specified in an invalid format.
type nonrec bucket_name_filter_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A bucket name is required, but was not provided.
type nonrec diagnostics = {log_tail : log_tail option;The last portion of the diagnostic log.
If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.
*)message : lifecycle_message option;The message associated with the error.
*)script_name : script_name option;The name of the script.
*)error_code : lifecycle_error_code option;The associated error code:
}Diagnostic information about executable scripts that are part of a deployment.
type nonrec lifecycle_event = {status : lifecycle_event_status option;The deployment lifecycle event status:
end_time : timestamp option;A timestamp that indicates when the deployment lifecycle event ended.
*)start_time : timestamp option;A timestamp that indicates when the deployment lifecycle event started.
*)diagnostics : diagnostics option;Diagnostic information about the deployment lifecycle event.
*)lifecycle_event_name : lifecycle_event_name option;The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
}Information about a deployment lifecycle event.
type nonrec lifecycle_event_list = lifecycle_event listtype nonrec last_deployment_info = {create_time : timestamp option;A timestamp that indicates when the most recent deployment to the deployment group started.
*)end_time : timestamp option;A timestamp that indicates when the most recent deployment to the deployment group was complete.
*)status : deployment_status option;The status of the most recent deployment.
*)deployment_id : deployment_id option;The unique ID of a deployment.
*)}Information about the most recent attempted or successful deployment to a deployment group.
type nonrec lambda_function_info = {target_version_weight : traffic_weight option;The percentage of production traffic that the target version of a Lambda function receives.
*)target_version : version option;The version of a Lambda function that production traffic points to after the Lambda function is deployed.
*)current_version : version option;The version of a Lambda function that production traffic points to.
*)function_alias : lambda_function_alias option;The alias of a Lambda function. For more information, see Lambda Function Aliases in the Lambda Developer Guide.
*)function_name : lambda_function_name option;The name of a Lambda function.
*)}Information about a Lambda function specified in a deployment.
type nonrec lambda_target = {lambda_function_info : lambda_function_info option;A LambdaFunctionInfo object that describes a target Lambda function.
lifecycle_events : lifecycle_event_list option;The lifecycle events of the deployment to this target Lambda function.
*)last_updated_at : time option;The date and time when the target Lambda function was updated by a deployment.
*)status : target_status option;The status an Lambda deployment's target Lambda function.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the target.
*)target_id : target_id option;The unique ID of a deployment target that has a type of lambdaTarget.
deployment_id : deployment_id option;The unique ID of a deployment.
*)}Information about the target Lambda function during an Lambda deployment.
type nonrec invalid_zonal_deployment_configuration_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The ZonalConfig object is not valid.
type nonrec invalid_update_outdated_instances_only_value_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The UpdateOutdatedInstancesOnly value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
type nonrec invalid_target_instances_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The target instance configuration is invalid. Possible causes include:
type nonrec invalid_operation_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}An invalid operation was detected.
type nonrec invalid_minimum_healthy_host_value_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The minimum healthy instance value was specified in an invalid format.
type nonrec invalid_ignore_application_stop_failures_value_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The IgnoreApplicationStopFailures value is invalid. For Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.
type nonrec invalid_git_hub_account_token_name_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The format of the specified GitHub account connection name is invalid.
type nonrec invalid_git_hub_account_token_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The GitHub token is not valid.
type nonrec invalid_file_exists_behavior_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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."
type nonrec invalid_deployment_wait_type_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The wait type is invalid.
type nonrec invalid_deployment_target_id_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The target ID provided was not valid.
type nonrec instance_target = {instance_label : target_label option;A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).
lifecycle_events : lifecycle_event_list option;The lifecycle events of the deployment to this target instance.
*)last_updated_at : time option;The date and time when the target instance was updated by a deployment.
*)status : target_status option;The status an EC2/On-premises deployment's target instance.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the target.
*)target_id : target_id option;The unique ID of a deployment target that has a type of instanceTarget.
deployment_id : deployment_id option;The unique ID of a deployment.
*)}A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform.
type nonrec instance_summary = {instance_type : instance_type option;Information about which environment an instance belongs to in a blue/green deployment.
lifecycle_events : lifecycle_event_list option;A list of lifecycle events for this instance.
*)last_updated_at : timestamp option;A timestamp that indicates when the instance information was last updated.
*)status : instance_status option;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.instance_id : instance_id option;The instance ID.
*)deployment_id : deployment_id option;The unique ID of a deployment.
*)}Information about an instance in a deployment.
type nonrec instance_summary_list = instance_summary listtype nonrec instance_info = {deregister_time : timestamp option;If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
*)register_time : timestamp option;The time at which the on-premises instance was registered.
*)instance_arn : instance_arn option;The ARN of the on-premises instance.
*)iam_user_arn : iam_user_arn option;The user ARN associated with the on-premises instance.
*)iam_session_arn : iam_session_arn option;The ARN of the IAM session associated with the on-premises instance.
*)instance_name : instance_name option;The name of the on-premises instance.
*)}Information about an on-premises instance.
type nonrec instance_info_list = instance_info listtype nonrec instance_id_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The instance ID was not specified.
type nonrec instance_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The specified instance does not exist in the deployment group.
type nonrec instance_count = Smaws_Lib.CoreTypes.Int64.ttype nonrec git_hub_account_token_name_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The call is missing a required GitHub account connection name.
type nonrec git_hub_account_token_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}No GitHub account connection exists with the named specified in the call.
type nonrec get_on_premises_instance_output = {instance_info : instance_info option;Information about the on-premises instance.
*)}Represents the output of a GetOnPremisesInstance operation.
type nonrec get_on_premises_instance_input = {instance_name : instance_name;The name of the on-premises instance about which to get information.
*)}Represents the input of a GetOnPremisesInstance operation.
type nonrec ecs_task_set_count = Smaws_Lib.CoreTypes.Int64.ttype nonrec ecs_task_set = {task_set_label : target_label option;A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
target_group : target_group_info option;The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
*)traffic_weight : traffic_weight option;The percentage of traffic served by this task set.
*)status : ecs_task_set_status option;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.running_count : ecs_task_set_count option;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.
pending_count : ecs_task_set_count option;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.
desired_count : ecs_task_set_count option;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.
*)identifer : ecs_task_set_identifier option;A unique ID of an ECSTaskSet.
}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.
type nonrec ecs_task_set_list = ecs_task_set listtype nonrec ecs_target = {task_sets_info : ecs_task_set_list option;The ECSTaskSet objects associated with the ECS target.
status : target_status option;The status an Amazon ECS deployment's target ECS application.
*)lifecycle_events : lifecycle_event_list option;The lifecycle events of the deployment to this target Amazon ECS application.
*)last_updated_at : time option;The date and time when the target Amazon ECS application was updated by a deployment.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the target.
*)target_id : target_id option;The unique ID of a deployment target that has a type of ecsTarget.
deployment_id : deployment_id option;The unique ID of a deployment.
*)}Information about the target of an Amazon ECS deployment.
type nonrec cloud_formation_target = {target_version_weight : traffic_weight option;The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.
*)resource_type : cloud_formation_resource_type option;The resource type for the CloudFormation blue/green deployment.
*)status : target_status option;The status of an CloudFormation blue/green deployment's target application.
*)lifecycle_events : lifecycle_event_list option;The lifecycle events of the CloudFormation blue/green deployment to this target application.
*)last_updated_at : time option;The date and time when the target application was updated by an CloudFormation blue/green deployment.
*)target_id : target_id option;The unique ID of a deployment target that has a type of CloudFormationTarget.
deployment_id : deployment_id option;The unique ID of an CloudFormation blue/green deployment.
*)}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.
type nonrec deployment_target = {cloud_formation_target : cloud_formation_target option;ecs_target : ecs_target option;Information about the target for a deployment that uses the Amazon ECS compute platform.
*)lambda_target : lambda_target option;Information about the target for a deployment that uses the Lambda compute platform.
*)instance_target : instance_target option;Information about the target for a deployment that uses the EC2/On-premises compute platform.
*)deployment_target_type : deployment_target_type option;The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.
*)}Information about the deployment target.
type nonrec get_deployment_target_output = {deployment_target : deployment_target option;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).
}type nonrec get_deployment_target_input = {target_id : target_id;The unique ID of a deployment target.
*)deployment_id : deployment_id;The unique ID of a deployment.
*)}type nonrec deployment_target_id_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A deployment target ID was not provided.
type nonrec deployment_target_does_not_exist_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The provided target ID does not belong to the attempted deployment.
type nonrec error_code = | CLOUDFORMATION_STACK_FAILURE| TIMEOUT| THROTTLED| REVISION_MISSING| RESOURCE_LIMIT_EXCEEDED| OVER_MAX_INSTANCES| NO_INSTANCES| NO_EC2_SUBSCRIPTION| MISSING_GITHUB_TOKEN| MISSING_ELB_INFORMATION| MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION| MANUAL_STOP| INVALID_REVISION| INVALID_LAMBDA_FUNCTION| INVALID_LAMBDA_CONFIGURATION| INVALID_ECS_SERVICE| INTERNAL_ERROR| IAM_ROLE_PERMISSIONS| IAM_ROLE_MISSING| HOOK_EXECUTION_FAILURE| HEALTH_CONSTRAINTS_INVALID| HEALTH_CONSTRAINTS| ELB_INVALID_INSTANCE| ELASTIC_LOAD_BALANCING_INVALID| ECS_UPDATE_ERROR| DEPLOYMENT_GROUP_MISSING| CUSTOMER_APPLICATION_UNHEALTHY| CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND| AUTO_SCALING_IAM_ROLE_PERMISSIONS| AUTO_SCALING_CONFIGURATION| AUTOSCALING_VALIDATION_ERROR| APPLICATION_MISSING| ALARM_ACTIVE| AGENT_ISSUEtype nonrec error_information = {message : error_message option;An accompanying error message.
*)code : error_code option;For more information, see Error Codes for CodeDeploy in the CodeDeploy User Guide.
The error code:
}Information about a deployment error.
type nonrec deployment_overview = {ready : instance_count option;The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
*)skipped : instance_count option;The number of instances in the deployment in a skipped state.
*)failed : instance_count option;The number of instances in the deployment in a failed state.
*)succeeded : instance_count option;The number of instances in the deployment to which revisions have been successfully deployed.
*)in_progress : instance_count option;The number of instances in which the deployment is in progress.
*)pending : instance_count option;The number of instances in the deployment in a pending state.
*)}Information about the deployment status of the instances in the deployment.
type nonrec deployment_status_message_list = error_message listtype nonrec deployment_info = {override_alarm_configuration : alarm_configuration option;external_id : external_id option;The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
*)compute_platform : compute_platform option;The destination platform type for the deployment (Lambda, Server, or ECS).
deployment_status_messages : deployment_status_message_list option;Messages that contain information about the status of a deployment.
*)file_exists_behavior : file_exists_behavior option;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.additional_deployment_status_info : additional_deployment_status_info option;Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
*)load_balancer_info : load_balancer_info option;Information about the load balancer used in the deployment.
*)blue_green_deployment_configuration : blue_green_deployment_configuration
option;Information about blue/green deployment options for this deployment.
*)instance_termination_wait_time_started : boolean_ option;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.
*)target_instances : target_instances option;Information about the instances that belong to the replacement environment in a blue/green deployment.
*)deployment_style : deployment_style option;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.
*)rollback_info : rollback_info option;Information about a deployment rollback.
*)update_outdated_instances_only : boolean_ option;Indicates whether only instances that are not running the latest application revision are to be deployed to.
*)auto_rollback_configuration : auto_rollback_configuration option;Information about the automatic rollback configuration associated with the deployment.
*)ignore_application_stop_failures : boolean_ option;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.
creator : deployment_creator option;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.description : description option;A comment about the deployment.
*)deployment_overview : deployment_overview option;A summary of the deployment status of the instances in the deployment.
*)complete_time : timestamp option;A timestamp that indicates when the deployment was complete.
*)start_time : timestamp option;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.
*)create_time : timestamp option;A timestamp that indicates when the deployment was created.
*)error_information : error_information option;Information about any error associated with this deployment.
*)status : deployment_status option;The current state of the deployment as a whole.
*)revision : revision_location option;Information about the location of stored application artifacts and the service from which to retrieve them.
*)previous_revision : revision_location option;Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
*)deployment_id : deployment_id option;The unique ID of a deployment.
*)deployment_config_name : deployment_config_name option;The deployment configuration name.
*)deployment_group_name : deployment_group_name option;The deployment group name.
*)application_name : application_name option;The application name.
*)}Information about a deployment.
type nonrec get_deployment_output = {deployment_info : deployment_info option;Information about the deployment.
*)}Represents the output of a GetDeployment operation.
type nonrec get_deployment_instance_output = {instance_summary : instance_summary option;Information about the instance.
*)}Represents the output of a GetDeploymentInstance operation.
type nonrec get_deployment_instance_input = {instance_id : instance_id;The unique ID of an instance in the deployment group.
*)deployment_id : deployment_id;The unique ID of a deployment.
*)}Represents the input of a GetDeploymentInstance operation.
type nonrec get_deployment_input = {deployment_id : deployment_id;The unique ID of a deployment associated with the user or Amazon Web Services account.
*)}Represents the input of a GetDeployment operation.
type nonrec deployment_group_info = {termination_hook_enabled : boolean_ option;Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.
For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.
*)ecs_services : ecs_service_list option;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
:.
*)compute_platform : compute_platform option;The destination platform type for the deployment (Lambda, Server, or ECS).
on_premises_tag_set : on_premises_tag_set option;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.
*)ec2_tag_set : ec2_tag_set option;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.
*)last_attempted_deployment : last_deployment_info option;Information about the most recent attempted deployment to the deployment group.
*)last_successful_deployment : last_deployment_info option;Information about the most recent successful deployment to the deployment group.
*)load_balancer_info : load_balancer_info option;Information about the load balancer to use in a deployment.
*)blue_green_deployment_configuration : blue_green_deployment_configuration
option;Information about blue/green deployment options for a deployment group.
*)outdated_instances_strategy : outdated_instances_strategy option;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.
deployment_style : deployment_style option;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.
*)auto_rollback_configuration : auto_rollback_configuration option;Information about the automatic rollback configuration associated with the deployment group.
*)alarm_configuration : alarm_configuration option;A list of alarms associated with the deployment group.
*)trigger_configurations : trigger_config_list option;Information about triggers associated with the deployment group.
*)target_revision : revision_location option;Information about the deployment group's target revision, including type and location.
*)service_role_arn : role option;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.
*)auto_scaling_groups : auto_scaling_group_list option;A list of associated Auto Scaling groups.
*)on_premises_instance_tag_filters : tag_filter_list option;The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
*)ec2_tag_filters : ec2_tag_filter_list option;The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
*)deployment_config_name : deployment_config_name option;The deployment configuration name.
*)deployment_group_name : deployment_group_name option;The deployment group name.
*)deployment_group_id : deployment_group_id option;The deployment group ID.
*)application_name : application_name option;The application name.
*)}Information about a deployment group.
type nonrec get_deployment_group_output = {deployment_group_info : deployment_group_info option;Information about the deployment group.
*)}Represents the output of a GetDeploymentGroup operation.
type nonrec get_deployment_group_input = {deployment_group_name : deployment_group_name;The name of a deployment group for the specified application.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a GetDeploymentGroup operation.
type nonrec deployment_config_info = {zonal_config : zonal_config option;Information about a zonal configuration.
*)traffic_routing_config : traffic_routing_config option;The configuration that specifies how the deployment traffic is routed. Used for deployments with a Lambda or Amazon ECS compute platform only.
*)compute_platform : compute_platform option;The destination platform type for the deployment (Lambda, Server, or ECS).
create_time : timestamp option;The time at which the deployment configuration was created.
*)minimum_healthy_hosts : minimum_healthy_hosts option;Information about the number or percentage of minimum healthy instances.
*)deployment_config_name : deployment_config_name option;The deployment configuration name.
*)deployment_config_id : deployment_config_id option;The deployment configuration ID.
*)}Information about a deployment configuration.
type nonrec get_deployment_config_output = {deployment_config_info : deployment_config_info option;Information about the deployment configuration.
*)}Represents the output of a GetDeploymentConfig operation.
type nonrec get_deployment_config_input = {deployment_config_name : deployment_config_name;The name of a deployment configuration associated with the user or Amazon Web Services account.
*)}Represents the input of a GetDeploymentConfig operation.
type nonrec deployment_config_name_required_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment configuration name was not specified.
type nonrec get_application_revision_output = {revision_info : generic_revision_info option;General information about the revision.
*)revision : revision_location option;Additional information about the revision, including type and location.
*)application_name : application_name option;The name of the application that corresponds to the revision.
*)}Represents the output of a GetApplicationRevision operation.
type nonrec get_application_revision_input = {revision : revision_location;Information about the application revision to get, including type and location.
*)application_name : application_name;The name of the application that corresponds to the revision.
*)}Represents the input of a GetApplicationRevision operation.
type nonrec application_info = {compute_platform : compute_platform option;The destination platform type for deployment of the application (Lambda or Server).
git_hub_account_name : git_hub_account_token_name option;The name for a connection to a GitHub account.
*)linked_to_git_hub : boolean_ option;True if the user has authenticated with GitHub for the specified application. Otherwise, false.
*)create_time : timestamp option;The time at which the application was created.
*)application_name : application_name option;The application name.
*)application_id : application_id option;The application ID.
*)}Information about an application.
type nonrec get_application_output = {application : application_info option;Information about the application.
*)}Represents the output of a GetApplication operation.
type nonrec get_application_input = {application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a GetApplication operation.
type nonrec deregister_on_premises_instance_input = {instance_name : instance_name;The name of the on-premises instance to deregister.
*)}Represents the input of a DeregisterOnPremisesInstance operation.
type nonrec deployments_info_list = deployment_info listtype nonrec deployment_target_list_size_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}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.
type nonrec deployment_target_list = deployment_target listtype nonrec deployment_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The number of allowed deployments was exceeded.
type nonrec deployment_is_not_in_ready_state_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment does not have a status of Ready and can't continue yet.
type nonrec deployment_group_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment groups limit was exceeded.
type nonrec deployment_group_info_list = deployment_group_info listtype nonrec deployment_config_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment configurations limit was exceeded.
type nonrec deployment_config_in_use_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The deployment configuration is still in use.
type nonrec deployment_config_already_exists_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}A deployment configuration with the specified name with the user or Amazon Web Services account already exists.
type nonrec delete_resources_by_external_id_input = {external_id : external_id option;The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.
*)}type nonrec delete_git_hub_account_token_output = {token_name : git_hub_account_token_name option;The name of the GitHub account connection that was deleted.
*)}Represents the output of a DeleteGitHubAccountToken operation.
type nonrec delete_git_hub_account_token_input = {token_name : git_hub_account_token_name option;The name of the GitHub account connection to delete.
*)}Represents the input of a DeleteGitHubAccount operation.
type nonrec delete_deployment_group_output = {hooks_not_cleaned_up : auto_scaling_group_list option;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.
*)}Represents the output of a DeleteDeploymentGroup operation.
type nonrec delete_deployment_group_input = {deployment_group_name : deployment_group_name;The name of a deployment group for the specified application.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a DeleteDeploymentGroup operation.
type nonrec delete_deployment_config_input = {deployment_config_name : deployment_config_name;The name of a deployment configuration associated with the user or Amazon Web Services account.
*)}Represents the input of a DeleteDeploymentConfig operation.
type nonrec delete_application_input = {application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a DeleteApplication operation.
type nonrec create_deployment_output = {deployment_id : deployment_id option;The unique ID of a deployment.
*)}Represents the output of a CreateDeployment operation.
type nonrec create_deployment_input = {override_alarm_configuration : alarm_configuration option;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.
file_exists_behavior : file_exists_behavior option;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:
update_outdated_instances_only : boolean_ option;Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
*)auto_rollback_configuration : auto_rollback_configuration option;Configuration information for an automatic rollback that is added when a deployment is created.
*)target_instances : target_instances option;Information about the instances that belong to the replacement environment in a blue/green deployment.
*)ignore_application_stop_failures : boolean_ option;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.
description : description option;A comment about the deployment.
*)deployment_config_name : deployment_config_name option;The name of a deployment configuration associated with the 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.
revision : revision_location option;The type and location of the revision to deploy.
*)deployment_group_name : deployment_group_name option;The name of the deployment group.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a CreateDeployment operation.
type nonrec create_deployment_group_output = {deployment_group_id : deployment_group_id option;A unique deployment group ID.
*)}Represents the output of a CreateDeploymentGroup operation.
type nonrec create_deployment_group_input = {termination_hook_enabled : nullable_boolean option;This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.
Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.
For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.
*)on_premises_tag_set : on_premises_tag_set option;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.
ecs_services : ecs_service_list option;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
:.
*)ec2_tag_set : ec2_tag_set option;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.
load_balancer_info : load_balancer_info option;Information about the load balancer used in a deployment.
*)blue_green_deployment_configuration : blue_green_deployment_configuration
option;Information about blue/green deployment options for a deployment group.
*)deployment_style : deployment_style option;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.
*)outdated_instances_strategy : outdated_instances_strategy option;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.
auto_rollback_configuration : auto_rollback_configuration option;Configuration information for an automatic rollback that is added when a deployment group is created.
*)alarm_configuration : alarm_configuration option;Information to add about Amazon CloudWatch alarms when the deployment group is created.
*)trigger_configurations : trigger_config_list option;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.
*)service_role_arn : role;A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
*)auto_scaling_groups : auto_scaling_group_name_list option;A list of associated Amazon EC2 Auto Scaling groups.
*)on_premises_instance_tag_filters : tag_filter_list option;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.
ec2_tag_filters : ec2_tag_filter_list option;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.
*)deployment_config_name : deployment_config_name option;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.
*)deployment_group_name : deployment_group_name;The name of a new deployment group for the specified application.
*)application_name : application_name;The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*)}Represents the input of a CreateDeploymentGroup operation.
type nonrec create_deployment_config_output = {deployment_config_id : deployment_config_id option;A unique deployment configuration ID.
*)}Represents the output of a CreateDeploymentConfig operation.
type nonrec create_deployment_config_input = {zonal_config : zonal_config option;Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
*)compute_platform : compute_platform option;The destination platform type for the deployment (Lambda, Server, or ECS).
traffic_routing_config : traffic_routing_config option;The configuration that specifies how the deployment traffic is routed.
*)minimum_healthy_hosts : minimum_healthy_hosts option;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:
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.
*)deployment_config_name : deployment_config_name;The name of the deployment configuration to create.
*)}Represents the input of a CreateDeploymentConfig operation.
type nonrec create_application_output = {application_id : application_id option;A unique application ID.
*)}Represents the output of a CreateApplication operation.
type nonrec create_application_input = {compute_platform : compute_platform option;The destination platform type for the deployment (Lambda, Server, or ECS).
application_name : application_name;The name of the application. This name must be unique with the applicable user or Amazon Web Services account.
*)}Represents the input of a CreateApplication operation.
type nonrec application_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}More applications were attempted to be created than are allowed.
type nonrec continue_deployment_input = {deployment_wait_type : deployment_wait_type option;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.
deployment_id : deployment_id option;The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
*)}type nonrec batch_limit_exceeded_exception = {message : message option;The message that corresponds to the exception thrown by CodeDeploy.
*)}The maximum number of names or IDs allowed for this request (100) was exceeded.
type nonrec batch_get_on_premises_instances_output = {instance_infos : instance_info_list option;Information about the on-premises instances.
*)}Represents the output of a BatchGetOnPremisesInstances operation.
type nonrec batch_get_on_premises_instances_input = {instance_names : instance_name_list;The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
*)}Represents the input of a BatchGetOnPremisesInstances operation.
type nonrec batch_get_deployment_targets_output = {deployment_targets : deployment_target_list option;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.
}type nonrec batch_get_deployment_targets_input = {target_ids : target_id_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.
instanceTarget.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
:. Their target type is ecsTarget.
cloudFormationTarget.deployment_id : deployment_id;The unique ID of a deployment.
*)}type nonrec batch_get_deployments_output = {deployments_info : deployments_info_list option;Information about the deployments.
*)}Represents the output of a BatchGetDeployments operation.
type nonrec batch_get_deployments_input = {deployment_ids : deployments_list;A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
*)}Represents the input of a BatchGetDeployments operation.
type nonrec batch_get_deployment_instances_output = {error_message : error_message option;Information about errors that might have occurred during the API call.
*)instances_summary : instance_summary_list option;Information about the instance.
*)}Represents the output of a BatchGetDeploymentInstances operation.
type nonrec batch_get_deployment_instances_input = {instance_ids : instances_list;The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
*)deployment_id : deployment_id;The unique ID of a deployment.
*)}Represents the input of a BatchGetDeploymentInstances operation.
type nonrec batch_get_deployment_groups_output = {error_message : error_message option;Information about errors that might have occurred during the API call.
*)deployment_groups_info : deployment_group_info_list option;Information about the deployment groups.
*)}Represents the output of a BatchGetDeploymentGroups operation.
type nonrec batch_get_deployment_groups_input = {deployment_group_names : deployment_groups_list;The names of the deployment groups.
*)application_name : application_name;The name of an CodeDeploy application associated with the applicable user or Amazon Web Services account.
*)}Represents the input of a BatchGetDeploymentGroups operation.
type nonrec applications_info_list = application_info listtype nonrec batch_get_applications_output = {applications_info : applications_info_list option;Information about the applications.
*)}Represents the output of a BatchGetApplications operation.
type nonrec batch_get_applications_input = {application_names : applications_list;A list of application names separated by spaces. The maximum number of application names you can specify is 100.
*)}Represents the input of a BatchGetApplications operation.
type nonrec batch_get_application_revisions_output = {revisions : revision_info_list option;Additional information about the revisions, including the type and location.
*)error_message : error_message option;Information about errors that might have occurred during the API call.
*)application_name : application_name option;The name of the application that corresponds to the revisions.
*)}Represents the output of a BatchGetApplicationRevisions operation.
type nonrec batch_get_application_revisions_input = {revisions : revision_location_list;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.
application_name : application_name;The name of an CodeDeploy application about which to get revision information.
*)}Represents the input of a BatchGetApplicationRevisions operation.