String applicationName
The name of the application.
String description
User-defined description of the application.
Date dateCreated
The date when the application was created.
Date dateUpdated
The date when the application was last modified.
com.amazonaws.internal.SdkInternalList<T> versions
The names of the versions for this application.
com.amazonaws.internal.SdkInternalList<T> configurationTemplates
The names of the configuration templates associated with this application.
Integer duration
The amount of time that the metrics cover (usually 10 seconds). For
example, you might have 5 requests (request_count
) within
the most recent time slice of 10 seconds (duration
).
Integer requestCount
Average number of requests handled by the web server per second over the last 10 seconds.
StatusCodes statusCodes
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
Latency latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one milisecond resolution.
String applicationName
The name of the application associated with this release.
String description
The description of this application version.
String versionLabel
A label uniquely identifying the version for the associated application.
S3Location sourceBundle
The location where the source bundle is located for this version.
Date dateCreated
The creation date of the application version.
Date dateUpdated
The last modified date of the application version.
String name
The name of the AutoScalingGroup
.
String cNAMEPrefix
The prefix used when this CNAME is reserved.
Boolean available
Indicates if the specified CNAME is available:
true
: The CNAME is available.
true
: The CNAME is not available.
true
: The CNAME is available.false
: The CNAME is not available.String fullyQualifiedCNAME
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
String namespace
A unique namespace identifying the option's associated AWS resource.
String name
The name of the configuration option.
String defaultValue
The default value for this configuration option.
String changeSeverity
An indication of which action is required if the value for this configuration option changes:
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption
: There is no interruption to the
environment or application availability.RestartEnvironment
: The environment is entirely
restarted, all AWS resources are deleted and recreated, and the
environment is unavailable during the process.RestartApplicationServer
: The environment is available
the entire time. However, a short application outage occurs when the
application servers on the running Amazon EC2 instances are restarted.Boolean userDefined
An indication of whether the user defined this configuration option:
true
: This configuration option was defined by the user. It
is a valid choice for specifying this as an Option to Remove when
updating configuration settings.
false
: This configuration was not defined by the user.
true
: This configuration option was defined by the user. It
is a valid choice for specifying if this as an
Option to Remove
when updating configuration settings.
false
: This configuration was not defined by the user.
Constraint: You can remove only UserDefined
options from a
configuration.
Valid Values: true
| false
String valueType
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar
: Values for this option are a single selection from
the possible values, or a unformatted string or numeric value governed by
the MIN/MAX/Regex constraints:
List
: Values for this option are multiple selections of the
possible values.
Boolean
: Values for this option are either
true
or false
.
Json
: Values for this option are a JSON representation of a
ConfigDocument
.
Scalar
: Values for this option are a single selection
from the possible values, or an unformatted string, or numeric value
governed by the MIN/MAX/Regex
constraints.List
: Values for this option are multiple selections
from the possible values.Boolean
: Values for this option are either
true
or false
.Json
: Values for this option are a JSON representation
of a ConfigDocument
.com.amazonaws.internal.SdkInternalList<T> valueOptions
If specified, values for the configuration option are selected from this list.
Integer minValue
If specified, the configuration option must be a numeric value greater than this value.
Integer maxValue
If specified, the configuration option must be a numeric value less than this value.
Integer maxLength
If specified, the configuration option must be a string value no longer than this value.
OptionRestrictionRegex regex
If specified, the configuration option must be a string value that satisfies this regular expression.
String resourceName
A unique resource name for a time-based scaling configuration option.
String namespace
A unique namespace identifying the option's associated AWS resource.
String optionName
The name of the configuration option.
String value
The current value for the configuration option.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
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.
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.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
Double user
Percentage of time that the CPU has spent in the User
state
over the last 10 seconds.
Double nice
Percentage of time that the CPU has spent in the Nice
state
over the last 10 seconds.
Double system
Percentage of time that the CPU has spent in the System
state over the last 10 seconds.
Double idle
Percentage of time that the CPU has spent in the Idle
state
over the last 10 seconds.
Double iOWait
Percentage of time that the CPU has spent in the I/O Wait
state over the last 10 seconds.
Double iRQ
Percentage of time that the CPU has spent in the IRQ
state
over the last 10 seconds.
Double softIRQ
Percentage of time that the CPU has spent in the SoftIRQ
state over the last 10 seconds.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application. If no application is found with this name,
and AutoCreateApplication
is false
, returns an
InvalidParameterValue
error.
String versionLabel
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.
String description
Describes this version.
S3Location sourceBundle
The Amazon S3 bucket and key that identify the location of the source bundle for this version.
If data found at the Amazon S3 location exceeds the maximum allowed
source bundle size, AWS Elastic Beanstalk returns an
InvalidParameterValue
error. The maximum size allowed is 512
MB.
Default: If not specified, AWS Elastic Beanstalk uses a sample
application. If only partially specified (for example, a bucket is
provided but not the key) or if no data is found at the Amazon S3
location, AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.
Boolean autoCreateApplication
Determines how the system behaves if the specified application for this version does not already exist:
true
: Automatically creates the specified application for
this version if it does not already exist.
false
: Returns an InvalidParameterValue
if the
specified application for this version does not already exist.
true
: Automatically creates the specified application
for this release if it does not already exist.false
: Throws an InvalidParameterValue
if
the specified application for this release does not already exist.
Default: false
Valid Values: true
| false
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the application to associate with this configuration
template. If no application is found with this name, AWS Elastic
Beanstalk returns an InvalidParameterValue
error.
String templateName
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS
Elastic Beanstalk returns an InvalidParameterValue
error.
String solutionStackName
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be
specified, otherwise AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
SourceConfiguration sourceConfiguration
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings
parameter of this
call overrides any values obtained from the
SourceConfiguration
.
If no configuration template is found, returns an
InvalidParameterValue
error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified, the solution stack of the source
configuration template must match the specified solution stack name or
else AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.
String environmentId
The ID of the environment used with this configuration template.
String description
Describes this configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
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.
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.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue
error.
String environmentName
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can
contain only letters, numbers, and hyphens. It cannot start or end with a
hyphen. This name must be unique in your account. If the specified name
already exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
String description
Describes this environment.
String cNAMEPrefix
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
EnvironmentTier tier
This specifies the tier to use for creating this environment.
com.amazonaws.internal.SdkInternalList<T> tags
This specifies the tags applied to resources in the environment.
String versionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS
Elastic Beanstalk UpdateEnvironment
returns an
InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
String templateName
The name of the configuration template to use in deployment. If no
configuration template is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue
error.
Condition: You must specify either this parameter or a
SolutionStackName
, 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.
String solutionStackName
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
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 a
MissingRequiredParameter
error.
com.amazonaws.internal.SdkInternalList<T> optionSettings
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.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.Boolean abortableOperationInProgress
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.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
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
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String s3Bucket
The name of the Amazon S3 bucket created.
String applicationName
The name of the application to delete releases from.
String versionLabel
The label of the version to delete.
Boolean deleteSourceBundle
Indicates whether to delete the associated source bundle from Amazon S3:
true
: An attempt is made to delete the associated Amazon
S3 source bundle specified at time of creation.false
: No action is taken on the Amazon S3 source bundle
specified at time of creation.
Valid Values: true
| false
com.amazonaws.internal.SdkInternalList<T> applicationNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
com.amazonaws.internal.SdkInternalList<T> applications
This parameter contains a list of ApplicationDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.
com.amazonaws.internal.SdkInternalList<T> versionLabels
If specified, restricts the returned descriptions to only include ones that have the specified version labels.
com.amazonaws.internal.SdkInternalList<T> applicationVersions
A list of ApplicationVersionDescription .
String applicationName
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.
String templateName
The name of the configuration template whose configuration options you want to describe.
String environmentName
The name of the environment whose configuration options you want to describe.
String solutionStackName
The name of the solution stack whose configuration options you want to describe.
com.amazonaws.internal.SdkInternalList<T> options
If specified, restricts the descriptions to only the specified options.
String solutionStackName
The name of the solution stack these configuration options belong to.
com.amazonaws.internal.SdkInternalList<T> options
A list of ConfigurationOptionDescription.
String applicationName
The application for the environment or configuration template.
String templateName
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.
String environmentName
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.
com.amazonaws.internal.SdkInternalList<T> configurationSettings
A list of ConfigurationSettingsDescription.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.
String environmentName
The AWS Elastic Beanstalk environment name.
String healthStatus
Contains the response body with information about the health of the environment.
String status
Returns the health status value of the environment. For more information, see Health Colors and Statuses.
String color
Returns the color indicator that tells you information about the health of the environment. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Returns potential causes for the reported status.
ApplicationMetrics applicationMetrics
InstanceHealthSummary instancesHealth
Date refreshedAt
The date and time the information was last refreshed.
String environmentId
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.
String environmentName
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.
EnvironmentResourceDescription environmentResources
A list of EnvironmentResourceDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
com.amazonaws.internal.SdkInternalList<T> environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
com.amazonaws.internal.SdkInternalList<T> environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Boolean includeDeleted
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
Date includedDeletedBackTo
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
com.amazonaws.internal.SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
String templateName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
String environmentId
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String environmentName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String requestId
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
String severity
If specified, limits the events returned from this call to include only those with the specified severity or higher.
Date startTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
Date endTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to those that occur up to, but not including, the EndTime
.
Integer maxRecords
Specifies the maximum number of events that can be returned, beginning with the most recent event.
String nextToken
Pagination token. If specified, the events return the next batch of results.
com.amazonaws.internal.SdkInternalList<T> events
A list of EventDescription.
String nextToken
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.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.
String nextToken
Specifies the next token of the request.
com.amazonaws.internal.SdkInternalList<T> instanceHealthList
Contains the response body with information about the health of the instance.
Date refreshedAt
The date and time the information was last refreshed.
String nextToken
The next token.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.Boolean abortableOperationInProgress
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.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
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
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String environmentName
The name of the environment.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The AutoScalingGroups
used by this environment.
com.amazonaws.internal.SdkInternalList<T> instances
The Amazon EC2 instances used by this environment.
com.amazonaws.internal.SdkInternalList<T> launchConfigurations
The Auto Scaling launch configurations in use by this environment.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
The LoadBalancers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> triggers
The AutoScaling
triggers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> queues
The queues used by this environment.
LoadBalancerDescription loadBalancer
Describes the LoadBalancer.
Date eventDate
The date when the event occurred.
String message
The event message.
String applicationName
The application associated with the event.
String versionLabel
The release label for the application version associated with this event.
String templateName
The name of the configuration associated with this event.
String environmentName
The name of the environment associated with this event.
String requestId
The web service request ID for the activity of this event.
String severity
The severity level of this event.
String id
The ID of the Amazon EC2 instance.
Integer noData
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
Integer unknown
Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
Integer pending
Grey. An operation is in progress on an instance within the command timeout.
Integer ok
Green. An instance is passing health checks and the health agent is not reporting any problems.
Integer info
Green. An operation is in progress on an instance.
Integer warning
Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
Integer degraded
Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
Integer severe
Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
Double p999
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
Double p99
The average latency for the slowest 1 percent of requests over the last 10 seconds.
Double p95
The average latency for the slowest 5 percent of requests over the last 10 seconds.
Double p90
The average latency for the slowest 10 percent of requests over the last 10 seconds.
Double p85
The average latency for the slowest 15 percent of requests over the last 10 seconds.
Double p75
The average latency for the slowest 25 percent of requests over the last 10 seconds.
Double p50
The average latency for the slowest 50 percent of requests over the last 10 seconds.
Double p10
The average latency for the slowest 90 percent of requests over the last 10 seconds.
String name
The name of the launch configuration.
com.amazonaws.internal.SdkInternalList<T> solutionStacks
A list of available solution stacks.
com.amazonaws.internal.SdkInternalList<T> solutionStackDetails
A list of available solution stacks and their SolutionStackDescription.
String name
The name of the LoadBalancer.
String loadBalancerName
The name of the LoadBalancer.
String domain
The domain name of the LoadBalancer.
com.amazonaws.internal.SdkInternalList<T> listeners
A list of Listeners used by the LoadBalancer.
String environmentId
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.
String environmentName
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.
String environmentId
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.
String environmentName
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.
String infoType
The type of information to request.
String environmentId
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.
String environmentName
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.
String environmentId
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.
String environmentName
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.
String infoType
The type of information to retrieve.
com.amazonaws.internal.SdkInternalList<T> environmentInfo
The EnvironmentInfoDescription of the environment.
String instanceId
The ID of the Amazon EC2 instance.
String healthStatus
String color
Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Represents the causes, which provide more information about the current health status.
Date launchedAt
The time at which the EC2 instance was launched.
ApplicationMetrics applicationMetrics
SystemStatus system
String solutionStackName
The name of the solution stack.
com.amazonaws.internal.SdkInternalList<T> permittedFileTypes
The permitted file types allowed for a solution stack.
Integer status2xx
The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
Integer status3xx
The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
Integer status4xx
The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
Integer status5xx
The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
String sourceEnvironmentId
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
.
String sourceEnvironmentName
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
.
String destinationEnvironmentId
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
.
String destinationEnvironmentName
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
.
CPUUtilization cPUUtilization
com.amazonaws.internal.SdkInternalList<T> loadAverage
Load average in the last 1-minute and 5-minute periods. For more information, see Operating System Metrics.
String environmentId
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.
String environmentName
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.
Boolean terminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true
: (default) The user AWS resources (for example, the
Auto Scaling group, LoadBalancer, etc.) are terminated along with the
environment.
false
: The environment is removed from the AWS Elastic
Beanstalk but the AWS resources continue to operate.
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
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.Boolean abortableOperationInProgress
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.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
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
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String name
The name of the trigger.
String applicationName
The name of the application to update. If no such application is found,
UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application associated with this version.
If no application is found with this name, UpdateApplication
returns an InvalidParameterValue
error.
String versionLabel
The name of the version to update.
If no application version is found with this label,
UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for this release.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
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.
String templateName
The name of the configuration template to update.
If no configuration template is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
String description
A new description for the configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of configuration option settings to update with the new specified option value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined
configuration
options.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
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.
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.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String environmentId
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.
String environmentName
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.
String description
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
EnvironmentTier tier
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.
String versionLabel
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.
String templateName
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.
String solutionStackName
This specifies the platform version that the environment will run after the environment is updated.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.Boolean abortableOperationInProgress
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.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
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
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String applicationName
The name of the application that the configuration template or environment belongs to.
String templateName
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
String environmentName
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the options and desired values to evaluate.
com.amazonaws.internal.SdkInternalList<T> messages
A list of ValidationMessage.
String message
A message describing the error or warning.
String severity
An indication of the severity of this message:
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
String namespace
String optionName
Copyright © 2015. All rights reserved.