# AWS Elastic Beanstalk API Reference

> Get formal descriptions of all the API operations for AWS Elastic Beanstalk. In addition, find sample requests, responses, and errors for the supported web services protocols.

- [Welcome](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Operations.md)

- [AbortEnvironmentUpdate](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_AbortEnvironmentUpdate.md): Cancels in-progress environment configuration update or application version deployment.
- [ApplyEnvironmentManagedAction](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplyEnvironmentManagedAction.md): Applies a scheduled managed action immediately.
- [AssociateEnvironmentOperationsRole](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_AssociateEnvironmentOperationsRole.md)
- [CheckDNSAvailability](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CheckDNSAvailability.md): Checks if the specified CNAME is available.
- [ComposeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ComposeEnvironments.md): Create or update a group of environments that each run a separate component of a single application.
- [CreateApplication](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateApplication.md): Creates an application that has one configuration template named default and no application versions.
- [CreateApplicationVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateApplicationVersion.md): Creates an application version for the specified application.
- [CreateConfigurationTemplate](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateConfigurationTemplate.md): Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.
- [CreateEnvironment](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateEnvironment.md): Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
- [CreatePlatformVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreatePlatformVersion.md): Create a new version of your custom platform.
- [CreateStorageLocation](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateStorageLocation.md): Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.
- [DeleteApplication](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DeleteApplication.md): Deletes the specified application along with all associated versions and configurations.
- [DeleteApplicationVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DeleteApplicationVersion.md): Deletes the specified version from the specified application.
- [DeleteConfigurationTemplate](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DeleteConfigurationTemplate.md): Deletes the specified configuration template.
- [DeleteEnvironmentConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DeleteEnvironmentConfiguration.md): Deletes the draft configuration associated with the running environment.
- [DeletePlatformVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DeletePlatformVersion.md): Deletes the specified version of a custom platform.
- [DescribeAccountAttributes](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeAccountAttributes.md): Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
- [DescribeApplications](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeApplications.md): Returns the descriptions of existing applications.
- [DescribeApplicationVersions](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeApplicationVersions.md): Retrieve a list of application versions.
- [DescribeConfigurationOptions](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeConfigurationOptions.md): Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
- [DescribeConfigurationSettings](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeConfigurationSettings.md): 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.
- [DescribeEnvironmentHealth](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironmentHealth.md): Returns information about the overall health of the specified environment.
- [DescribeEnvironmentManagedActionHistory](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironmentManagedActionHistory.md): Lists an environment's completed and failed managed actions.
- [DescribeEnvironmentManagedActions](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironmentManagedActions.md): Lists an environment's upcoming and in-progress managed actions.
- [DescribeEnvironmentResources](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironmentResources.md): Returns AWS resources for this environment.
- [DescribeEnvironments](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.md): Returns descriptions for existing environments.
- [DescribeEvents](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEvents.md): Returns list of event descriptions matching criteria up to the last 6 weeks.
- [DescribeInstancesHealth](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeInstancesHealth.md): Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk environments.
- [DescribePlatformVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribePlatformVersion.md): Describes a platform version.
- [DisassociateEnvironmentOperationsRole](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DisassociateEnvironmentOperationsRole.md)
- [ListAvailableSolutionStacks](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.md): Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
- [ListPlatformBranches](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListPlatformBranches.md): Lists the platform branches available for your account in an AWS Region.
- [ListPlatformVersions](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListPlatformVersions.md): Lists the platform versions available for your account in an AWS Region.
- [ListTagsForResource](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListTagsForResource.md): Return the tags applied to an AWS Elastic Beanstalk resource.
- [RebuildEnvironment](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_RebuildEnvironment.md): 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.
- [RequestEnvironmentInfo](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_RequestEnvironmentInfo.md): Initiates a request to compile the specified type of information of the deployed environment.
- [RestartAppServer](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_RestartAppServer.md): Causes the environment to restart the application container server running on each Amazon EC2 instance.
- [RetrieveEnvironmentInfo](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_RetrieveEnvironmentInfo.md): Retrieves the compiled information from a RequestEnvironmentInfo request.
- [SwapEnvironmentCNAMEs](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SwapEnvironmentCNAMEs.md): Swaps the CNAMEs of two environments.
- [TerminateEnvironment](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_TerminateEnvironment.md): Terminates the specified environment.
- [UpdateApplication](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateApplication.md): Updates the specified application to have the specified properties.
- [UpdateApplicationResourceLifecycle](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateApplicationResourceLifecycle.md): Modifies lifecycle settings for an application.
- [UpdateApplicationVersion](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateApplicationVersion.md): Updates the specified application version to have the specified properties.
- [UpdateConfigurationTemplate](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateConfigurationTemplate.md): Updates the specified configuration template to have the specified properties or configuration option values.
- [UpdateEnvironment](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateEnvironment.md): 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.
- [UpdateTagsForResource](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateTagsForResource.md): Update the list of tags applied to an AWS Elastic Beanstalk resource.
- [ValidateConfigurationSettings](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ValidateConfigurationSettings.md): Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.


## [Data Types](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Types.md)

