If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

This parameter contains a list of ApplicationDescription.

The response's http status code.

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.

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

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

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.

The ARN of the platform, if used.

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.

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.

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

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

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.

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.

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

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.

The URL to the CNAME for this environment.

The name of the configuration template used to originally launch this environment.

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.

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

The description of the AWS resources used by this environment.

The last modified date for this environment.

The creation date for this environment.

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

The application version deployed in this environment.

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

The ARN of the platform version.

Describes the current tier of this environment.

The name of this environment.

The name of the application associated with this environment.

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

The name of the SolutionStack deployed with this environment.

The ID of this environment.

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

A list of links to other environments in the same group.

Describes this environment.

Terminates the target environment even if another environment in the same group is dependent on it.

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

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.

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.

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.

The URL to the CNAME for this environment.

The name of the configuration template used to originally launch this environment.

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.

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

The description of the AWS resources used by this environment.

The last modified date for this environment.

The creation date for this environment.

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

The application version deployed in this environment.

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

The ARN of the platform version.

Describes the current tier of this environment.

The name of this environment.

The name of the application associated with this environment.

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

The name of the SolutionStack deployed with this environment.

The ID of this environment.

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

A list of links to other environments in the same group.

Describes this environment.

Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.

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.

The maximum number of platform version values returned in one call.

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.

Summary information about the platform versions.

The response's http status code.

The ARN of the version of the custom platform.

Detailed information about the version of the custom platform.

The response's http status code.

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.

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.

Set to true to create an application with the specified name if it doesn't already exist.

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.

A description of this application version.

Settings for an AWS CodeBuild build.

Specifies the tags applied to the application version.

Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

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.

The ApplicationVersionDescription of the application version.

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_in

• Attribute = LifecycleState:

  • Operator: = | != | in | not_in
  • Values: beta | supported | deprecated | retired

• Attribute = PlatformName:

  • Operator: = | != | begins_with | ends_with | contains | in | not_in

• Attribute = TierType:

  • Operator: = | !=
  • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

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.

The maximum number of platform branch values returned in one call.

Summary information about the platform branches.

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.

The response's http status code.

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Pagination token. If specified, the events return the next batch of results.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Specifies the maximum number of events that can be returned, beginning with the most recent event.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

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.

A list of EventDescription.

The response's http status code.

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.

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.

The type of information to request.

The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.

Must be the ARN of an Elastic Beanstalk resource.

A list of tag key-value pairs.

The Amazon Resource Name (ARN) of the resource for which a tag list was requested.

The response's http status code.

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.

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.

The type of information to retrieve.

The EnvironmentInfoDescription of the environment.

The response's http status code.

The ARN of the platform version.

Detailed information about the platform version.

The response's http status code.

When set to true, running environments will be terminated before deleting the application.

The name of the application to delete.

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

The ApplicationDescription of the application.

Specify the pagination token returned by a previous call.

Specify the AWS Elastic Beanstalk environment by name.

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.

Specify the AWS Elastic Beanstalk environment by ID.

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 <CPUUtilization> type.

Pagination token for the next page of results, if available.

The date and time that the health information was retrieved.

The response's http status code.

Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

Your description of the application.

Specifies the tags applied to the application.

Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.

The name of the application. Must be unique within your account.

The ApplicationDescription of the application.

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.

The name of the application to which the specified source bundles belong.

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.

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns an EnvironmentDescription list.

This specifies the name of the environment with the in-progress update that you want to cancel.

This specifies the ID of the environment with the in-progress update that you want to cancel.

The name of the application to delete the configuration template from.

The name of the configuration template to delete.

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

A list of configuration option settings to update with the new specified option value.

A new description for the configuration.

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 name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

If not null, the name of the configuration template for this configuration set.

A list of the configuration options and their values in this configuration set.

The date (in UTC time) when this configuration set was last modified.

The date (in UTC time) when this configuration set was created.

The ARN of the platform version.

If not null, the name of the environment for this configuration set.

The name of the application associated with this configuration set.

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.

The name of the solution stack this configuration set uses.

Describes this configuration set.

A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.

Specify at least one of these parameters: TagsToAdd, TagsToRemove.

A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.

Specify at least one of these parameters: TagsToAdd, TagsToRemove.

The Amazon Resource Name (ARN) of the resouce to be updated.

Must be the ARN of an Elastic Beanstalk resource.

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.

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.

A list of EnvironmentResourceDescription.

The response's http status code.

The pagination token returned by a previous request.

The name of the target environment.

The maximum number of items to return for a single request.

The environment ID of the target environment.

