Smaws_Client_ElasticBeanstalk.Typestype nonrec version_labels_list = version_label listtype nonrec version_labels = version_label listtype nonrec validation_message = {option_name : configuration_option_name option;The name of the option.
*)namespace : option_namespace option;The namespace to which the option belongs.
*)severity : validation_severity option;An indication of the severity of this message:
error: This message indicates that this is not a valid setting for an option.warning: This message is providing information you should take into account.message : validation_message_string option;A message describing the error or warning.
*)}An error or warning for a desired configuration option value.
type nonrec validation_messages_list = validation_message listtype nonrec configuration_option_setting = {value : configuration_option_value option;The current value for the configuration option.
*)option_name : configuration_option_name option;The name of the configuration option.
*)namespace : option_namespace option;A unique namespace that identifies the option's associated AWS resource.
*)resource_name : resource_name option;A unique resource name for the option setting. Use it for a time–based scaling configuration option.
*)}A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.
type nonrec configuration_option_settings_list =
configuration_option_setting listtype nonrec validate_configuration_settings_message = {option_settings : configuration_option_settings_list;A list of the options and desired values to evaluate.
*)environment_name : environment_name option;The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
*)template_name : configuration_template_name option;The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
*)application_name : application_name;The name of the application that the configuration template or environment belongs to.
*)}A list of validation messages for a specified configuration template.
type nonrec too_many_buckets_exception = {message : exception_message option;The exception error message.
*)}The specified account has reached its limit of Amazon S3 buckets.
type nonrec insufficient_privileges_exception = {message : exception_message option;The exception error message.
*)}The specified account does not have sufficient privileges for one or more AWS services.
type nonrec configuration_settings_validation_messages = {messages : validation_messages_list option;A list of ValidationMessage.
}Provides a list of validation messages.
type nonrec tag_list = tag listtype nonrec tag_key_list = tag_key listThe number of tags in the resource would exceed the number of tags that each resource can have.
To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
type nonrec resource_type_not_supported_exception = {message : exception_message option;The exception error message.
*)}The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.
type nonrec resource_not_found_exception = {message : exception_message option;The exception error message.
*)}A resource doesn't exist for the specified Amazon Resource Name (ARN).
type nonrec operation_in_progress_exception = {message : exception_message option;The exception error message.
*)}Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
type nonrec environment_tier = {version : string_ option;The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
*)type_ : string_ option;The type of this environment tier.
Valid values:
StandardSQS/HTTPname : string_ option;The name of this environment tier.
Valid values:
WebServerWorker}Describes the properties of an environment tier
type nonrec option_specification = {option_name : configuration_option_name option;The name of the configuration option.
*)namespace : option_namespace option;A unique namespace identifying the option's associated AWS resource.
*)resource_name : resource_name option;A unique resource name for a time-based scaling configuration option.
*)}A specification identifying an individual configuration option.
type nonrec options_specifier_list = option_specification listtype nonrec update_environment_message = {options_to_remove : options_specifier_list option;A list of custom user-defined configuration options to remove from the configuration set for this environment.
*)option_settings : configuration_option_settings_list option;If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
*)platform_arn : platform_arn option;The ARN of the platform, if used.
*)solution_stack_name : solution_stack_name option;This specifies the platform version that the environment will run after the environment is updated.
*)template_name : configuration_template_name option;If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
version_label : version_label option;If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
tier : environment_tier option;This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.
description : description option;If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
*)group_name : group_name option;The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
*)environment_name : environment_name option;The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
application_name : application_name option;The name of the application with which the environment is associated.
*)}Request to update an environment.
type nonrec listener = {port : integer option;The port that is used by the Listener.
*)protocol : string_ option;The protocol that is used by the Listener.
*)}Describes the properties of a Listener for the LoadBalancer.
type nonrec load_balancer_listeners_description = listener listtype nonrec load_balancer_description = {listeners : load_balancer_listeners_description option;A list of Listeners used by the LoadBalancer.
*)domain : string_ option;The domain name of the LoadBalancer.
*)load_balancer_name : string_ option;The name of the LoadBalancer.
*)}Describes the details of a LoadBalancer.
type nonrec environment_resources_description = {load_balancer : load_balancer_description option;Describes the LoadBalancer.
*)}Describes the AWS resources in use by this environment. This data is not live data.
type nonrec environment_link = {environment_name : string_ option;The name of the linked environment (the dependency).
*)link_name : string_ option;The name of the link.
*)}A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
type nonrec environment_links = environment_link listtype nonrec environment_description = {operations_role : operations_role option;The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
*)environment_arn : environment_arn option;The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*)environment_links : environment_links option;A list of links to other environments in the same group.
*)tier : environment_tier option;Describes the current tier of this environment.
*)resources : environment_resources_description option;The description of the AWS resources used by this environment.
*)health_status : environment_health_status option;Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
*)health : environment_health option;Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.Green: Indicates the environment is healthy and fully functional.Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.Default: Grey
abortable_operation_in_progress : abortable_operation_in_progress option;Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true: There is an update in progress.
false: There are no updates currently in progress.
status : environment_status option;The current operational status of the environment:
Launching: Environment is in the process of initial deployment.Updating: Environment is in the process of updating its configuration settings or application version.Ready: Environment is available to have an action performed on it, such as update or terminate.Terminating: Environment is in the shut-down process.Terminated: Environment is not running.date_updated : update_date option;The last modified date for this environment.
*)date_created : creation_date option;The creation date for this environment.
*)cnam_e : dns_cname option;The URL to the CNAME for this environment.
*)endpoint_ur_l : endpoint_ur_l option;For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
*)description : description option;Describes this environment.
*)template_name : configuration_template_name option;The name of the configuration template used to originally launch this environment.
*)platform_arn : platform_arn option;The ARN of the platform version.
*)solution_stack_name : solution_stack_name option;The name of the SolutionStack deployed with this environment.
version_label : version_label option;The application version deployed in this environment.
*)application_name : application_name option;The name of the application associated with this environment.
*)environment_id : environment_id option;The ID of this environment.
*)environment_name : environment_name option;The name of this environment.
*)}Describes the properties of an environment.
type nonrec update_configuration_template_message = {options_to_remove : options_specifier_list option;A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined configuration options.
option_settings : configuration_option_settings_list option;A list of configuration option settings to update with the new specified option value.
*)description : description option;A new description for the configuration.
*)template_name : configuration_template_name;The name of the configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
application_name : application_name;The name of the application associated with the configuration template to update.
If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
}The result message containing the options for the specified solution stack.
type nonrec configuration_settings_description = {option_settings : configuration_option_settings_list option;A list of the configuration options and their values in this configuration set.
*)date_updated : update_date option;The date (in UTC time) when this configuration set was last modified.
*)date_created : creation_date option;The date (in UTC time) when this configuration set was created.
*)deployment_status : configuration_deployment_status option;If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null: This configuration is not associated with a running environment.pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.deployed: This is the configuration that is currently deployed to the associated running environment.failed: This is a draft configuration that failed to successfully deploy.environment_name : environment_name option;If not null, the name of the environment for this configuration set.
description : description option;Describes this configuration set.
*)template_name : configuration_template_name option;If not null, the name of the configuration template for this configuration set.
application_name : application_name option;The name of the application associated with this configuration set.
*)platform_arn : platform_arn option;The ARN of the platform version.
*)solution_stack_name : solution_stack_name option;The name of the solution stack this configuration set uses.
*)}Describes the settings for a configuration set.
type nonrec update_application_version_message = {description : description option;A new description for this version.
*)version_label : version_label;The name of the version to update.
If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
application_name : application_name;The name of the application associated with this version.
If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.
}type nonrec source_build_information = {source_location : source_location;The location of the source code, as a formatted string, depending on the value of SourceRepository
CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.source_repository : source_repository;Location where the repository is stored.
CodeCommitS3source_type : source_type;The type of repository.
GitZip}Location of the source code for an application version.
type nonrec s3_location = {s3_key : s3_key option;The Amazon S3 key where the data is located.
*)s3_bucket : s3_bucket option;The Amazon S3 bucket where the data is located.
*)}The bucket and key of an item stored in Amazon S3.
type nonrec application_version_description = {status : application_version_status option;The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.
Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.Processing – Elastic Beanstalk is currently processing the application version.Building – Application version is currently undergoing an AWS CodeBuild build.Processed – Elastic Beanstalk was successfully pre-processed and validated.Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.date_updated : update_date option;The last modified date of the application version.
*)date_created : creation_date option;The creation date of the application version.
*)source_bundle : s3_location option;The storage location of the application version's source bundle in Amazon S3.
*)build_arn : string_ option;Reference to the artifact from the AWS CodeBuild build.
*)source_build_information : source_build_information option;If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
*)version_label : version_label option;A unique identifier for the application version.
*)description : description option;The description of the application version.
*)application_name : application_name option;The name of the application to which the application version belongs.
*)application_version_arn : application_version_arn option;The Amazon Resource Name (ARN) of the application version.
*)}Describes the properties of an application version.
type nonrec application_version_description_message = {application_version : application_version_description option;The ApplicationVersionDescription of the application version.
}Result message wrapping a single description of an application version.
type nonrec max_count_rule = {delete_source_from_s3 : boxed_boolean option;Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
max_count : boxed_int option;Specify the maximum number of application versions to retain.
*)enabled : boxed_boolean;Specify true to apply the rule, or false to disable it.
}A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.
type nonrec max_age_rule = {delete_source_from_s3 : boxed_boolean option;Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
max_age_in_days : boxed_int option;Specify the number of days to retain an application versions.
*)enabled : boxed_boolean;Specify true to apply the rule, or false to disable it.
}A lifecycle rule that deletes application versions after the specified number of days.
type nonrec application_version_lifecycle_config = {max_age_rule : max_age_rule option;Specify a max age rule to restrict the length of time that application versions are retained for an application.
*)max_count_rule : max_count_rule option;Specify a max count rule to restrict the number of application versions that are retained for an application.
*)}The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.
When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.
type nonrec application_resource_lifecycle_config = {version_lifecycle_config : application_version_lifecycle_config option;Defines lifecycle settings for application versions.
*)service_role : string_ option;The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.
}The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
type nonrec update_application_resource_lifecycle_message = {resource_lifecycle_config : application_resource_lifecycle_config;The lifecycle configuration.
*)application_name : application_name;The name of the application.
*)}type nonrec application_resource_lifecycle_description_message = {resource_lifecycle_config : application_resource_lifecycle_config option;The lifecycle configuration.
*)application_name : application_name option;The name of the application.
*)}type nonrec update_application_message = {description : description option;A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
*)application_name : application_name;The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.
}Request to update an application.
type nonrec configuration_template_names_list =
configuration_template_name listtype nonrec application_description = {resource_lifecycle_config : application_resource_lifecycle_config option;The lifecycle settings for the application.
*)configuration_templates : configuration_template_names_list option;The names of the configuration templates associated with this application.
*)versions : version_labels_list option;The names of the versions for this application.
*)date_updated : update_date option;The date when the application was last modified.
*)date_created : creation_date option;The date when the application was created.
*)description : description option;User-defined description of the application.
*)application_name : application_name option;The name of the application.
*)application_arn : application_arn option;The Amazon Resource Name (ARN) of the application.
*)}Describes the properties of an application.
type nonrec application_description_message = {application : application_description option;The ApplicationDescription of the application.
}Result message containing a single description of an application.
Describes a trigger.
type nonrec trigger_list = trigger listtype nonrec too_many_platforms_exception = {message : exception_message option;The exception error message.
*)}You have exceeded the maximum number of allowed platforms associated with the account.
type nonrec too_many_environments_exception = {message : exception_message option;The exception error message.
*)}The specified account has reached its limit of environments.
type nonrec too_many_configuration_templates_exception = {message : exception_message option;The exception error message.
*)}The specified account has reached its limit of configuration templates.
type nonrec too_many_applications_exception = {message : exception_message option;The exception error message.
*)}The specified account has reached its limit of applications.
type nonrec too_many_application_versions_exception = {message : exception_message option;The exception error message.
*)}The specified account has reached its limit of application versions.
type nonrec terminate_environment_message = {force_terminate : force_terminate option;Terminates the target environment even if another environment in the same group is dependent on it.
*)terminate_resources : terminate_environment_resources option;Indicates whether the associated AWS resources should shut down when the environment is terminated:
true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true | false
environment_name : environment_name option;The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}Request to terminate an environment.
type nonrec tags = tag listtype nonrec cpu_utilization = {privileged : nullable_double option;Available on Windows environments only.
Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.
soft_ir_q : nullable_double option;Available on Linux environments only.
Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.
ir_q : nullable_double option;Available on Linux environments only.
Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.
io_wait : nullable_double option;Available on Linux environments only.
Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.
idle : nullable_double option;Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.
system : nullable_double option;Available on Linux environments only.
Percentage of time that the CPU has spent in the System state over the last 10 seconds.
nice : nullable_double option;Available on Linux environments only.
Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.
user : nullable_double option;Percentage of time that the CPU has spent in the User state over the last 10 seconds.
}CPU utilization metrics for an instance.
type nonrec load_average = load_average_value listtype nonrec system_status = {load_average : load_average option;Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
*)cpu_utilization : cpu_utilization option;CPU utilization metrics for the instance.
*)}CPU utilization and load average metrics for an Amazon EC2 instance.
type nonrec swap_environment_cnam_es_message = {destination_environment_name : environment_name option;The name of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.
destination_environment_id : environment_id option;The ID of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.
source_environment_name : environment_name option;The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.
source_environment_id : environment_id option;The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.
}Swaps the CNAMEs of two environments.
type nonrec supported_tier_list = supported_tier listtype nonrec supported_addon_list = supported_addon listtype nonrec status_codes = {status5xx : nullable_integer option;The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
*)status4xx : nullable_integer option;The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
*)status3xx : nullable_integer option;The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
*)status2xx : nullable_integer option;The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
*)}Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.
type nonrec source_configuration = {template_name : configuration_template_name option;The name of the configuration template.
*)application_name : application_name option;The name of the application associated with the configuration.
*)}A specification for an environment configuration.
type nonrec source_bundle_deletion_exception = {message : exception_message option;The exception error message.
*)}Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.
type nonrec solution_stack_file_type_list = file_type_extension listtype nonrec solution_stack_description = {permitted_file_types : solution_stack_file_type_list option;The permitted file types allowed for a solution stack.
*)solution_stack_name : solution_stack_name option;The name of the solution stack.
*)}Describes the solution stack.
type nonrec causes = cause listtype nonrec latency = {p10 : nullable_double option;The average latency for the slowest 90 percent of requests over the last 10 seconds.
*)p50 : nullable_double option;The average latency for the slowest 50 percent of requests over the last 10 seconds.
*)p75 : nullable_double option;The average latency for the slowest 25 percent of requests over the last 10 seconds.
*)p85 : nullable_double option;The average latency for the slowest 15 percent of requests over the last 10 seconds.
*)p90 : nullable_double option;The average latency for the slowest 10 percent of requests over the last 10 seconds.
*)p95 : nullable_double option;The average latency for the slowest 5 percent of requests over the last 10 seconds.
*)p99 : nullable_double option;The average latency for the slowest 1 percent of requests over the last 10 seconds.
*)p999 : nullable_double option;The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
*)}Represents the average latency for the slowest X percent of requests over the last 10 seconds.
type nonrec application_metrics = {latency : latency option;Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.
*)status_codes : status_codes option;Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
*)request_count : request_count option;Average number of requests handled by the web server per second over the last 10 seconds.
*)duration : nullable_integer option;The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).
}Application request metrics for an AWS Elastic Beanstalk environment.
type nonrec nullable_long = Smaws_Lib.CoreTypes.Int64.ttype nonrec deployment = {deployment_time : deployment_timestamp option;For in-progress deployments, the time that the deployment started.
For completed deployments, the time that the deployment ended.
*)status : string_ option;The status of the deployment:
In Progress : The deployment is in progress.Deployed : The deployment succeeded.Failed : The deployment failed.deployment_id : nullable_long option;The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
*)version_label : string_ option;The version label of the application version in the deployment.
*)}Information about an application version deployment.
type nonrec single_instance_health = {instance_type : string_ option;The instance's type.
*)availability_zone : string_ option;The availability zone in which the instance runs.
*)deployment : deployment option;Information about the most recent deployment to an instance.
*)system : system_status option;Operating system metrics from the instance.
*)application_metrics : application_metrics option;Request metrics from your application.
*)launched_at : launched_at option;The time at which the EC2 instance was launched.
*)causes : causes option;Represents the causes, which provide more information about the current health status.
*)color : string_ option;Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
*)health_status : string_ option;Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
*)instance_id : instance_id option;The ID of the Amazon EC2 instance.
*)}Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.
type nonrec search_filter_values = search_filter_value listtype nonrec search_filter = {values : search_filter_values option;The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.
operator : search_filter_operator option;The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.
attribute : search_filter_attribute option;The result attribute to which the filter values are applied. Valid values vary by API action.
*)}Describes criteria to restrict a list of results.
For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]
Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...
The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.
type nonrec search_filters = search_filter listtype nonrec s3_subscription_required_exception = {message : exception_message option;The exception error message.
*)}The specified account does not have a subscription to Amazon S3.
type nonrec s3_location_not_in_service_region_exception = {message : exception_message option;The exception error message.
*)}The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:
type nonrec environment_info_description = {message : message option;The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
*)sample_timestamp : sample_timestamp option;The time stamp when this information was retrieved.
*)ec2_instance_id : ec2_instance_id option;The Amazon EC2 Instance ID for this information.
*)info_type : environment_info_type option;The type of information retrieved.
*)}The information retrieved from the Amazon EC2 instances.
type nonrec environment_info_description_list =
environment_info_description listtype nonrec retrieve_environment_info_result_message = {environment_info : environment_info_description_list option;The EnvironmentInfoDescription of the environment.
}Result message containing a description of the requested environment info.
type nonrec retrieve_environment_info_message = {info_type : environment_info_type;The type of information to retrieve.
*)environment_name : environment_name option;The name of the data's environment.
If no such environment is found, returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the data's environment.
If no such environment is found, returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}Request to download logs retrieved with RequestEnvironmentInfo.
type nonrec restart_app_server_message = {environment_name : environment_name option;The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}type nonrec resource_quota = {maximum : boxed_int option;The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.
*)}The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.
type nonrec resource_quotas = {custom_platform_quota : resource_quota option;The quota for custom platforms in the AWS account.
*)configuration_template_quota : resource_quota option;The quota for configuration templates in the AWS account.
*)environment_quota : resource_quota option;The quota for environments in the AWS account.
*)application_version_quota : resource_quota option;The quota for application versions in the AWS account.
*)application_quota : resource_quota option;The quota for applications in the AWS account.
*)}A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.
type nonrec request_environment_info_message = {info_type : environment_info_type;The type of information to request.
*)environment_name : environment_name option;The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
type nonrec rebuild_environment_message = {environment_name : environment_name option;The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}type nonrec queue_list = queue listtype nonrec platform_version_still_referenced_exception = {message : exception_message option;The exception error message.
*)}You cannot delete the platform version because there are still environments running on it.
type nonrec platform_summary = {platform_branch_lifecycle_state : platform_branch_lifecycle_state option;The state of the platform version's branch in its lifecycle.
Possible values: beta | supported | deprecated | retired
platform_branch_name : branch_name option;The platform branch to which the platform version belongs.
*)platform_version : platform_version option;The version string of the platform version.
*)platform_lifecycle_state : platform_lifecycle_state option;The state of the platform version in its lifecycle.
Possible values: recommended | empty
If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
*)supported_addon_list : supported_addon_list option;The additions associated with the platform version.
*)supported_tier_list : supported_tier_list option;The tiers in which the platform version runs.
*)operating_system_version : operating_system_version option;The version of the operating system used by the platform version.
*)operating_system_name : operating_system_name option;The operating system used by the platform version.
*)platform_category : platform_category option;The category of platform version.
*)platform_status : platform_status option;The status of the platform version. You can create an environment from the platform version once it is ready.
*)platform_owner : platform_owner option;The AWS account ID of the person who created the platform version.
*)platform_arn : platform_arn option;The ARN of the platform version.
*)}Summary information about a platform version.
type nonrec platform_summary_list = platform_summary listtype nonrec platform_programming_language = {version : string_ option;The version of the programming language.
*)name : string_ option;The name of the programming language.
*)}A programming language supported by the platform.
type nonrec platform_programming_languages = platform_programming_language listtype nonrec platform_framework = {version : string_ option;The version of the framework.
*)name : string_ option;The name of the framework.
*)}A framework supported by the platform.
type nonrec platform_frameworks = platform_framework listtype nonrec platform_filter_value_list = platform_filter_value listtype nonrec platform_filter = {values : platform_filter_value_list option;The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.
The following list shows valid filter values for some filter attributes.
PlatformStatus: Creating | Failed | Ready | Deleting | DeletedPlatformLifecycleState: recommendedSupportedTier: WebServer/Standard | Worker/SQS/HTTPSupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSDoperator : platform_filter_operator option;The operator to apply to the Type with each of the Values.
Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with
type_ : platform_filter_type option;The platform version attribute to which the filter values are applied.
Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName
}Describes criteria to restrict the results when listing platform versions.
The filter is evaluated as follows: Type Operator Values[1]
type nonrec platform_filters = platform_filter listtype nonrec custom_ami = {image_id : image_id option;THe ID of the image used to create the custom AMI.
*)virtualization_type : virtualization_type option;The type of virtualization used to create the custom AMI.
*)}A custom AMI available to platforms.
type nonrec custom_ami_list = custom_ami listtype nonrec platform_description = {platform_branch_lifecycle_state : platform_branch_lifecycle_state option;The state of the platform version's branch in its lifecycle.
Possible values: Beta | Supported | Deprecated | Retired
platform_branch_name : branch_name option;The platform branch to which the platform version belongs.
*)platform_lifecycle_state : platform_lifecycle_state option;The state of the platform version in its lifecycle.
Possible values: Recommended | null
If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
*)supported_addon_list : supported_addon_list option;The additions supported by the platform version.
*)supported_tier_list : supported_tier_list option;The tiers supported by the platform version.
*)custom_ami_list : custom_ami_list option;The custom AMIs supported by the platform version.
*)frameworks : platform_frameworks option;The frameworks supported by the platform version.
*)programming_languages : platform_programming_languages option;The programming languages supported by the platform version.
*)operating_system_version : operating_system_version option;The version of the operating system used by the platform version.
*)operating_system_name : operating_system_name option;The operating system used by the platform version.
*)maintainer : maintainer option;Information about the maintainer of the platform version.
*)description : description option;The description of the platform version.
*)platform_category : platform_category option;The category of the platform version.
*)date_updated : update_date option;The date when the platform version was last updated.
*)date_created : creation_date option;The date when the platform version was created.
*)platform_status : platform_status option;The status of the platform version.
*)solution_stack_name : solution_stack_name option;The name of the solution stack used by the platform version.
*)platform_version : platform_version option;The version of the platform version.
*)platform_name : platform_name option;The name of the platform version.
*)platform_owner : platform_owner option;The AWS account ID of the person who created the platform version.
*)platform_arn : platform_arn option;The ARN of the platform version.
*)}Detailed information about a platform version.
type nonrec platform_branch_summary = {supported_tier_list : supported_tier_list option;The environment tiers that platform versions in this branch support.
Possible values: WebServer/Standard | Worker/SQS/HTTP
branch_order : branch_order option;An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.
A larger BranchOrder value designates a newer platform branch within the platform.
lifecycle_state : platform_branch_lifecycle_state option;The support life cycle state of the platform branch.
Possible values: beta | supported | deprecated | retired
branch_name : branch_name option;The name of the platform branch.
*)platform_name : platform_name option;The name of the platform to which this platform branch belongs.
*)}Summary information about a platform branch.
type nonrec platform_branch_summary_list = platform_branch_summary listtype nonrec option_restriction_regex = {label : regex_label option;A unique name representing this regular expression.
*)pattern : regex_pattern option;The regular expression pattern that a string configuration option value with this restriction must match.
*)}A regular expression representing a restriction on a string configuration option value.
type nonrec managed_action = {window_start_time : timestamp option;The start time of the maintenance window in which the managed action will execute.
*)status : action_status option;The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.
action_type : action_type option;The type of managed action.
*)action_description : string_ option;A description of the managed action.
*)action_id : string_ option;A unique identifier for the managed action.
*)}The record of an upcoming or in-progress managed action.
type nonrec managed_actions = managed_action listtype nonrec managed_action_invalid_state_exception = {message : exception_message option;The exception error message.
*)}Cannot modify the managed action in its current state.
type nonrec managed_action_history_item = {finished_time : timestamp option;The date and time that the action finished executing.
*)executed_time : timestamp option;The date and time that the action started executing.
*)failure_description : string_ option;If the action failed, a description of the failure.
*)status : action_history_status option;The status of the action.
*)failure_type : failure_type option;If the action failed, the type of failure.
*)action_description : string_ option;A description of the managed action.
*)action_type : action_type option;The type of the managed action.
*)action_id : string_ option;A unique identifier for the managed action.
*)}The record of a completed or failed managed action.
type nonrec managed_action_history_items = managed_action_history_item listDescribes a LoadBalancer.
type nonrec load_balancer_list = load_balancer listtype nonrec list_platform_versions_result = {next_token : token option;In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
platform_summary_list : platform_summary_list option;Summary information about the platform versions.
*)}type nonrec list_platform_versions_request = {next_token : token option;For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
max_records : platform_max_records option;The maximum number of platform version values returned in one call.
*)filters : platform_filters option;Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
}type nonrec elastic_beanstalk_service_exception = {message : exception_message option;The exception error message.
*)}A generic service exception has occurred.
type nonrec list_platform_branches_result = {next_token : token option;In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
platform_branch_summary_list : platform_branch_summary_list option;Summary information about the platform branches.
*)}type nonrec list_platform_branches_request = {next_token : token option;For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
max_records : platform_branch_max_records option;The maximum number of platform branch values returned in one call.
*)filters : search_filters option;Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.
The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.
Attribute = BranchName:
Operator: = | != | begins_with | ends_with | contains | in | not_inAttribute = LifecycleState:
Operator: = | != | in | not_inValues: beta | supported | deprecated | retiredAttribute = PlatformName:
Operator: = | != | begins_with | ends_with | contains | in | not_inAttribute = TierType:
Operator: = | !=Values: WebServer/Standard | Worker/SQS/HTTPArray size: limited to 10 SearchFilter objects.
Within each SearchFilter item, the Values array is limited to 10 items.
}type nonrec available_solution_stack_names_list = solution_stack_name listtype nonrec available_solution_stack_details_list =
solution_stack_description listtype nonrec list_available_solution_stacks_result_message = {solution_stack_details : available_solution_stack_details_list option;A list of available solution stacks and their SolutionStackDescription.
solution_stacks : available_solution_stack_names_list option;A list of available solution stacks.
*)}A list of available AWS Elastic Beanstalk solution stacks.
Describes an Amazon EC2 launch template.
type nonrec launch_template_list = launch_template listtype nonrec launch_configuration = {name : resource_id option;The name of the launch configuration.
*)}Describes an Auto Scaling launch configuration.
type nonrec launch_configuration_list = launch_configuration listtype nonrec invalid_request_exception = {message : exception_message option;The exception error message.
*)}One or more input parameters is not valid. Please correct the input parameters and try the operation again.
type nonrec instances_health_attributes = instances_health_attribute listThe description of an Amazon EC2 instance.
type nonrec instance_list = instance listtype nonrec instance_health_summary = {severe : nullable_integer option;Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
*)degraded : nullable_integer option;Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
*)warning : nullable_integer option;Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
*)info : nullable_integer option;Green. An operation is in progress on an instance.
*)ok : nullable_integer option;Green. An instance is passing health checks and the health agent is not reporting any problems.
*)pending : nullable_integer option;Grey. An operation is in progress on an instance within the command timeout.
*)unknown : nullable_integer option;Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
*)no_data : nullable_integer option;Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
*)}Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.
type nonrec instance_health_list = single_instance_health listtype nonrec event_description = {severity : event_severity option;The severity level of this event.
*)request_id : request_id option;The web service request ID for the activity of this event.
*)platform_arn : platform_arn option;The ARN of the platform version.
*)environment_name : environment_name option;The name of the environment associated with this event.
*)template_name : configuration_template_name option;The name of the configuration associated with this event.
*)version_label : version_label option;The release label for the application version associated with this event.
*)application_name : application_name option;The application associated with the event.
*)message : event_message option;The event message.
*)event_date : event_date option;The date when the event occurred.
*)}Describes an event.
type nonrec event_description_list = event_description listtype nonrec event_descriptions_message = {next_token : token option;If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
events : event_description_list option;A list of EventDescription.
}Result message wrapping a list of event descriptions.
Describes an Auto Scaling launch configuration.
type nonrec auto_scaling_group_list = auto_scaling_group listtype nonrec environment_resource_description = {queues : queue_list option;The queues used by this environment.
*)triggers : trigger_list option;The AutoScaling triggers in use by this environment.
load_balancers : load_balancer_list option;The LoadBalancers in use by this environment.
*)launch_templates : launch_template_list option;The Amazon EC2 launch templates in use by this environment.
*)launch_configurations : launch_configuration_list option;The Auto Scaling launch configurations in use by this environment.
*)instances : instance_list option;The Amazon EC2 instances used by this environment.
*)auto_scaling_groups : auto_scaling_group_list option;The AutoScalingGroups used by this environment.
environment_name : environment_name option;The name of the environment.
*)}Describes the AWS resources in use by this environment. This data is live.
type nonrec environment_resource_descriptions_message = {environment_resources : environment_resource_description option;A list of EnvironmentResourceDescription.
}Result message containing a list of environment resource descriptions.
type nonrec environment_names_list = environment_name listtype nonrec environment_id_list = environment_id listtype nonrec environment_health_attributes = environment_health_attribute listtype nonrec environment_descriptions_list = environment_description listtype nonrec environment_descriptions_message = {next_token : token option;In a paginated request, the token that you can pass in a subsequent request to get the next response page.
*)environments : environment_descriptions_list option;Returns an EnvironmentDescription list.
}Result message containing a list of environment descriptions.
type nonrec disassociate_environment_operations_role_message = {environment_name : environment_name;The name of the environment from which to disassociate the operations role.
*)}Request to disassociate the operations role from an environment.
type nonrec describe_platform_version_result = {platform_description : platform_description option;Detailed information about the platform version.
*)}type nonrec describe_platform_version_request = {platform_arn : platform_arn option;The ARN of the platform version.
*)}type nonrec describe_instances_health_result = {next_token : next_token option;Pagination token for the next page of results, if available.
*)refreshed_at : refreshed_at option;The date and time that the health information was retrieved.
*)instance_health_list : instance_health_list option;Detailed health information about each instance.
The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the
type.
*)}Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.
type nonrec describe_instances_health_request = {next_token : next_token option;Specify the pagination token returned by a previous call.
*)attribute_names : instances_health_attributes option;Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.
environment_id : environment_id option;Specify the AWS Elastic Beanstalk environment by ID.
*)environment_name : environment_name option;Specify the AWS Elastic Beanstalk environment by name.
*)}Parameters for a call to DescribeInstancesHealth.
type nonrec describe_events_message = {next_token : token option;Pagination token. If specified, the events return the next batch of results.
*)max_records : max_records option;Specifies the maximum number of events that can be returned, beginning with the most recent event.
*)end_time : time_filter_end option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
start_time : time_filter_start option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
*)severity : event_severity option;If specified, limits the events returned from this call to include only those with the specified severity or higher.
*)request_id : request_id option;If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
*)platform_arn : platform_arn option;The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
*)environment_name : environment_name option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
*)environment_id : environment_id option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
*)template_name : configuration_template_name option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
*)version_label : version_label option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
*)application_name : application_name option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
*)}Request to retrieve a list of events for an environment.
type nonrec describe_environments_message = {next_token : token option;For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
max_records : max_records option;For a paginated request. Specify a maximum number of environments to include in each response.
If no MaxRecords is specified, all available environments are retrieved in a single response.
included_deleted_back_to : include_deleted_back_to option;If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
include_deleted : include_deleted option;Indicates whether to include deleted environments:
true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
environment_names : environment_names_list option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
*)environment_ids : environment_id_list option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
*)version_label : version_label option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
*)application_name : application_name option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
*)}Request to describe one or more environments.
type nonrec describe_environment_resources_message = {environment_name : environment_name option;The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
environment_id : environment_id option;The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
}Request to describe the resources in an environment.
type nonrec describe_environment_managed_actions_result = {managed_actions : managed_actions option;A list of upcoming and in-progress managed actions.
*)}The result message containing a list of managed actions.
type nonrec describe_environment_managed_actions_request = {status : action_status option;To show only actions with a particular status, specify a status.
*)environment_id : string_ option;The environment ID of the target environment.
*)environment_name : string_ option;The name of the target environment.
*)}Request to list an environment's upcoming and in-progress managed actions.
type nonrec describe_environment_managed_action_history_result = {next_token : string_ option;A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
managed_action_history_items : managed_action_history_items option;A list of completed and failed managed actions.
*)}A result message containing a list of completed and failed managed actions.
type nonrec describe_environment_managed_action_history_request = {max_items : managed_action_history_max_items option;The maximum number of items to return for a single request.
*)next_token : string_ option;The pagination token returned by a previous request.
*)environment_name : environment_name option;The name of the target environment.
*)environment_id : environment_id option;The environment ID of the target environment.
*)}Request to list completed and failed managed actions.
type nonrec describe_environment_health_result = {refreshed_at : refreshed_at option;The date and time that the health information was retrieved.
*)instances_health : instance_health_summary option;Summary health information for the instances in the environment.
*)application_metrics : application_metrics option;Application request metrics for the environment.
*)causes : causes option;Descriptions of the data that contributed to the environment's current health status.
*)color : string_ option;status : environment_health option;The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
health_status : string_ option;environment_name : environment_name option;The environment's name.
*)}Health details for an AWS Elastic Beanstalk environment.
type nonrec describe_environment_health_request = {attribute_names : environment_health_attributes option;Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.
environment_id : environment_id option;Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.
*)environment_name : environment_name option;Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
*)}See the example below to learn how to create a request body.
type nonrec describe_configuration_settings_message = {environment_name : environment_name option;The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
template_name : configuration_template_name option;The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
application_name : application_name;The application for the environment or configuration template.
*)}Result message containing all of the configuration settings for a specified solution stack or configuration template.
type nonrec configuration_settings_description_list =
configuration_settings_description listtype nonrec configuration_settings_descriptions = {configuration_settings : configuration_settings_description_list option;A list of ConfigurationSettingsDescription.
}The results from a request to change the configuration settings of an environment.
type nonrec describe_configuration_options_message = {options : options_specifier_list option;If specified, restricts the descriptions to only the specified options.
*)platform_arn : platform_arn option;The ARN of the custom platform.
*)solution_stack_name : solution_stack_name option;The name of the solution stack whose configuration options you want to describe.
*)environment_name : environment_name option;The name of the environment whose configuration options you want to describe.
*)template_name : configuration_template_name option;The name of the configuration template whose configuration options you want to describe.
*)application_name : application_name option;The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
*)}Result message containing a list of application version descriptions.
type nonrec configuration_option_possible_values =
configuration_option_possible_value listtype nonrec configuration_option_description = {regex : option_restriction_regex option;If specified, the configuration option must be a string value that satisfies this regular expression.
*)max_length : option_restriction_max_length option;If specified, the configuration option must be a string value no longer than this value.
*)max_value : option_restriction_max_value option;If specified, the configuration option must be a numeric value less than this value.
*)min_value : option_restriction_min_value option;If specified, the configuration option must be a numeric value greater than this value.
*)value_options : configuration_option_possible_values option;If specified, values for the configuration option are selected from this list.
*)value_type : configuration_option_value_type option;An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.List : Values for this option are multiple selections from the possible values.Boolean : Values for this option are either true or false .Json : Values for this option are a JSON representation of a ConfigDocument.user_defined : user_defined_option option;An indication of whether the user defined this configuration option:
true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.false : This configuration was not defined by the user.Constraint: You can remove only UserDefined options from a configuration.
Valid Values: true | false
change_severity : configuration_option_severity option;An indication of which action is required if the value for this configuration option changes:
NoInterruption : There is no interruption to the environment or application availability.RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.default_value : configuration_option_default_value option;The default value for this configuration option.
*)name : configuration_option_name option;The name of the configuration option.
*)namespace : option_namespace option;A unique namespace identifying the option's associated AWS resource.
*)}Describes the possible values for a configuration option.
type nonrec configuration_option_descriptions_list =
configuration_option_description listtype nonrec configuration_options_description = {options : configuration_option_descriptions_list option;A list of ConfigurationOptionDescription.
platform_arn : platform_arn option;The ARN of the platform version.
*)solution_stack_name : solution_stack_name option;The name of the solution stack these configuration options belong to.
*)}Describes the settings for a specified configuration set.
type nonrec application_names_list = application_name listtype nonrec describe_applications_message = {application_names : application_names_list option;If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
*)}Request to describe one or more applications.
type nonrec application_description_list = application_description listtype nonrec application_descriptions_message = {applications : application_description_list option;This parameter contains a list of ApplicationDescription.
}Result message containing a list of application descriptions.
type nonrec describe_application_versions_message = {next_token : token option;For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
max_records : max_records option;For a paginated request. Specify a maximum number of application versions to include in each response.
If no MaxRecords is specified, all available application versions are retrieved in a single response.
version_labels : version_labels_list option;Specify a version label to show a specific application version.
*)application_name : application_name option;Specify an application name to show only application versions for that application.
*)}Request to describe application versions.
type nonrec application_version_description_list =
application_version_description listtype nonrec application_version_descriptions_message = {next_token : token option;In a paginated request, the token that you can pass in a subsequent request to get the next response page.
*)application_versions : application_version_description_list option;List of ApplicationVersionDescription objects sorted in order of creation.
}Result message wrapping a list of application version descriptions.
type nonrec describe_account_attributes_result = {resource_quotas : resource_quotas option;The Elastic Beanstalk resource quotas associated with the calling AWS account.
*)}type nonrec delete_platform_version_result = {platform_summary : platform_summary option;Detailed information about the version of the custom platform.
*)}type nonrec delete_platform_version_request = {platform_arn : platform_arn option;The ARN of the version of the custom platform.
*)}type nonrec delete_environment_configuration_message = {environment_name : environment_name;The name of the environment to delete the draft configuration from.
*)application_name : application_name;The name of the application the environment is associated with.
*)}Request to delete a draft environment configuration.
type nonrec delete_configuration_template_message = {template_name : configuration_template_name;The name of the configuration template to delete.
*)application_name : application_name;The name of the application to delete the configuration template from.
*)}Request to delete a configuration template.
type nonrec delete_application_version_message = {delete_source_bundle : delete_source_bundle option;Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
version_label : version_label;The label of the version to delete.
*)application_name : application_name;The name of the application to which the version belongs.
*)}Request to delete an application version.
type nonrec delete_application_message = {terminate_env_by_force : terminate_env_force option;When set to true, running environments will be terminated before deleting the application.
*)application_name : application_name;The name of the application to delete.
*)}Request to delete an application.
type nonrec create_storage_location_result_message = {s3_bucket : s3_bucket option;The name of the Amazon S3 bucket created.
*)}Results of a CreateStorageLocationResult call.
The builder used to build the custom platform.
type nonrec create_platform_version_result = {builder : builder option;The builder used to create the custom platform.
*)platform_summary : platform_summary option;Detailed information about the new version of the custom platform.
*)}type nonrec create_platform_version_request = {option_settings : configuration_option_settings_list option;The configuration option settings to apply to the builder environment.
*)environment_name : environment_name option;The name of the builder environment.
*)platform_definition_bundle : s3_location;The location of the platform definition archive in Amazon S3.
*)platform_version : platform_version;The number, such as 1.0.2, for the new platform version.
*)platform_name : platform_name;The name of your custom platform.
*)}Request to create a new platform version.
type nonrec create_environment_message = {operations_role : operations_role option;The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
options_to_remove : options_specifier_list option;A list of custom user-defined configuration options to remove from the configuration set for this new environment.
*)option_settings : configuration_option_settings_list option;If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
*)platform_arn : platform_arn option;The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, don't specify SolutionStackName.
solution_stack_name : solution_stack_name option;The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
template_name : configuration_template_name option;The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName, then don't specify SolutionStackName.
version_label : version_label option;The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*)tier : environment_tier option;Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
*)cname_prefix : dns_cname_prefix option;If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
*)description : description option;Your description for this environment.
*)group_name : group_name option;The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
*)environment_name : environment_name option;A unique name for the environment.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
application_name : application_name;The name of the application that is associated with this environment.
*)}type nonrec create_configuration_template_message = {option_settings : configuration_option_settings_list option;Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
*)description : description option;An optional description for this configuration.
*)environment_id : environment_id option;The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
source_configuration : source_configuration option;An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings override any values obtained from the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
*)platform_arn : platform_arn option;The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, then don't specify SolutionStackName.
solution_stack_name : solution_stack_name option;The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
template_name : configuration_template_name;The name of the configuration template.
Constraint: This name must be unique per application.
*)application_name : application_name;The name of the Elastic Beanstalk application to associate with this configuration template.
*)}Request to create a configuration template.
type nonrec build_configuration = {timeout_in_minutes : boxed_int option;How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
*)image : non_empty_string;The ID of the Docker image to use for this build project.
*)compute_type : compute_type option;Information about the compute resources the build project will use.
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for buildsBUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for buildsBUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for buildscode_build_service_role : non_empty_string;The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
*)artifact_name : string_ option;The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
*)}Settings for an AWS CodeBuild build.
type nonrec create_application_version_message = {process : application_version_proccess option;Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.
You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.
The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
auto_create_application : auto_create_application option;Set to true to create an application with the specified name if it doesn't already exist.
build_configuration : build_configuration option;Settings for an AWS CodeBuild build.
*)source_bundle : s3_location option;The Amazon S3 bucket and key that identify the location of the source bundle for this version.
The Amazon S3 bucket must be in the same region as the environment.
Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
source_build_information : source_build_information option;Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
*)description : description option;A description of this application version.
*)version_label : version_label;A label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
application_name : application_name;The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
}type nonrec code_build_not_in_service_region_exception = {message : exception_message option;The exception error message.
*)}AWS CodeBuild is not available in the specified region.
type nonrec create_application_message = {resource_lifecycle_config : application_resource_lifecycle_config option;Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
*)description : description option;Your description of the application.
*)application_name : application_name;The name of the application. Must be unique within your account.
*)}Request to create an application.
type nonrec compose_environments_message = {version_labels : version_labels option;A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
*)group_name : group_name option;The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
*)application_name : application_name option;The name of the application to which the specified source bundles belong.
*)}Request to create or update a group of environments.
type nonrec check_dns_availability_result_message = {fully_qualified_cnam_e : dns_cname option;The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
available : cname_availability option;Indicates if the specified CNAME is available:
true : The CNAME is available.false : The CNAME is not available.}Indicates if the specified CNAME is available.
type nonrec check_dns_availability_message = {cname_prefix : dns_cname_prefix;The prefix used when this CNAME is reserved.
*)}Results message indicating whether a CNAME is available.
type nonrec associate_environment_operations_role_message = {operations_role : operations_role;The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
*)environment_name : environment_name;The name of the environment to which to set the operations role.
*)}Request to add or change the operations role used by an environment.
type nonrec apply_environment_managed_action_result = {status : string_ option;The status of the managed action.
*)action_type : action_type option;The type of managed action.
*)action_description : string_ option;A description of the managed action.
*)action_id : string_ option;The action ID of the managed action.
*)}The result message containing information about the managed action.
type nonrec apply_environment_managed_action_request = {action_id : string_;The action ID of the scheduled managed action to execute.
*)environment_id : string_ option;The environment ID of the target environment.
*)environment_name : string_ option;The name of the target environment.
*)}Request to execute a scheduled managed action immediately.
type nonrec abort_environment_update_message = {environment_name : environment_name option;This specifies the name of the environment with the in-progress update that you want to cancel.
*)environment_id : environment_id option;This specifies the ID of the environment with the in-progress update that you want to cancel.
*)}