Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Elastic Beanstalk can respond with.

Structs

ApplicationDescription

Describes the properties of an application.

ApplicationMetrics

Application request metrics for an AWS Elastic Beanstalk environment.

ApplicationResourceLifecycleConfig

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

ApplicationVersionDescription

Describes the properties of an application version.

ApplicationVersionLifecycleConfig

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

AutoScalingGroup

Describes an Auto Scaling launch configuration.

BuildConfiguration

Settings for an AWS CodeBuild build.

Builder

The builder used to build the custom platform.

ConfigurationOptionDescription

Describes the possible values for a configuration option.

ConfigurationOptionSetting

A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.

ConfigurationSettingsDescription

Describes the settings for a configuration set.

CpuUtilization

CPU utilization metrics for an instance.

CustomAmi

A custom AMI available to platforms.

Deployment

Information about an application version deployment.

EnvironmentDescription

Describes the properties of an environment.

EnvironmentInfoDescription

The information retrieved from the Amazon EC2 instances.

EnvironmentLink

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.

EnvironmentResourceDescription

Describes the AWS resources in use by this environment. This data is live.

EnvironmentResourcesDescription

Describes the AWS resources in use by this environment. This data is not live data.

EnvironmentTier

Describes the properties of an environment tier

EventDescription

Describes an event.

Instance

The description of an Amazon EC2 instance.

InstanceHealthSummary

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

Latency

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

LaunchConfiguration

Describes an Auto Scaling launch configuration.

LaunchTemplate

Describes an Amazon EC2 launch template.

Listener

Describes the properties of a Listener for the LoadBalancer.

LoadBalancer

Describes a LoadBalancer.

LoadBalancerDescription

Describes the details of a LoadBalancer.

ManagedAction

The record of an upcoming or in-progress managed action.

ManagedActionHistoryItem

The record of a completed or failed managed action.

MaxAgeRule

A lifecycle rule that deletes application versions after the specified number of days.

MaxCountRule

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

OptionRestrictionRegex

A regular expression representing a restriction on a string configuration option value.

OptionSpecification

A specification identifying an individual configuration option.

PlatformBranchSummary

Summary information about a platform branch.

PlatformDescription

Detailed information about a platform version.

PlatformFilter

Describes criteria to restrict the results when listing platform versions.

The filter is evaluated as follows: Type Operator Values\[1\]

PlatformFramework

A framework supported by the platform.

PlatformProgrammingLanguage

A programming language supported by the platform.

PlatformSummary

Summary information about a platform version.

Queue

Describes a queue.

ResourceQuota

The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.

ResourceQuotas

A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.

S3Location

The bucket and key of an item stored in Amazon S3.

SearchFilter

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values\[1\]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values\[1\]) OR (Attribute Operator Values\[2\]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

SingleInstanceHealth

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

SolutionStackDescription

Describes the solution stack.

SourceBuildInformation

Location of the source code for an application version.

SourceConfiguration

A specification for an environment configuration.

StatusCodes

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.

SystemStatus

CPU utilization and load average metrics for an Amazon EC2 instance.

Tag

Describes a tag applied to a resource in an environment.

Trigger

Describes a trigger.

ValidationMessage

An error or warning for a desired configuration option value.

Enums

ActionHistoryStatus

When writing a match expression against ActionHistoryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ActionStatus

When writing a match expression against ActionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ActionType

When writing a match expression against ActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ApplicationVersionStatus

When writing a match expression against ApplicationVersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ComputeType

When writing a match expression against ComputeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConfigurationDeploymentStatus

When writing a match expression against ConfigurationDeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConfigurationOptionValueType

When writing a match expression against ConfigurationOptionValueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnvironmentHealth

When writing a match expression against EnvironmentHealth, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnvironmentHealthAttribute

When writing a match expression against EnvironmentHealthAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnvironmentHealthStatus

When writing a match expression against EnvironmentHealthStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnvironmentInfoType

When writing a match expression against EnvironmentInfoType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnvironmentStatus

When writing a match expression against EnvironmentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventSeverity

When writing a match expression against EventSeverity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FailureType

When writing a match expression against FailureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InstancesHealthAttribute

When writing a match expression against InstancesHealthAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PlatformStatus

When writing a match expression against PlatformStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SourceRepository

When writing a match expression against SourceRepository, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SourceType

When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ValidationSeverity

When writing a match expression against ValidationSeverity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.