ConfigurationSettingsDescription
Describes the settings for a configuration set.
Contents
ApplicationName
The name of the application associated with this configuration set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No DateCreated
The date (in UTC time) when this configuration set was created.
Type: Timestamp Required: No DateUpdated
The date (in UTC time) when this configuration set was last modified.
Type: Timestamp Required: No 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.
Type: String
Valid Values: deployed | pending | failed Required: No
Description
Describes this configuration set.
Type: String
Length Constraints: Maximum length of 200.
Required: No
See Also
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No
OptionSettings.member.N
A list of the configuration options and their values in this configuration set.
Type: Array of ConfigurationOptionSetting (p. 168) objects Required: No
PlatformArn
The ARN of the platform version.
Type: String Required: No SolutionStackName
The name of the solution stack this configuration set uses.
Type: String Required: No TemplateName
If not null, the name of the configuration template for this configuration set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CPUUtilization
CPUUtilization
CPU utilization metrics for an instance.
Contents
Idle
Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.
Type: Double Required: No IOWait
Available on Linux environments only.
Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.
Type: Double Required: No IRQ
Available on Linux environments only.
Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.
Type: Double Required: No Nice
Available on Linux environments only.
Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.
Type: Double Required: No Privileged
Available on Windows environments only.
Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.
Type: Double Required: No SoftIRQ
Available on Linux environments only.
Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.
See Also
System
Available on Linux environments only.
Percentage of time that the CPU has spent in the System state over the last 10 seconds.
Type: Double Required: No User
Percentage of time that the CPU has spent in the User state over the last 10 seconds.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CustomAmi
CustomAmi
A custom AMI available to platforms.
Contents
ImageId
THe ID of the image used to create the custom AMI.
Type: String Required: No VirtualizationType
The type of virtualization used to create the custom AMI.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Deployment
Deployment
Information about an application version deployment.
Contents
DeploymentId
The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
Type: Long Required: No DeploymentTime
For in-progress deployments, the time that the deployment started.
For completed deployments, the time that the deployment ended.
Type: Timestamp Required: No Status
The status of the deployment:
• In Progress : The deployment is in progress.
• Deployed : The deployment succeeded.
• Failed : The deployment failed.
Type: String Required: No VersionLabel
The version label of the application version in the deployment.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentDescription
EnvironmentDescription
Describes the properties of an environment.
Contents
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.
Type: Boolean Required: No ApplicationName
The name of the application associated with this environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No CNAME
The URL to the CNAME for this environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No DateCreated
The creation date for this environment.
Type: Timestamp Required: No DateUpdated
The last modified date for this environment.
Type: Timestamp Required: No Description
Describes this environment.
Type: String
Contents
EndpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
Type: String Required: No EnvironmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
Type: String Required: No EnvironmentId
The ID of this environment.
Type: String Required: No
EnvironmentLinks.member.N
A list of links to other environments in the same group.
Type: Array of EnvironmentLink (p. 180) objects Required: No
EnvironmentName
The name of this environment.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No 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 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 Type: String
Valid Values: Green | Yellow | Red | Grey Required: No
Contents
HealthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
Type: String
Valid Values: NoData | Unknown | Pending | Ok | Info | Warning | Degraded | Severe | Suspended
Required: No OperationsRole
Important
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
The Amazon Resource Name (ARN) of the environment's operations role.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No PlatformArn
The ARN of the platform version.
Type: String Required: No Resources
The description of the AWS resources used by this environment.
Type: EnvironmentResourcesDescription (p. 183) object Required: No
SolutionStackName
The name of the SolutionStack deployed with this environment.
Type: String Required: No Status
The current operational status of the environment:
• Aborting: Environment is in the process of aborting a deployment.
• Launching: Environment is in the process of initial deployment.
• LinkingFrom: Environment is in the process of being linked to by another environment. See Environment links for details.
• LinkingTo: Environment is in the process of linking to another environment. See Environment links for details.
• Updating: Environment is in the process of updating its configuration settings or application version.
See Also
• Terminated: Environment is not running.
Type: String
Valid Values: Aborting | Launching | Updating | LinkingFrom | LinkingTo | Ready
| Terminating | Terminated Required: No
TemplateName
The name of the configuration template used to originally launch this environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No Tier
Describes the current tier of this environment.
Type: EnvironmentTier (p. 184) object Required: No
VersionLabel
The application version deployed in this environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentInfoDescription
EnvironmentInfoDescription
The information retrieved from the Amazon EC2 instances.
Contents
Ec2InstanceId
The Amazon EC2 Instance ID for this information.
Type: String Required: No InfoType
The type of information retrieved.
Type: String
Valid Values: tail | bundle Required: No
Message
The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
Type: String Required: No SampleTimestamp
The time stamp when this information was retrieved.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentLink
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.
Contents
EnvironmentName
The name of the linked environment (the dependency).
Type: String Required: No LinkName
The name of the link.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentResourceDescription
EnvironmentResourceDescription
Describes the AWS resources in use by this environment. This data is live.
Contents
AutoScalingGroups.member.N
The AutoScalingGroups used by this environment.
Type: Array of AutoScalingGroup (p. 161) objects Required: No
EnvironmentName
The name of the environment.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No Instances.member.N
The Amazon EC2 instances used by this environment.
Type: Array of Instance (p. 187) objects Required: No
LaunchConfigurations.member.N
The Auto Scaling launch configurations in use by this environment.
Type: Array of LaunchConfiguration (p. 192) objects Required: No
LaunchTemplates.member.N
The Amazon EC2 launch templates in use by this environment.
Type: Array of LaunchTemplate (p. 193) objects Required: No
LoadBalancers.member.N
The LoadBalancers in use by this environment.
Type: Array of LoadBalancer (p. 195) objects Required: No
Queues.member.N
The queues used by this environment.
See Also
Triggers.member.N
The AutoScaling triggers in use by this environment.
Type: Array of Trigger (p. 229) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentResourcesDescription
EnvironmentResourcesDescription
Describes the AWS resources in use by this environment. This data is not live data.
Contents
LoadBalancer
Describes the LoadBalancer.
Type: LoadBalancerDescription (p. 196) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnvironmentTier
EnvironmentTier
Describes the properties of an environment tier
Contents
Name
The name of this environment tier.
Valid values:
• For Web server tier – WebServer
• For Worker tier – Worker Type: String
Required: No Type
The type of this environment tier.
Valid values:
• For Web server tier – Standard
• For Worker tier – SQS/HTTP Type: String
Required: No Version
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
NoteThis member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EventDescription
EventDescription
Describes an event.
Contents
ApplicationName
The application associated with the event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No EnvironmentName
The name of the environment associated with this event.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No EventDate
The date when the event occurred.
Type: Timestamp Required: No Message
The event message.
Type: String Required: No PlatformArn
The ARN of the platform version.
Type: String Required: No RequestId
The web service request ID for the activity of this event.
Type: String Required: No Severity
See Also
Valid Values: TRACE | DEBUG | INFO | WARN | ERROR | FATAL Required: No
TemplateName
The name of the configuration associated with this event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No VersionLabel
The release label for the application version associated with this event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Instance
Instance
The description of an Amazon EC2 instance.
Contents
Id
The ID of the Amazon EC2 instance.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InstanceHealthSummary
InstanceHealthSummary
Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.
Contents
Degraded
Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
Type: Integer Required: No Info
Green. An operation is in progress on an instance.
Type: Integer Required: No NoData
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
Type: Integer Required: No Ok
Green. An instance is passing health checks and the health agent is not reporting any problems.
Type: Integer Required: No Pending
Grey. An operation is in progress on an instance within the command timeout.
Type: Integer Required: No Severe
Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
Type: Integer Required: No Unknown
Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
Type: Integer
See Also
Required: No Warning
Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Latency
Latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds.
Contents
P10
The average latency for the slowest 90 percent of requests over the last 10 seconds.
Type: Double Required: No P50
The average latency for the slowest 50 percent of requests over the last 10 seconds.
Type: Double Required: No P75
The average latency for the slowest 25 percent of requests over the last 10 seconds.
Type: Double Required: No P85
The average latency for the slowest 15 percent of requests over the last 10 seconds.
Type: Double Required: No P90
The average latency for the slowest 10 percent of requests over the last 10 seconds.
Type: Double Required: No P95
The average latency for the slowest 5 percent of requests over the last 10 seconds.
Type: Double Required: No P99
The average latency for the slowest 1 percent of requests over the last 10 seconds.
Type: Double Required: No P999
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.