AWS.ElasticBeanstalk (aws-elixir v0.8.0) View Source

AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is https://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.

Link to this section Summary

Functions

Cancels in-progress environment configuration update or application version deployment.

Applies a scheduled managed action immediately.

Add or change the operations role used by an environment.

Checks if the specified CNAME is available.

Create or update a group of environments that each run a separate component of a single application.

Creates an application that has one configuration template named default and no application versions.

Creates an application version for the specified application.

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Create a new version of your custom platform.

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.

Deletes the specified application along with all associated versions and configurations.

Deletes the specified version from the specified application.

Deletes the specified configuration template.

Deletes the draft configuration associated with the running environment.

Deletes the specified version of a custom platform.

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

Retrieve a list of application versions.

Returns the descriptions of existing applications.

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.

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.

Returns information about the overall health of the specified environment.

Lists an environment's completed and failed managed actions.

Lists an environment's upcoming and in-progress managed actions.

Returns AWS resources for this environment.

Returns descriptions for existing environments.

Returns list of event descriptions matching criteria up to the last 6 weeks.

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.

Disassociate the operations role from an environment.

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Lists the platform branches available for your account in an AWS Region.

Lists the platform versions available for your account in an AWS Region.

Return the tags applied to an AWS Elastic Beanstalk resource.

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.

Initiates a request to compile the specified type of information of the deployed environment.

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Retrieves the compiled information from a RequestEnvironmentInfo request.

Swaps the CNAMEs of two environments.

Terminates the specified environment.

Updates the specified application to have the specified properties.

Modifies lifecycle settings for an application.

Updates the specified application version to have the specified properties.

Updates the specified configuration template to have the specified properties or configuration option values.

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.

Update the list of tags applied to an AWS Elastic Beanstalk resource.

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

Link to this section Functions

Link to this function

abort_environment_update(client, input, options \\ [])

View Source

Cancels in-progress environment configuration update or application version deployment.

Link to this function

apply_environment_managed_action(client, input, options \\ [])

View Source

Applies a scheduled managed action immediately.

A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

Link to this function

associate_environment_operations_role(client, input, options \\ [])

View Source

Add or change the operations role used by an environment.

After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Link to this function

check_dns_availability(client, input, options \\ [])

View Source

Checks if the specified CNAME is available.

Link to this function

compose_environments(client, input, options \\ [])

View Source

Create or update a group of environments that each run a separate component of a single application.

Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

Link to this function

create_application(client, input, options \\ [])

View Source

Creates an application that has one configuration template named default and no application versions.

Link to this function

create_application_version(client, input, options \\ [])

View Source

Creates an application version for the specified application.

You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

After you create an application version with a specified Amazon S3 bucket and key location, you can't 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.

Link to this function

create_configuration_template(client, input, options \\ [])

View Source

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.

You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null.

Related Topics

  • DescribeConfigurationOptions

  • DescribeConfigurationSettings

  • ListAvailableSolutionStacks

Link to this function

create_environment(client, input, options \\ [])

View Source

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Link to this function

create_platform_version(client, input, options \\ [])

View Source

Create a new version of your custom platform.

Link to this function

create_storage_location(client, input, options \\ [])

View Source

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.

The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

Link to this function

delete_application(client, input, options \\ [])

View Source

Deletes the specified application along with all associated versions and configurations.

The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

Link to this function

delete_application_version(client, input, options \\ [])

View Source

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

Link to this function

delete_configuration_template(client, input, options \\ [])

View Source

Deletes the specified configuration template.

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.

Link to this function

delete_environment_configuration(client, input, options \\ [])

View Source

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.

Link to this function

delete_platform_version(client, input, options \\ [])

View Source

Deletes the specified version of a custom platform.

Link to this function

describe_account_attributes(client, input, options \\ [])

View Source

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

Link to this function

describe_application_versions(client, input, options \\ [])

View Source

Retrieve a list of application versions.

Link to this function

describe_applications(client, input, options \\ [])

View Source

Returns the descriptions of existing applications.

Link to this function

describe_configuration_options(client, input, options \\ [])

View Source

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.

Link to this function

describe_configuration_settings(client, input, options \\ [])

View Source

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
Link to this function

describe_environment_health(client, input, options \\ [])

View Source

Returns information about the overall health of the specified environment.

The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Link to this function

describe_environment_managed_action_history(client, input, options \\ [])

View Source

Lists an environment's completed and failed managed actions.

Link to this function

describe_environment_managed_actions(client, input, options \\ [])

View Source

Lists an environment's upcoming and in-progress managed actions.

Link to this function

describe_environment_resources(client, input, options \\ [])

View Source

Returns AWS resources for this environment.

Link to this function

describe_environments(client, input, options \\ [])

View Source

Returns descriptions for existing environments.

Link to this function

describe_events(client, input, options \\ [])

View Source

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Link to this function

describe_instances_health(client, input, options \\ [])

View Source

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.

This operation requires enhanced health reporting.

Link to this function

describe_platform_version(client, input, options \\ [])

View Source

Describes a platform version.

Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Link to this function

disassociate_environment_operations_role(client, input, options \\ [])

View Source

Disassociate the operations role from an environment.

After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Link to this function

list_available_solution_stacks(client, input, options \\ [])

View Source

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Link to this function

list_platform_branches(client, input, options \\ [])

View Source

Lists the platform branches available for your account in an AWS Region.

Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Link to this function

list_platform_versions(client, input, options \\ [])

View Source

Lists the platform versions available for your account in an AWS Region.

Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Return the tags applied to an AWS Elastic Beanstalk resource.

The response contains a list of tag key-value pairs.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

Link to this function

rebuild_environment(client, input, options \\ [])

View Source

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.

Link to this function

request_environment_info(client, input, options \\ [])

View Source

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
Link to this function

restart_app_server(client, input, options \\ [])

View Source

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Link to this function

retrieve_environment_info(client, input, options \\ [])

View Source

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

  • RequestEnvironmentInfo
Link to this function

swap_environment_cnames(client, input, options \\ [])

View Source

Swaps the CNAMEs of two environments.

Link to this function

terminate_environment(client, input, options \\ [])

View Source

Terminates the specified environment.

Link to this function

update_application(client, input, options \\ [])

View Source

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Link to this function

update_application_resource_lifecycle(client, input, options \\ [])

View Source

Modifies lifecycle settings for an application.

Link to this function

update_application_version(client, input, options \\ [])

View Source

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Link to this function

update_configuration_template(client, input, options \\ [])

View Source

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

  • DescribeConfigurationOptions
Link to this function

update_environment(client, input, options \\ [])

View Source

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.

Link to this function

update_tags_for_resource(client, input, options \\ [])

View Source

Update the list of tags applied to an AWS Elastic Beanstalk resource.

Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

Definitions

elasticbeanstalk:AddTags

Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

elasticbeanstalk:RemoveTags

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy.

Link to this function

validate_configuration_settings(client, input, options \\ [])

View Source

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.