A list of completed and failed managed actions.

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

The response's http status code.

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.

The name of the application to which the version belongs.

The label of the version to delete.

A new description for this version.

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

The ApplicationVersionDescription of the application version.

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.

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.

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.

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.

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.

An optional description for this configuration.

Specifies the tags applied to the configuration template.

The name of the Elastic Beanstalk application to associate with this configuration template.

The name of the configuration template.

Constraint: This name must be unique per application.

If not null, the name of the configuration template for this configuration set.

A list of the configuration options and their values in this configuration set.

The date (in UTC time) when this configuration set was last modified.

The date (in UTC time) when this configuration set was created.

The ARN of the platform version.

If not null, the name of the environment for this configuration set.

The name of the application associated with this configuration set.

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.

The name of the solution stack this configuration set uses.

Describes this configuration set.

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

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.

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

Descriptions of the data that contributed to the environment's current health status.

Application request metrics for the environment.

The health color of the environment.

The environment's name.

The health status of the environment. For example, Ok.

Summary health information for the instances in the environment.

The date and time that the health information was retrieved.

The response's http status code.

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.

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.

The name of the application the environment is associated with.

The name of the environment to delete the draft configuration from.

The name of the application.

The lifecycle configuration.

The name of the application.

The lifecycle configuration.

The response's http status code.

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.

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.

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.

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.

A list of available solution stacks.

A list of available solution stacks and their SolutionStackDescription.

The response's http status code.

The name of the target environment.

The environment ID of the target environment.

The action ID of the scheduled managed action to execute.

The status of the managed action.

The action ID of the managed action.

A description of the managed action.

The type of managed action.

The response's http status code.

The name of the configuration template whose configuration options you want to describe.

The ARN of the custom platform.

The name of the environment whose configuration options you want to describe.

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.

The name of the solution stack whose configuration options you want to describe.

If specified, restricts the descriptions to only the specified options.

The ARN of the platform version.

The name of the solution stack these configuration options belong to.

A list of ConfigurationOptionDescription.

The response's http status code.

The name of the environment from which to disassociate the operations role.

The name of the Amazon S3 bucket created.

The response's http status code.

To show only actions with a particular status, specify a status.

The name of the target environment.

The environment ID of the target environment.

A list of upcoming and in-progress managed actions.

The response's http status code.

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.

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.

The application for the environment or configuration template.

A list of ConfigurationSettingsDescription.

The response's http status code.

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

The name of the application that the configuration template or environment belongs to.

A list of the options and desired values to evaluate.

A list of ValidationMessage.

The response's http status code.

The Elastic Beanstalk resource quotas associated with the calling AWS account.

The response's http status code.

The name of the environment to which to set the operations role.

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

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.

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.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

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.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

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.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns an EnvironmentDescription list.

The prefix used when this CNAME is reserved.

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Indicates if the specified CNAME is available:

• true : The CNAME is available.
• false : The CNAME is not available.

The response's http status code.

Specify a version label to show a specific application version.

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.

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.

Specify an application name to show only application versions for that application.

List of ApplicationVersionDescription objects sorted in order of creation.

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

The response's http status code.

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.

The name of the Elastic Beanstalk configuration template to use with the environment.

If you specify TemplateName, then don't specify SolutionStackName.

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

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.

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

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.

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.

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.

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.

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.

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.

Your description for this environment.

Specifies the tags applied to resources in the environment.

The name of the application that is associated with this environment.

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.

The URL to the CNAME for this environment.

The name of the configuration template used to originally launch this environment.

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.

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

The description of the AWS resources used by this environment.

The last modified date for this environment.

The creation date for this environment.

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

The application version deployed in this environment.

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

The ARN of the platform version.

Describes the current tier of this environment.

The name of this environment.

The name of the application associated with this environment.

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

The name of the SolutionStack deployed with this environment.

The ID of this environment.

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

A list of links to other environments in the same group.

Describes this environment.

The configuration option settings to apply to the builder environment.

The name of the builder environment.

Specifies the tags applied to the new platform version.

Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

The name of your custom platform.

The number, such as 1.0.2, for the new platform version.

The location of the platform definition archive in Amazon S3.

The builder used to create the custom platform.

Detailed information about the new version of the custom platform.

The response's http status code.

The Amazon Resource Name (ARN) of the application.

The names of the versions for this application.

The date when the application was last modified.

The date when the application was created.

The name of the application.

The names of the configuration templates associated with this application.

The lifecycle settings for the application.

User-defined description of the application.

The ApplicationDescription of the application.