ExAws.ElasticBeanstalk.Core
AWS Elastic Beanstalk
AWS Elastic Beanstalk
This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.
AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
Summary↑
Types ↑
create_configuration_template_message :: [application_name: application_name, description: description, environment_id: environment_id, option_settings: configuration_option_settings_list, solution_stack_name: solution_stack_name, source_configuration: source_configuration, template_name: configuration_template_name]
environment_id :: binary
request_environment_info_message :: [environment_id: environment_id, environment_name: environment_name, info_type: environment_info_type]
regex_pattern :: binary
application_version_descriptions_message :: [{:application_versions, application_version_description_list}]
load_average_value :: float
configuration_option_default_value :: binary
instance_health_summary :: [degraded: nullable_integer, info: nullable_integer, no_data: nullable_integer, ok: nullable_integer, pending: nullable_integer, severe: nullable_integer, unknown: nullable_integer, warning: nullable_integer]
update_environment_message :: [description: description, environment_id: environment_id, environment_name: environment_name, option_settings: configuration_option_settings_list, options_to_remove: options_specifier_list, solution_stack_name: solution_stack_name, template_name: configuration_template_name, tier: environment_tier, version_label: version_label]
describe_instances_health_result :: [instance_health_list: instance_health_list, next_token: next_token, refreshed_at: refreshed_at]
event_message :: binary
update_application_message :: [application_name: application_name, description: description]
environment_descriptions_message :: [{:environments, environment_descriptions_list}]
option_restriction_min_value :: integer
validation_message :: [message: validation_message_string, namespace: option_namespace, option_name: configuration_option_name, severity: validation_severity]
listener :: [port: integer, protocol: binary]
rebuild_environment_message :: [environment_id: environment_id, environment_name: environment_name]
check_dns_availability_message :: [{:cname_prefix, dns_cname_prefix}]
cpu_utilization :: [io_wait: nullable_double, irq: nullable_double, idle: nullable_double, nice: nullable_double, soft_irq: nullable_double, system: nullable_double, user: nullable_double]
event_descriptions_message :: [events: event_description_list, next_token: token]
creation_date :: integer
describe_application_versions_message :: [application_name: application_name, version_labels: version_labels_list]
dns_cname_prefix :: binary
s3_location :: [s3_bucket: s3_bucket, s3_key: s3_key]
configuration_option_setting :: [namespace: option_namespace, option_name: configuration_option_name, resource_name: resource_name, value: configuration_option_value]
describe_configuration_settings_message :: [application_name: application_name, environment_name: environment_name, template_name: configuration_template_name]
delete_source_bundle :: boolean
environment_name :: binary
environment_health_attribute :: binary
abort_environment_update_message :: [environment_id: environment_id, environment_name: environment_name]
configuration_option_description :: [change_severity: configuration_option_severity, default_value: configuration_option_default_value, max_length: option_restriction_max_length, max_value: option_restriction_max_value, min_value: option_restriction_min_value, name: configuration_option_name, namespace: option_namespace, regex: option_restriction_regex, user_defined: user_defined_option, value_options: configuration_option_possible_values, value_type: configuration_option_value_type]
configuration_template_name :: binary
time_filter_start :: integer
application_version_description :: [application_name: application_name, date_created: creation_date, date_updated: update_date, description: description, source_bundle: s3_location, version_label: version_label]
update_date :: integer
create_application_message :: [application_name: application_name, description: description]
dns_cname :: binary
configuration_deployment_status :: binary
instance_list :: [instance]
update_configuration_template_message :: [application_name: application_name, description: description, option_settings: configuration_option_settings_list, options_to_remove: options_specifier_list, template_name: configuration_template_name]
load_balancer :: [{:name, resource_id}]
endpoint_url :: binary
event_date :: integer
configuration_options_description :: [options: configuration_option_descriptions_list, solution_stack_name: solution_stack_name]
include_deleted_back_to :: integer
environment_description :: [abortable_operation_in_progress: abortable_operation_in_progress, application_name: application_name, cname: dns_cname, date_created: creation_date, date_updated: update_date, description: description, endpoint_url: endpoint_url, environment_id: environment_id, environment_name: environment_name, health: environment_health, health_status: environment_health_status, resources: environment_resources_description, solution_stack_name: solution_stack_name, status: environment_status, template_name: configuration_template_name, tier: environment_tier, version_label: version_label]
solution_stack_name :: binary
update_application_version_message :: [application_name: application_name, description: description, version_label: version_label]
instance_id :: binary
terminate_environment_resources :: boolean
system_status :: [cpu_utilization: cpu_utilization, load_average: load_average]
instances_health_attribute :: binary
configuration_settings_descriptions :: [{:configuration_settings, configuration_settings_description_list}]
token :: binary
launched_at :: integer
include_deleted :: boolean
load_balancer_description :: [domain: binary, listeners: load_balancer_listeners_description, load_balancer_name: binary]
s3_bucket :: binary
configuration_option_severity :: binary
option_restriction_regex :: [label: regex_label, pattern: regex_pattern]
nullable_integer :: integer
ec2_instance_id :: binary
description :: binary
file_type_extension :: binary
configuration_option_value_type :: binary
application_metrics :: [duration: nullable_integer, latency: latency, request_count: request_count, status_codes: status_codes]
terminate_env_force :: boolean
message :: binary
environment_health_status :: binary
describe_configuration_options_message :: [application_name: application_name, environment_name: environment_name, options: options_specifier_list, solution_stack_name: solution_stack_name, template_name: configuration_template_name]
describe_instances_health_request :: [attribute_names: instances_health_attributes, environment_id: environment_id, environment_name: environment_name, next_token: next_token]
request_count :: integer
create_storage_location_result_message :: [{:s3_bucket, s3_bucket}]
describe_applications_message :: [{:application_names, application_names_list}]
queue :: [name: binary, url: binary]
delete_application_version_message :: [application_name: application_name, delete_source_bundle: delete_source_bundle, version_label: version_label]
configuration_option_possible_value :: binary
tag_value :: binary
cname_availability :: boolean
max_records :: integer
latency :: [p10: nullable_double, p50: nullable_double, p75: nullable_double, p85: nullable_double, p90: nullable_double, p95: nullable_double, p99: nullable_double, p999: nullable_double]
environment_tier :: [name: binary, type: binary, version: binary]
retrieve_environment_info_result_message :: [{:environment_info, environment_info_description_list}]
environment_status :: binary
application_descriptions_message :: [{:applications, application_description_list}]
version_label :: binary
terminate_environment_message :: [environment_id: environment_id, environment_name: environment_name, terminate_resources: terminate_environment_resources]
validation_severity :: binary
option_namespace :: binary
launch_configuration :: [{:name, resource_id}]
cause :: binary
option_specification :: [namespace: option_namespace, option_name: configuration_option_name, resource_name: resource_name]
environment_resources_description :: [{:load_balancer, load_balancer_description}]
resource_id :: binary
environment_info_description :: [ec2_instance_id: ec2_instance_id, info_type: environment_info_type, message: message, sample_timestamp: sample_timestamp]
configuration_settings_validation_messages :: [{:messages, validation_messages_list}]
solution_stack_description :: [permitted_file_types: solution_stack_file_type_list, solution_stack_name: solution_stack_name]
event_severity :: binary
configuration_option_name :: binary
delete_configuration_template_message :: [application_name: application_name, template_name: configuration_template_name]
configuration_option_value :: binary
refreshed_at :: integer
check_dns_availability_result_message :: [available: cname_availability, fully_qualified_cname: dns_cname]
describe_environment_health_result :: [application_metrics: application_metrics, causes: causes, color: binary, environment_name: environment_name, health_status: binary, instances_health: instance_health_summary, refreshed_at: refreshed_at, status: environment_health]
describe_events_message :: [application_name: application_name, end_time: time_filter_end, environment_id: environment_id, environment_name: environment_name, max_records: max_records, next_token: token, request_id: request_id, severity: event_severity, start_time: time_filter_start, template_name: configuration_template_name, version_label: version_label]
swap_environment_cnam_es_message :: [destination_environment_id: environment_id, destination_environment_name: environment_name, source_environment_id: environment_id, source_environment_name: environment_name]
abortable_operation_in_progress :: boolean
validation_message_string :: binary
exception_message :: binary
regex_label :: binary
trigger :: [{:name, resource_id}]
trigger_list :: [trigger]
application_name :: binary
nullable_double :: float
application_description_message :: [{:application, application_description}]
describe_environments_message :: [application_name: application_name, environment_ids: environment_id_list, environment_names: environment_names_list, include_deleted: include_deleted, included_deleted_back_to: include_deleted_back_to, version_label: version_label]
user_defined_option :: boolean
application_version_description_message :: [{:application_version, application_version_description}]
request_id :: binary
queue_list :: [queue]
tag_key :: binary
environment_resource_descriptions_message :: [{:environment_resources, environment_resource_description}]
sample_timestamp :: integer
single_instance_health :: [application_metrics: application_metrics, causes: causes, color: binary, health_status: binary, instance_id: instance_id, launched_at: launched_at, system: system_status]
retrieve_environment_info_message :: [environment_id: environment_id, environment_name: environment_name, info_type: environment_info_type]
environment_info_type :: binary
create_application_version_message :: [application_name: application_name, auto_create_application: auto_create_application, description: description, source_bundle: s3_location, version_label: version_label]
application_description :: [application_name: application_name, configuration_templates: configuration_template_names_list, date_created: creation_date, date_updated: update_date, description: description, versions: version_labels_list]
configuration_settings_description :: [application_name: application_name, date_created: creation_date, date_updated: update_date, deployment_status: configuration_deployment_status, description: description, environment_name: environment_name, option_settings: configuration_option_settings_list, solution_stack_name: solution_stack_name, template_name: configuration_template_name]
auto_scaling_group :: [{:name, resource_id}]
resource_name :: binary
delete_environment_configuration_message :: [application_name: application_name, environment_name: environment_name]
event_description :: [application_name: application_name, environment_name: environment_name, event_date: event_date, message: event_message, request_id: request_id, severity: event_severity, template_name: configuration_template_name, version_label: version_label]
list_available_solution_stacks_result_message :: [solution_stack_details: available_solution_stack_details_list, solution_stacks: available_solution_stack_names_list]
environment_resource_description :: [auto_scaling_groups: auto_scaling_group_list, environment_name: environment_name, instances: instance_list, launch_configurations: launch_configuration_list, load_balancers: load_balancer_list, queues: queue_list, triggers: trigger_list]
source_configuration :: [application_name: application_name, template_name: configuration_template_name]
delete_application_message :: [application_name: application_name, terminate_env_by_force: terminate_env_force]
auto_create_application :: boolean
time_filter_end :: integer
elastic_beanstalk_service_exception :: [{:message, exception_message}]
next_token :: binary
s3_key :: binary
describe_environment_health_request :: [attribute_names: environment_health_attributes, environment_id: environment_id, environment_name: environment_name]
describe_environment_resources_message :: [environment_id: environment_id, environment_name: environment_name]
create_environment_message :: [application_name: application_name, cname_prefix: dns_cname_prefix, description: description, environment_name: environment_name, option_settings: configuration_option_settings_list, options_to_remove: options_specifier_list, solution_stack_name: solution_stack_name, tags: tags, template_name: configuration_template_name, tier: environment_tier, version_label: version_label]
environment_health :: binary
option_restriction_max_length :: integer
status_codes :: [status2xx: nullable_integer, status3xx: nullable_integer, status4xx: nullable_integer, status5xx: nullable_integer]
option_restriction_max_value :: integer
restart_app_server_message :: [environment_id: environment_id, environment_name: environment_name]
validate_configuration_settings_message :: [application_name: application_name, environment_name: environment_name, option_settings: configuration_option_settings_list, template_name: configuration_template_name]
instance :: [{:id, resource_id}]
Functions
Specs:
- abort_environment_update(client :: ExAws.ElasticBeanstalk.t, input :: abort_environment_update_message) :: ExAws.Request.Query.response_t
AbortEnvironmentUpdate
Cancels in-progress environment configuration update or application version deployment.
Specs:
- abort_environment_update!(client :: ExAws.ElasticBeanstalk.t, input :: abort_environment_update_message) :: ExAws.Request.Query.success_t | no_return
Same as abort_environment_update/2
but raise on error.
Specs:
- check_dns_availability(client :: ExAws.ElasticBeanstalk.t, input :: check_dns_availability_message) :: ExAws.Request.Query.response_t
CheckDNSAvailability
Checks if the specified CNAME is available.
Specs:
- check_dns_availability!(client :: ExAws.ElasticBeanstalk.t, input :: check_dns_availability_message) :: ExAws.Request.Query.success_t | no_return
Same as check_dns_availability/2
but raise on error.
Specs:
- create_application(client :: ExAws.ElasticBeanstalk.t, input :: create_application_message) :: ExAws.Request.Query.response_t
CreateApplication
Creates an application that has one configuration template named default
and no application versions.
Specs:
- create_application!(client :: ExAws.ElasticBeanstalk.t, input :: create_application_message) :: ExAws.Request.Query.success_t | no_return
Same as create_application/2
but raise on error.
Specs:
- create_application_version(client :: ExAws.ElasticBeanstalk.t, input :: create_application_version_message) :: ExAws.Request.Query.response_t
CreateApplicationVersion
Creates an application version for the specified application.
Note:Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Specs:
- create_application_version!(client :: ExAws.ElasticBeanstalk.t, input :: create_application_version_message) :: ExAws.Request.Query.success_t | no_return
Same as create_application_version/2
but raise on error.
Specs:
- create_configuration_template(client :: ExAws.ElasticBeanstalk.t, input :: create_configuration_template_message) :: ExAws.Request.Query.response_t
CreateConfigurationTemplate
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks
Specs:
- create_configuration_template!(client :: ExAws.ElasticBeanstalk.t, input :: create_configuration_template_message) :: ExAws.Request.Query.success_t | no_return
Same as create_configuration_template/2
but raise on error.
Specs:
- create_environment(client :: ExAws.ElasticBeanstalk.t, input :: create_environment_message) :: ExAws.Request.Query.response_t
CreateEnvironment
Launches an environment for the specified application using the specified configuration.
Specs:
- create_environment!(client :: ExAws.ElasticBeanstalk.t, input :: create_environment_message) :: ExAws.Request.Query.success_t | no_return
Same as create_environment/2
but raise on error.
Specs:
- create_storage_location(client :: ExAws.ElasticBeanstalk.t) :: ExAws.Request.Query.response_t
CreateStorageLocation
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
Specs:
- create_storage_location!(client :: ExAws.ElasticBeanstalk.t) :: ExAws.Request.Query.success_t | no_return
Same as create_storage_location/2
but raise on error.
Specs:
- delete_application(client :: ExAws.ElasticBeanstalk.t, input :: delete_application_message) :: ExAws.Request.Query.response_t
DeleteApplication
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
Note:You cannot delete an application that has a running environment.
Specs:
- delete_application!(client :: ExAws.ElasticBeanstalk.t, input :: delete_application_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_application/2
but raise on error.
Specs:
- delete_application_version(client :: ExAws.ElasticBeanstalk.t, input :: delete_application_version_message) :: ExAws.Request.Query.response_t
DeleteApplicationVersion
Deletes the specified version from the specified application.
Note:You cannot delete an application version that is associated with a running environment.
Specs:
- delete_application_version!(client :: ExAws.ElasticBeanstalk.t, input :: delete_application_version_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_application_version/2
but raise on error.
Specs:
- delete_configuration_template(client :: ExAws.ElasticBeanstalk.t, input :: delete_configuration_template_message) :: ExAws.Request.Query.response_t
DeleteConfigurationTemplate
Deletes the specified configuration template.
Note:When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment’s copy of the template without affecting the running environment.
Specs:
- delete_configuration_template!(client :: ExAws.ElasticBeanstalk.t, input :: delete_configuration_template_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_configuration_template/2
but raise on error.
Specs:
- delete_environment_configuration(client :: ExAws.ElasticBeanstalk.t, input :: delete_environment_configuration_message) :: ExAws.Request.Query.response_t
DeleteEnvironmentConfiguration
Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a
draft configuration set. You can get the draft configuration using
DescribeConfigurationSettings
while the update is in progress or if the
update fails. The DeploymentStatus
for the draft configuration indicates
whether the deployment is in process or has failed. The draft configuration
remains in existence until it is deleted with this action.
Specs:
- delete_environment_configuration!(client :: ExAws.ElasticBeanstalk.t, input :: delete_environment_configuration_message) :: ExAws.Request.Query.success_t | no_return
Same as delete_environment_configuration/2
but raise on error.
Specs:
- describe_application_versions(client :: ExAws.ElasticBeanstalk.t, input :: describe_application_versions_message) :: ExAws.Request.Query.response_t
DescribeApplicationVersions
Returns descriptions for existing application versions.
Specs:
- describe_application_versions!(client :: ExAws.ElasticBeanstalk.t, input :: describe_application_versions_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_application_versions/2
but raise on error.
Specs:
- describe_applications(client :: ExAws.ElasticBeanstalk.t, input :: describe_applications_message) :: ExAws.Request.Query.response_t
DescribeApplications
Returns the descriptions of existing applications.
Specs:
- describe_applications!(client :: ExAws.ElasticBeanstalk.t, input :: describe_applications_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_applications/2
but raise on error.
Specs:
- describe_configuration_options(client :: ExAws.ElasticBeanstalk.t, input :: describe_configuration_options_message) :: ExAws.Request.Query.response_t
DescribeConfigurationOptions
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
Specs:
- describe_configuration_options!(client :: ExAws.ElasticBeanstalk.t, input :: describe_configuration_options_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_configuration_options/2
but raise on error.
Specs:
- describe_configuration_settings(client :: ExAws.ElasticBeanstalk.t, input :: describe_configuration_settings_message) :: ExAws.Request.Query.response_t
DescribeConfigurationSettings
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
DeleteEnvironmentConfiguration
Specs:
- describe_configuration_settings!(client :: ExAws.ElasticBeanstalk.t, input :: describe_configuration_settings_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_configuration_settings/2
but raise on error.
Specs:
- describe_environment_health(client :: ExAws.ElasticBeanstalk.t, input :: describe_environment_health_request) :: ExAws.Request.Query.response_t
DescribeEnvironmentHealth
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Specs:
- describe_environment_health!(client :: ExAws.ElasticBeanstalk.t, input :: describe_environment_health_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_environment_health/2
but raise on error.
Specs:
- describe_environment_resources(client :: ExAws.ElasticBeanstalk.t, input :: describe_environment_resources_message) :: ExAws.Request.Query.response_t
DescribeEnvironmentResources
Returns AWS resources for this environment.
Specs:
- describe_environment_resources!(client :: ExAws.ElasticBeanstalk.t, input :: describe_environment_resources_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_environment_resources/2
but raise on error.
Specs:
- describe_environments(client :: ExAws.ElasticBeanstalk.t, input :: describe_environments_message) :: ExAws.Request.Query.response_t
DescribeEnvironments
Returns descriptions for existing environments.
Specs:
- describe_environments!(client :: ExAws.ElasticBeanstalk.t, input :: describe_environments_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_environments/2
but raise on error.
Specs:
- describe_events(client :: ExAws.ElasticBeanstalk.t, input :: describe_events_message) :: ExAws.Request.Query.response_t
DescribeEvents
Returns list of event descriptions matching criteria up to the last 6 weeks.
Note: This action returns the most recent 1,000 events from the specified
NextToken
.
Specs:
- describe_events!(client :: ExAws.ElasticBeanstalk.t, input :: describe_events_message) :: ExAws.Request.Query.success_t | no_return
Same as describe_events/2
but raise on error.
Specs:
- describe_instances_health(client :: ExAws.ElasticBeanstalk.t, input :: describe_instances_health_request) :: ExAws.Request.Query.response_t
DescribeInstancesHealth
Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Specs:
- describe_instances_health!(client :: ExAws.ElasticBeanstalk.t, input :: describe_instances_health_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_instances_health/2
but raise on error.
Specs:
- list_available_solution_stacks(client :: ExAws.ElasticBeanstalk.t) :: ExAws.Request.Query.response_t
ListAvailableSolutionStacks
Returns a list of the available solution stack names.
Specs:
- list_available_solution_stacks!(client :: ExAws.ElasticBeanstalk.t) :: ExAws.Request.Query.success_t | no_return
Same as list_available_solution_stacks/2
but raise on error.
Specs:
- rebuild_environment(client :: ExAws.ElasticBeanstalk.t, input :: rebuild_environment_message) :: ExAws.Request.Query.response_t
RebuildEnvironment
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
Specs:
- rebuild_environment!(client :: ExAws.ElasticBeanstalk.t, input :: rebuild_environment_message) :: ExAws.Request.Query.success_t | no_return
Same as rebuild_environment/2
but raise on error.
Specs:
- request_environment_info(client :: ExAws.ElasticBeanstalk.t, input :: request_environment_info_message) :: ExAws.Request.Query.response_t
RequestEnvironmentInfo
Initiates a request to compile the specified type of information of the deployed environment.
Setting the InfoType
to tail
compiles the last lines from the
application server log files of every Amazon EC2 instance in your
environment.
Setting the InfoType
to bundle
compresses the application server log
files for every Amazon EC2 instance into a .zip
file. Legacy and .NET
containers do not support bundle logs.
Use RetrieveEnvironmentInfo
to obtain the set of logs.
Related Topics
RetrieveEnvironmentInfo
Specs:
- request_environment_info!(client :: ExAws.ElasticBeanstalk.t, input :: request_environment_info_message) :: ExAws.Request.Query.success_t | no_return
Same as request_environment_info/2
but raise on error.
Specs:
- restart_app_server(client :: ExAws.ElasticBeanstalk.t, input :: restart_app_server_message) :: ExAws.Request.Query.response_t
RestartAppServer
Causes the environment to restart the application container server running on each Amazon EC2 instance.
Specs:
- restart_app_server!(client :: ExAws.ElasticBeanstalk.t, input :: restart_app_server_message) :: ExAws.Request.Query.success_t | no_return
Same as restart_app_server/2
but raise on error.
Specs:
- retrieve_environment_info(client :: ExAws.ElasticBeanstalk.t, input :: retrieve_environment_info_message) :: ExAws.Request.Query.response_t
RetrieveEnvironmentInfo
Retrieves the compiled information from a RequestEnvironmentInfo
request.
Related Topics
RequestEnvironmentInfo
Specs:
- retrieve_environment_info!(client :: ExAws.ElasticBeanstalk.t, input :: retrieve_environment_info_message) :: ExAws.Request.Query.success_t | no_return
Same as retrieve_environment_info/2
but raise on error.
Specs:
- swap_environment_cnam_es(client :: ExAws.ElasticBeanstalk.t, input :: swap_environment_cnam_es_message) :: ExAws.Request.Query.response_t
SwapEnvironmentCNAMEs
Swaps the CNAMEs of two environments.
Specs:
- swap_environment_cnam_es!(client :: ExAws.ElasticBeanstalk.t, input :: swap_environment_cnam_es_message) :: ExAws.Request.Query.success_t | no_return
Same as swap_environment_cnam_es/2
but raise on error.
Specs:
- terminate_environment(client :: ExAws.ElasticBeanstalk.t, input :: terminate_environment_message) :: ExAws.Request.Query.response_t
TerminateEnvironment
Terminates the specified environment.
Specs:
- terminate_environment!(client :: ExAws.ElasticBeanstalk.t, input :: terminate_environment_message) :: ExAws.Request.Query.success_t | no_return
Same as terminate_environment/2
but raise on error.
Specs:
- update_application(client :: ExAws.ElasticBeanstalk.t, input :: update_application_message) :: ExAws.Request.Query.response_t
UpdateApplication
Updates the specified application to have the specified properties.
Note: If a property (for example, description
) is not provided, the value
remains unchanged. To clear these properties, specify an empty string.
Specs:
- update_application!(client :: ExAws.ElasticBeanstalk.t, input :: update_application_message) :: ExAws.Request.Query.success_t | no_return
Same as update_application/2
but raise on error.
Specs:
- update_application_version(client :: ExAws.ElasticBeanstalk.t, input :: update_application_version_message) :: ExAws.Request.Query.response_t
UpdateApplicationVersion
Updates the specified application version to have the specified properties.
Note: If a property (for example, description
) is not provided, the value
remains unchanged. To clear properties, specify an empty string.
Specs:
- update_application_version!(client :: ExAws.ElasticBeanstalk.t, input :: update_application_version_message) :: ExAws.Request.Query.success_t | no_return
Same as update_application_version/2
but raise on error.
Specs:
- update_configuration_template(client :: ExAws.ElasticBeanstalk.t, input :: update_configuration_template_message) :: ExAws.Request.Query.response_t
UpdateConfigurationTemplate
Updates the specified configuration template to have the specified properties or configuration option values.
Note: If a property (for example, ApplicationName
) is not provided, its
value remains unchanged. To clear such properties, specify an empty string.
Related Topics
DescribeConfigurationOptions
Specs:
- update_configuration_template!(client :: ExAws.ElasticBeanstalk.t, input :: update_configuration_template_message) :: ExAws.Request.Query.success_t | no_return
Same as update_configuration_template/2
but raise on error.
Specs:
- update_environment(client :: ExAws.ElasticBeanstalk.t, input :: update_environment_message) :: ExAws.Request.Query.response_t
UpdateEnvironment
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and
AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
When updating the configuration settings to a new template or individual
settings, a draft configuration is created and
DescribeConfigurationSettings
for this environment returns two setting
descriptions with different DeploymentStatus
values.
Specs:
- update_environment!(client :: ExAws.ElasticBeanstalk.t, input :: update_environment_message) :: ExAws.Request.Query.success_t | no_return
Same as update_environment/2
but raise on error.
Specs:
- validate_configuration_settings(client :: ExAws.ElasticBeanstalk.t, input :: validate_configuration_settings_message) :: ExAws.Request.Query.response_t
ValidateConfigurationSettings
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
Specs:
- validate_configuration_settings!(client :: ExAws.ElasticBeanstalk.t, input :: validate_configuration_settings_message) :: ExAws.Request.Query.success_t | no_return
Same as validate_configuration_settings/2
but raise on error.