Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494316322.1 KB

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.

get/#Action=UpdateEnvironment

Query parameters

ApplicationNamestring

The name of the application with which the environment is associated.

EnvironmentIdstring
<p>The ID of the environment to update.</p> <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error.</p> <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
EnvironmentNamestring
<p>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
GroupNamestring

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest (env.yaml)</a> for details.

Descriptionstring

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Namestring
<p>The name of this environment tier.</p> <p>Valid values:</p> <ul> <li> <p>For <i>Web server tier</i> – <code>WebServer</code> </p> </li> <li> <p>For <i>Worker tier</i> – <code>Worker</code> </p> </li> </ul>
Typestring
<p>The type of this environment tier.</p> <p>Valid values:</p> <ul> <li> <p>For <i>Web server tier</i> – <code>Standard</code> </p> </li> <li> <p>For <i>Worker tier</i> – <code>SQS/HTTP</code> </p> </li> </ul>
Versionstring
<p>The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.</p> <note> <p>This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.</p> </note>
<p>This specifies the tier to use to update the environment.</p> <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error. </p>
VersionLabelstring

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 <code>InvalidParameterValue</code> error.

TemplateNamestring

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 <code>InvalidParameterValue</code> error.

SolutionStackNamestring

This specifies the platform version that the environment will run after the environment is updated.

PlatformArnstring

The ARN of the platform, if used.

ResourceNamestring

A unique resource name for the option setting. Use it for a time–based scaling configuration option.

Namespacestring

A unique namespace that identifies the option's associated AWS resource.

OptionNamestring

The name of the configuration option.

Valuestring

The current value for the configuration 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.

ResourceNamestring

A unique resource name for a time-based scaling configuration option.

Namespacestring

A unique namespace identifying the option's associated AWS resource.

OptionNamestring

The name of the configuration option.

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Action'UpdateEnvironment' required
Version'2010-12-01' required

Response

Success