- [ApplicationDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationDescription.md): Describes the properties of an application.
- [ApplicationMetrics](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationMetrics.md): Application request metrics for an AWS Elastic Beanstalk environment.
- [ApplicationResourceLifecycleConfig](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationResourceLifecycleConfig.md): The resource lifecycle configuration for an application.
- [ApplicationVersionDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationVersionDescription.md): Describes the properties of an application version.
- [ApplicationVersionLifecycleConfig](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationVersionLifecycleConfig.md): The application version lifecycle settings for an application.
- [AutoScalingGroup](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_AutoScalingGroup.md): Describes an Auto Scaling launch configuration.
- [BuildConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_BuildConfiguration.md): Settings for an AWS CodeBuild build.
- [Builder](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Builder.md): The builder used to build the custom platform.
- [Cluster](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Cluster.md): Describes the Amazon EKS cluster that an environment runs on.
- [ConfigurationOptionDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ConfigurationOptionDescription.md): Describes the possible values for a configuration option.
- [ConfigurationOptionSetting](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ConfigurationOptionSetting.md): A specification identifying an individual configuration option along with its current value.
- [ConfigurationSettingsDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ConfigurationSettingsDescription.md): Describes the settings for a configuration set.
- [CPUUtilization](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CPUUtilization.md): CPU utilization metrics for an instance.
- [CustomAmi](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CustomAmi.md): A custom AMI available to platforms.
- [Deployment](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Deployment.md): Information about an application version deployment.
- [EnvironmentDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentDescription.md): Describes the properties of an environment.
- [EnvironmentInfoDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentInfoDescription.md): The information retrieved from the Amazon EC2 instances.
- [EnvironmentLink](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentLink.md): A link to another environment, defined in the environment's manifest.
- [EnvironmentResourceDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentResourceDescription.md): Describes the AWS resources in use by this environment.
- [EnvironmentResourcesDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentResourcesDescription.md): Describes the AWS resources in use by this environment.
- [EnvironmentTier](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EnvironmentTier.md): Describes the properties of an environment tier
- [EventDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_EventDescription.md): Describes an event.
- [ImageBuildConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ImageBuildConfiguration.md): Settings that Elastic Beanstalk uses to build a container image from the source bundle of an application version.
- [ImageConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ImageConfiguration.md): The source of the container image for an application version: an image that you built and pushed to a container registry yourself, or settings for Elastic Beanstalk to build one from your source bundle.
- [ImageSource](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ImageSource.md): The location of a container image.
- [Instance](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Instance.md): The description of an Amazon EC2 instance.
- [InstanceHealthSummary](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_InstanceHealthSummary.md): Represents summary information about the health of an instance.
- [Latency](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Latency.md): Represents the average latency for the slowest X percent of requests over the last 10 seconds.
- [LaunchConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_LaunchConfiguration.md): Describes an Auto Scaling launch configuration.
- [LaunchTemplate](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_LaunchTemplate.md): Describes an Amazon EC2 launch template.
- [Listener](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Listener.md): Describes the properties of a Listener for the LoadBalancer.
- [LoadBalancer](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_LoadBalancer.md): Describes a LoadBalancer.
- [LoadBalancerDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_LoadBalancerDescription.md): Describes the details of a LoadBalancer.
- [ManagedAction](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ManagedAction.md): The record of an upcoming or in-progress managed action.
- [ManagedActionHistoryItem](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ManagedActionHistoryItem.md): The record of a completed or failed managed action.
- [MaxAgeRule](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_MaxAgeRule.md): A lifecycle rule that deletes application versions after the specified number of days.
- [MaxCountRule](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_MaxCountRule.md): A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.
- [OptionRestrictionRegex](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_OptionRestrictionRegex.md): A regular expression representing a restriction on a string configuration option value.
- [OptionSpecification](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_OptionSpecification.md): A specification identifying an individual configuration option.
- [PlatformBranchSummary](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformBranchSummary.md): Summary information about a platform branch.
- [PlatformDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformDescription.md): Detailed information about a platform version.
- [PlatformFilter](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformFilter.md): Describes criteria to restrict the results when listing platform versions.
- [PlatformFramework](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformFramework.md): A framework supported by the platform.
- [PlatformProgrammingLanguage](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformProgrammingLanguage.md): A programming language supported by the platform.
- [PlatformSummary](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_PlatformSummary.md): Summary information about a platform version.
- [Queue](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Queue.md): Describes a queue.
- [ResourceQuota](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ResourceQuota.md): The AWS Elastic Beanstalk quota information for a single resource type in an AWS account.
- [ResourceQuotas](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ResourceQuotas.md): A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account.
- [S3Location](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_S3Location.md): The bucket and key of an item stored in Amazon S3.
- [SearchFilter](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SearchFilter.md): Describes criteria to restrict a list of results.
- [SingleInstanceHealth](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SingleInstanceHealth.md): Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.
- [SolutionStackDescription](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SolutionStackDescription.md): Describes the solution stack.
- [SourceBuildInformation](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SourceBuildInformation.md): Location of the source code for an application version.
- [SourceConfiguration](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SourceConfiguration.md): A specification for an environment configuration.
- [StatusCodes](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_StatusCodes.md): Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
- [SystemStatus](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_SystemStatus.md): CPU utilization and load average metrics for an Amazon EC2 instance.
- [Tag](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Tag.md): Describes a tag applied to a resource in an environment.
- [Trigger](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_Trigger.md): Describes a trigger.
- [ValidationMessage](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ValidationMessage.md): An error or warning for a desired configuration option value.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/full.md)