AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
License: Apache 2.0 License
Resources
Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ApplyEnvironmentManagedActionRequest
|
object |
Request to execute a scheduled managed action immediately. |
Properties
ActionId
|
String |
The action ID of the scheduled managed action to execute. |
||||
|
||||||
EnvironmentId
|
String |
The environment ID of the target environment. |
||||
|
||||||
EnvironmentName
|
String |
The name of the target environment. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplyEnvironmentManagedActionResult
|
object |
The result message containing information about the managed action. |
Properties
Status
|
String |
The status of the managed action. |
||||
|
||||||
ActionType
|
ActionType |
The type of managed action. |
||||
|
||||||
ActionDescription
|
String |
A description of the managed action. |
||||
|
||||||
ActionId
|
String |
The action ID of the managed action. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
ManagedActionInvalidStateException
|
Checks if the specified CNAME is available.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CheckDNSAvailabilityMessage
|
object |
Results message indicating whether a CNAME is available. |
Properties
CNAMEPrefix
|
DNSCnamePrefix |
The prefix used when this CNAME is reserved. |
||||
|
||||||
Examples
{
"CNAMEPrefix": "my-cname"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CheckDNSAvailabilityResultMessage
|
object |
Indicates if the specified CNAME is available. |
Properties
FullyQualifiedCNAME
|
DNSCname |
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix. |
||||
|
||||||
Available
|
CnameAvailability |
Indicates if the specified CNAME is available:
|
||||
|
||||||
Examples
{
"Available": true,
"FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com"
}Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ComposeEnvironmentsMessage
|
object |
Request to create or update a group of environments. |
Properties
VersionLabels
|
VersionLabels |
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. |
|||||||||||
|
|||||||||||||
GroupName
|
GroupName |
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. |
|||||||||||
|
|||||||||||||
ApplicationName
|
ApplicationName |
The name of the application to which the specified source bundles belong. |
|||||||||||
|
|||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
EnvironmentDescriptionsMessage
|
object |
Result message containing a list of environment descriptions. |
Properties
NextToken
|
Token |
In a paginated request, the token that you can pass in a subsequent request to get the next response page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Environments
|
EnvironmentDescriptionsList |
Returns an EnvironmentDescription list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Environments": [
{
"AbortableOperationInProgress": false,
"ApplicationName": "my-app",
"CNAME": "my-env.elasticbeanstalk.com",
"DateCreated": "2015-08-07T20:48:49.599Z",
"DateUpdated": "2015-08-12T18:16:55.019Z",
"EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com",
"EnvironmentId": "e-rpqsewtp2j",
"EnvironmentName": "my-env",
"Health": "Green",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"Status": "Ready",
"Tier": {
"Name": "WebServer",
"Type": "Standard",
"Version": " "
},
"VersionLabel": "7f58-stage-150812_025409"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyEnvironmentsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Creates an application that has one configuration template named default and no application versions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateApplicationMessage
|
object |
Request to create an application. |
Properties
ResourceLifecycleConfig
|
ApplicationResourceLifecycleConfig |
Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions. |
||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||
Description
|
Description |
Describes the application. |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
ApplicationName
|
ApplicationName |
The name of the application. Constraint: This name must be unique within your account. If the specified name already exists, the action returns an |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"Description": "my application"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplicationDescriptionMessage
|
object |
Result message containing a single description of an application. |
Properties
Application
|
ApplicationDescription |
The ApplicationDescription of the application. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Application": {
"ApplicationName": "my-app",
"ConfigurationTemplates": [],
"DateCreated": "2015-08-13T19:15:50.449Z",
"DateUpdated": "2015-08-20T22:34:56.195Z",
"Description": "my Elastic Beanstalk application",
"Versions": [
"2fba-stage-150819_234450",
"bf07-stage-150820_214945",
"93f8",
"fd7c-stage-150820_000431",
"22a0-stage-150819_185942"
]
}
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyApplicationsException
|
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.
Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation and SourceBundle to use the default sample application.
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateApplicationVersionMessage
|
object |
Properties
Process
|
ApplicationVersionProccess |
Pre-processes and validates the environment manifest ( 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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AutoCreateApplication
|
AutoCreateApplication |
Set to |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildConfiguration
|
BuildConfiguration |
Settings for an AWS CodeBuild build. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceBundle
|
S3Location |
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
|
SourceBuildInformation |
Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description
|
Description |
Describes this version. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VersionLabel
|
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ApplicationName
|
ApplicationName |
The name of the application. If no application is found with this name, and |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"AutoCreateApplication": true,
"Description": "my-app-v1",
"Process": true,
"SourceBundle": {
"S3Bucket": "my-bucket",
"S3Key": "sample.war"
},
"VersionLabel": "v1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplicationVersionDescriptionMessage
|
object |
Result message wrapping a single description of an application version. |
Properties
ApplicationVersion
|
ApplicationVersionDescription |
The ApplicationVersionDescription of the application version. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"ApplicationVersion": {
"ApplicationName": "my-app",
"DateCreated": "2015-08-19T18:59:17.646Z",
"DateUpdated": "2015-08-20T22:53:28.871Z",
"Description": "new description",
"SourceBundle": {
"S3Bucket": "elasticbeanstalk-us-west-2-0123456789012",
"S3Key": "my-app\/22a0-stage-150819_185942.war"
},
"VersionLabel": "22a0-stage-150819_185942"
}
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyApplicationsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyApplicationVersionsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
S3LocationNotInServiceRegionException
|
Body
| Name | Data Type | Description |
|---|---|---|
CodeBuildNotInServiceRegionException
|
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName response element is always null.
Related Topics
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationTemplateMessage
|
object |
Request to create a configuration template. |
Properties
OptionSettings
|
ConfigurationOptionSettingsList |
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. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Description
|
Description |
Describes this configuration. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
EnvironmentId
|
EnvironmentId |
The ID of the environment used with this 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 If no configuration template is found, returns an 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 |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the custom platform. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
SolutionStackName
|
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 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. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
TemplateName
|
ConfigurationTemplateName |
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 |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ApplicationName
|
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 |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"EnvironmentId": "e-rpqsewtp2j",
"TemplateName": "my-app-v1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSettingsDescription
|
object |
Describes the settings for a configuration set. |
Properties
OptionSettings
|
ConfigurationOptionSettingsList |
A list of the configuration options and their values in this configuration set. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
DateUpdated
|
UpdateDate |
The date (in UTC time) when this configuration set was last modified. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
DateCreated
|
CreationDate |
The date (in UTC time) when this configuration set was created. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
DeploymentStatus
|
ConfigurationDeploymentStatus |
If this configuration set is associated with an environment, the
|
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
If not |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Description
|
Description |
Describes this configuration set. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
TemplateName
|
ConfigurationTemplateName |
If not |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
ApplicationName
|
ApplicationName |
The name of the application associated with this configuration set. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the platform. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
SolutionStackName
|
SolutionStackName |
The name of the solution stack this configuration set uses. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"DateCreated": "2015-08-20T22:39:31Z",
"DateUpdated": "2015-08-20T22:43:11Z",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"TemplateName": "my-template"
}Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyBucketsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyConfigurationTemplatesException
|
Launches an environment for the specified application using the specified configuration.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateEnvironmentMessage
|
object |
Properties
OptionsToRemove
|
OptionsSpecifierList |
A list of custom user-defined configuration options to remove from the configuration set for this new environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
OptionSettings
|
ConfigurationOptionSettingsList |
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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the platform. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
SolutionStackName
|
SolutionStackName |
This is an alternative to specifying a template name. If specified, AWS 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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TemplateName
|
ConfigurationTemplateName |
The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
VersionLabel
|
VersionLabel |
The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Tags
|
Tags |
This specifies the tags applied to resources in the environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Tier
|
EnvironmentTier |
This specifies the tier to use for creating this environment. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
CNAMEPrefix
|
DNSCnamePrefix |
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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
Describes this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
GroupName
|
GroupName |
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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 40 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 within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an 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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
ApplicationName
|
ApplicationName |
The name of the application that contains the version to be deployed. If no application is found with this name, |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"CNAMEPrefix": "my-app",
"EnvironmentName": "my-env",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"VersionLabel": "v1"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EnvironmentDescription
|
object |
Describes the properties of an environment. |
Properties
EnvironmentArn
|
EnvironmentArn |
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
EnvironmentLinks
|
EnvironmentLinks |
A list of links to other environments in the same group. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Tier
|
EnvironmentTier |
Describes the current tier of this environment. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Resources
|
EnvironmentResourcesDescription |
The description of the AWS resources used by this environment. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
HealthStatus
|
EnvironmentHealthStatus |
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Health
|
EnvironmentHealth |
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Default: |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
AbortableOperationInProgress
|
AbortableOperationInProgress |
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Status
|
EnvironmentStatus |
The current operational status of the environment:
|
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
DateUpdated
|
UpdateDate |
The last modified date for this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
DateCreated
|
CreationDate |
The creation date for this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
CNAME
|
DNSCname |
The URL to the CNAME for this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
EndpointURL
|
EndpointURL |
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Description
|
Description |
Describes this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
TemplateName
|
ConfigurationTemplateName |
The name of the configuration template used to originally launch this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the platform. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
SolutionStackName
|
SolutionStackName |
The name of the |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
VersionLabel
|
VersionLabel |
The application version deployed in this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
ApplicationName
|
ApplicationName |
The name of the application associated with this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
EnvironmentId
|
EnvironmentId |
The ID of this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
The name of this environment. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Examples
{
"AbortableOperationInProgress": true,
"ApplicationName": "my-app",
"CNAME": "my-env.elasticbeanstalk.com",
"DateCreated": "2015-08-07T20:48:49.599Z",
"DateUpdated": "2015-08-12T18:15:23.804Z",
"EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com",
"EnvironmentId": "e-wtp2rpqsej",
"EnvironmentName": "my-env",
"Health": "Grey",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"Status": "Updating",
"Tier": {
"Name": "WebServer",
"Type": "Standard",
"Version": " "
},
"VersionLabel": "7f58-stage-150812_025409"
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyEnvironmentsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Create a new version of your custom platform.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreatePlatformVersionRequest
|
object |
Request to create a new platform version. |
Properties
OptionSettings
|
ConfigurationOptionSettingsList |
The configuration option settings to apply to the builder environment. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
The name of the builder environment. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
PlatformDefinitionBundle
|
S3Location |
The location of the platform definition archive in Amazon S3. |
|||||||||||||||||||||||
PlatformVersion
|
PlatformVersion |
The number, such as 1.0.2, for the new platform version. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
PlatformName
|
PlatformName |
The name of your custom platform. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreatePlatformVersionResult
|
object |
Properties
Builder
|
Builder |
The builder used to create the custom platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PlatformSummary
|
PlatformSummary |
Detailed information about the new version of the custom platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyPlatformsException
|
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateStorageLocationResultMessage
|
object |
Results of a CreateStorageLocationResult call. |
Properties
S3Bucket
|
S3Bucket |
The name of the Amazon S3 bucket created. |
||||
|
||||||
Examples
{
"S3Bucket": "elasticbeanstalk-us-west-2-0123456789012"
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyBucketsException
|
Body
| Name | Data Type | Description |
|---|---|---|
S3SubscriptionRequiredException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteApplicationMessage
|
object |
Request to delete an application. |
Properties
TerminateEnvByForce
|
TerminateEnvForce |
When set to true, running environments will be terminated before deleting the application. |
||||
|
||||||
ApplicationName
|
ApplicationName |
The name of the application to delete. |
||||
|
||||||
Examples
{
"ApplicationName": "my-app"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
OperationInProgressException
|
Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteApplicationVersionMessage
|
object |
Request to delete an application version. |
Properties
DeleteSourceBundle
|
DeleteSourceBundle |
Set to |
||||
|
||||||
VersionLabel
|
VersionLabel |
The label of the version to delete. |
||||
|
||||||
ApplicationName
|
ApplicationName |
The name of the application to which the version belongs. |
||||
|
||||||
Examples
{
"ApplicationName": "my-app",
"DeleteSourceBundle": true,
"VersionLabel": "22a0-stage-150819_182129"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
SourceBundleDeletionException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationInProgressException
|
Body
| Name | Data Type | Description |
|---|---|---|
S3LocationNotInServiceRegionException
|
Deletes the specified configuration template.
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationTemplateMessage
|
object |
Request to delete a configuration template. |
Properties
TemplateName
|
ConfigurationTemplateName |
The name of the configuration template to delete. |
||||
|
||||||
ApplicationName
|
ApplicationName |
The name of the application to delete the configuration template from. |
||||
|
||||||
Examples
{
"ApplicationName": "my-app",
"TemplateName": "my-template"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
OperationInProgressException
|
Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteEnvironmentConfigurationMessage
|
object |
Request to delete a draft environment configuration. |
Properties
EnvironmentName
|
EnvironmentName |
The name of the environment to delete the draft configuration from. |
||||
|
||||||
ApplicationName
|
ApplicationName |
The name of the application the environment is associated with. |
||||
|
||||||
Examples
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env"
}Responses
Deletes the specified version of a custom platform.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeletePlatformVersionRequest
|
object |
Properties
PlatformArn
|
PlatformArn |
The ARN of the version of the custom platform. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeletePlatformVersionResult
|
object |
Properties
PlatformSummary
|
PlatformSummary |
Detailed information about the version of the custom platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
OperationInProgressException
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Body
| Name | Data Type | Description |
|---|---|---|
PlatformVersionStillReferencedException
|
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
The result currently has one set of attributes—resource quotas.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAccountAttributesResult
|
object |
Properties
ResourceQuotas
|
ResourceQuotas |
The Elastic Beanstalk resource quotas associated with the calling AWS account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Retrieve a list of application versions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeApplicationVersionsMessage
|
object |
Request to describe application versions. |
Properties
NextToken
|
Token |
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 |
|||||||||||
|
|||||||||||||
MaxRecords
|
MaxRecords |
For a paginated request. Specify a maximum number of application versions to include in each response. If no |
|||||||||||
|
|||||||||||||
VersionLabels
|
VersionLabelsList |
Specify a version label to show a specific application version. |
|||||||||||
|
|||||||||||||
ApplicationName
|
ApplicationName |
Specify an application name to show only application versions for that application. |
|||||||||||
|
|||||||||||||
Examples
{
"ApplicationName": "my-app",
"VersionLabels": [
"v2"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplicationVersionDescriptionsMessage
|
object |
Result message wrapping a list of application version descriptions. |
Properties
NextToken
|
Token |
In a paginated request, the token that you can pass in a subsequent request to get the next response page. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
ApplicationVersions
|
ApplicationVersionDescriptionList |
List of |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
Examples
{
"ApplicationVersions": [
{
"ApplicationName": "my-app",
"DateCreated": "2015-07-23T01:32:26.079Z",
"DateUpdated": "2015-07-23T01:32:26.079Z",
"Description": "update cover page",
"SourceBundle": {
"S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
"S3Key": "my-app\/5026-stage-150723_224258.war"
},
"VersionLabel": "v2"
},
{
"ApplicationName": "my-app",
"DateCreated": "2015-07-23T22:26:10.816Z",
"DateUpdated": "2015-07-23T22:26:10.816Z",
"Description": "initial version",
"SourceBundle": {
"S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
"S3Key": "my-app\/5026-stage-150723_222618.war"
},
"VersionLabel": "v1"
}
]
}Returns the descriptions of existing applications.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeApplicationsMessage
|
object |
Request to describe one or more applications. |
Properties
ApplicationNames
|
ApplicationNamesList |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. |
|||||||||||
|
|||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplicationDescriptionsMessage
|
object |
Result message containing a list of application descriptions. |
Properties
Applications
|
ApplicationDescriptionList |
This parameter contains a list of ApplicationDescription. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Examples
{
"Applications": [
{
"ApplicationName": "ruby",
"ConfigurationTemplates": [],
"DateCreated": "2015-08-13T21:05:44.376Z",
"DateUpdated": "2015-08-13T21:05:44.376Z",
"Versions": [
"Sample Application"
]
},
{
"ApplicationName": "pythonsample",
"ConfigurationTemplates": [],
"DateCreated": "2015-08-13T19:05:43.637Z",
"DateUpdated": "2015-08-13T19:05:43.637Z",
"Description": "Application created from the EB CLI using \"eb init\"",
"Versions": [
"Sample Application"
]
},
{
"ApplicationName": "nodejs-example",
"ConfigurationTemplates": [],
"DateCreated": "2015-08-06T17:50:02.486Z",
"DateUpdated": "2015-08-06T17:50:02.486Z",
"Versions": [
"add elasticache",
"First Release"
]
}
]
}Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeConfigurationOptionsMessage
|
object |
Result message containing a list of application version descriptions. |
Properties
Options
|
OptionsSpecifierList |
If specified, restricts the descriptions to only the specified options. |
||||||||||||||||||||
|
||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the custom platform. |
||||||||||||||||||||
|
||||||||||||||||||||||
SolutionStackName
|
SolutionStackName |
The name of the solution stack whose configuration options you want to describe. |
||||||||||||||||||||
|
||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
The name of the environment whose configuration options you want to describe. |
||||||||||||||||||||
|
||||||||||||||||||||||
TemplateName
|
ConfigurationTemplateName |
The name of the configuration template whose configuration options you want to describe. |
||||||||||||||||||||
|
||||||||||||||||||||||
ApplicationName
|
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. |
||||||||||||||||||||
|
||||||||||||||||||||||
Examples
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationOptionsDescription
|
object |
Describes the settings for a specified configuration set. |
Properties
Options
|
ConfigurationOptionDescriptionsList |
A list of ConfigurationOptionDescription. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
PlatformArn
|
PlatformArn |
The ARN of the platform. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
SolutionStackName
|
SolutionStackName |
The name of the solution stack these configuration options belong to. |
||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Options": [
{
"ChangeSeverity": "NoInterruption",
"DefaultValue": "30",
"MaxValue": 300,
"MinValue": 5,
"Name": "Interval",
"Namespace": "aws:elb:healthcheck",
"UserDefined": false,
"ValueType": "Scalar"
},
{
"ChangeSeverity": "NoInterruption",
"DefaultValue": "2000000",
"MinValue": 0,
"Name": "LowerThreshold",
"Namespace": "aws:autoscaling:trigger",
"UserDefined": false,
"ValueType": "Scalar"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyBucketsException
|
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeConfigurationSettingsMessage
|
object |
Result message containing all of the configuration settings for a specified solution stack or configuration template. |
Properties
EnvironmentName
|
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 |
||||
|
||||||
TemplateName
|
ConfigurationTemplateName |
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 |
||||
|
||||||
ApplicationName
|
ApplicationName |
The application for the environment or configuration template. |
||||
|
||||||
Examples
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSettingsDescriptions
|
object |
The results from a request to change the configuration settings of an environment. |
Properties
ConfigurationSettings
|
ConfigurationSettingsDescriptionList |
A list of ConfigurationSettingsDescription. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
Examples
{
"ConfigurationSettings": [
{
"ApplicationName": "my-app",
"DateCreated": "2015-08-13T19:16:25Z",
"DateUpdated": "2015-08-13T23:30:07Z",
"DeploymentStatus": "deployed",
"Description": "Environment created from the EB CLI using \"eb create\"",
"EnvironmentName": "my-env",
"OptionSettings": [
{
"Namespace": "aws:autoscaling:asg",
"OptionName": "Availability Zones",
"ResourceName": "AWSEBAutoScalingGroup",
"Value": "Any"
},
{
"Namespace": "aws:autoscaling:asg",
"OptionName": "Cooldown",
"ResourceName": "AWSEBAutoScalingGroup",
"Value": "360"
},
{
"Namespace": "aws:elb:policies",
"OptionName": "ConnectionDrainingTimeout",
"ResourceName": "AWSEBLoadBalancer",
"Value": "20"
},
{
"Namespace": "aws:elb:policies",
"OptionName": "ConnectionSettingIdleTimeout",
"ResourceName": "AWSEBLoadBalancer",
"Value": "60"
}
],
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
TooManyBucketsException
|
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentHealthRequest
|
object |
See the example below to learn how to create a request body. |
Properties
AttributeNames
|
EnvironmentHealthAttributes |
Specify the response elements to return. To retrieve all attributes, set to |
|||||||||||
|
|||||||||||||
EnvironmentId
|
EnvironmentId |
Specify the environment by ID. You must specify either this or an EnvironmentName, or both. |
|||||||||||
|
|||||||||||||
EnvironmentName
|
EnvironmentName |
Specify the environment by name. You must specify either this or an EnvironmentName, or both. |
|||||||||||
|
|||||||||||||
Examples
{
"AttributeNames": [
"All"
],
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentHealthResult
|
object |
Health details for an AWS Elastic Beanstalk environment. |
Properties
RefreshedAt
|
RefreshedAt |
The date and time that the health information was retrieved. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InstancesHealth
|
InstanceHealthSummary |
Summary health information for the instances in the environment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ApplicationMetrics
|
ApplicationMetrics |
Application request metrics for the environment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Causes
|
Causes |
Descriptions of the data that contributed to the environment's current health status. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Color
|
String |
The health color of the environment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status
|
EnvironmentHealth |
The environment's operational status. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HealthStatus
|
String |
The health status of the environment. For example, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnvironmentName
|
EnvironmentName |
The environment's name. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"ApplicationMetrics": {
"Duration": 10,
"Latency": {
"P10": 0.001,
"P50": 0.001,
"P75": 0.002,
"P85": 0.003,
"P90": 0.003,
"P95": 0.004,
"P99": 0.004,
"P999": 0.004
},
"RequestCount": 45,
"StatusCodes": {
"Status2xx": 45,
"Status3xx": 0,
"Status4xx": 0,
"Status5xx": 0
}
},
"Causes": [],
"Color": "Green",
"EnvironmentName": "my-env",
"HealthStatus": "Ok",
"InstancesHealth": {
"Degraded": 0,
"Info": 0,
"NoData": 0,
"Ok": 1,
"Pending": 0,
"Severe": 0,
"Unknown": 0,
"Warning": 0
},
"RefreshedAt": "2015-08-20T21:09:18Z"
}Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Lists an environment's completed and failed managed actions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentManagedActionHistoryRequest
|
object |
Request to list completed and failed managed actions. |
Properties
MaxItems
|
Integer |
The maximum number of items to return for a single request. |
||||
|
||||||
NextToken
|
String |
The pagination token returned by a previous request. |
||||
|
||||||
EnvironmentName
|
EnvironmentName |
The name of the target environment. |
||||
|
||||||
EnvironmentId
|
EnvironmentId |
The environment ID of the target environment. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentManagedActionHistoryResult
|
object |
A result message containing a list of completed and failed managed actions. |
Properties
NextToken
|
String |
A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
ManagedActionHistoryItems
|
ManagedActionHistoryItems |
A list of completed and failed managed actions. |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Lists an environment's upcoming and in-progress managed actions.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentManagedActionsRequest
|
object |
Request to list an environment's upcoming and in-progress managed actions. |
Properties
Status
|
ActionStatus |
To show only actions with a particular status, specify a status. |
||||
|
||||||
EnvironmentId
|
String |
The environment ID of the target environment. |
||||
|
||||||
EnvironmentName
|
String |
The name of the target environment. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentManagedActionsResult
|
object |
The result message containing a list of managed actions. |
Properties
ManagedActions
|
ManagedActions |
A list of upcoming and in-progress managed actions. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Returns AWS resources for this environment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentResourcesMessage
|
object |
Request to describe the resources in an environment. |
Properties
EnvironmentName
|
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 |
||||
|
||||||
EnvironmentId
|
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 |
||||
|
||||||
Examples
{
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EnvironmentResourceDescriptionsMessage
|
object |
Result message containing a list of environment resource descriptions. |
Properties
EnvironmentResources
|
EnvironmentResourceDescription |
A list of EnvironmentResourceDescription. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"EnvironmentResources": {
"AutoScalingGroups": [
{
"Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT"
}
],
"EnvironmentName": "my-env",
"Instances": [
{
"Id": "i-0c91c786"
}
],
"LaunchConfigurations": [
{
"Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2"
}
],
"LoadBalancers": [
{
"Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0"
}
],
"Queues": [],
"Triggers": []
}
}Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Returns descriptions for existing environments.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEnvironmentsMessage
|
object |
Request to describe one or more environments. |
Properties
NextToken
|
Token |
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 |
|||||||||||
|
|||||||||||||
MaxRecords
|
MaxRecords |
For a paginated request. Specify a maximum number of environments to include in each response. If no |
|||||||||||
|
|||||||||||||
IncludedDeletedBackTo
|
IncludeDeletedBackTo |
If specified when |
|||||||||||
|
|||||||||||||
IncludeDeleted
|
IncludeDeleted |
Indicates whether to include deleted environments: |
|||||||||||
|
|||||||||||||
EnvironmentNames
|
EnvironmentNamesList |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. |
|||||||||||
|
|||||||||||||
EnvironmentIds
|
EnvironmentIdList |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. |
|||||||||||
|
|||||||||||||
VersionLabel
|
VersionLabel |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. |
|||||||||||
|
|||||||||||||
ApplicationName
|
ApplicationName |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. |
|||||||||||
|
|||||||||||||
Examples
{
"EnvironmentNames": [
"my-env"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EnvironmentDescriptionsMessage
|
object |
Result message containing a list of environment descriptions. |
Properties
NextToken
|
Token |
In a paginated request, the token that you can pass in a subsequent request to get the next response page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Environments
|
EnvironmentDescriptionsList |
Returns an EnvironmentDescription list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Environments": [
{
"AbortableOperationInProgress": false,
"ApplicationName": "my-app",
"CNAME": "my-env.elasticbeanstalk.com",
"DateCreated": "2015-08-07T20:48:49.599Z",
"DateUpdated": "2015-08-12T18:16:55.019Z",
"EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com",
"EnvironmentId": "e-rpqsewtp2j",
"EnvironmentName": "my-env",
"Health": "Green",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"Status": "Ready",
"Tier": {
"Name": "WebServer",
"Type": "Standard",
"Version": " "
},
"VersionLabel": "7f58-stage-150812_025409"
}
]
}Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified NextToken.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
MaxRecords
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEventsMessage
|
object |
Request to retrieve a list of events for an environment. |
Properties
NextToken
|
Token |
Pagination token. If specified, the events return the next batch of results. |
||||
|
||||||
MaxRecords
|
MaxRecords |
Specifies the maximum number of events that can be returned, beginning with the most recent event. |
||||
|
||||||
EndTime
|
TimeFilterEnd |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the |
||||
|
||||||
StartTime
|
TimeFilterStart |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. |
||||
|
||||||
Severity
|
EventSeverity |
If specified, limits the events returned from this call to include only those with the specified severity or higher. |
||||
|
||||||
RequestId
|
RequestId |
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. |
||||
|
||||||
PlatformArn
|
PlatformArn |
The ARN of the version of the custom platform. |
||||
|
||||||
EnvironmentName
|
EnvironmentName |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. |
||||
|
||||||
EnvironmentId
|
EnvironmentId |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. |
||||
|
||||||
TemplateName
|
ConfigurationTemplateName |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. |
||||
|
||||||
VersionLabel
|
VersionLabel |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. |
||||
|
||||||
ApplicationName
|
ApplicationName |
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. |
||||
|
||||||
Examples
{
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
EventDescriptionsMessage
|
object |
Result message wrapping a list of event descriptions. |
Properties
NextToken
|
Token |
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. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
Events
|
EventDescriptionList |
A list of EventDescription. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
Examples
{
"Events": [
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env",
"EventDate": "2015-08-20T07:06:53.535Z",
"Message": "Environment health has transitioned from Info to Ok.",
"Severity": "INFO"
},
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env",
"EventDate": "2015-08-20T07:06:02.049Z",
"Message": "Environment update completed successfully.",
"RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41",
"Severity": "INFO"
},
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env",
"EventDate": "2015-08-13T19:16:27.561Z",
"Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.",
"RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b",
"Severity": "INFO"
},
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env",
"EventDate": "2015-08-13T19:16:26.581Z",
"Message": "createEnvironment is starting.",
"RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b",
"Severity": "INFO"
}
]
}Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeInstancesHealthRequest
|
object |
Parameters for a call to |
Properties
NextToken
|
NextToken |
Specify the pagination token returned by a previous call. |
|||||||||||
|
|||||||||||||
AttributeNames
|
InstancesHealthAttributes |
Specifies the response elements you wish to receive. To retrieve all attributes, set to |
|||||||||||
|
|||||||||||||
EnvironmentId
|
EnvironmentId |
Specify the AWS Elastic Beanstalk environment by ID. |
|||||||||||
|
|||||||||||||
EnvironmentName
|
EnvironmentName |
Specify the AWS Elastic Beanstalk environment by name. |
|||||||||||
|
|||||||||||||
Examples
{
"AttributeNames": [
"All"
],
"EnvironmentName": "my-env"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeInstancesHealthResult
|
object |
Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment. |
Properties
NextToken
|
NextToken |
Pagination token for the next page of results, if available. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
RefreshedAt
|
RefreshedAt |
The date and time that the health information was retrieved. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
InstanceHealthList
|
InstanceHealthList |
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 |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
Examples
{
"InstanceHealthList": [
{
"ApplicationMetrics": {
"Duration": 10,
"Latency": {
"P10": 0,
"P50": 0.001,
"P75": 0.002,
"P85": 0.003,
"P90": 0.004,
"P95": 0.005,
"P99": 0.006,
"P999": 0.006
},
"RequestCount": 48,
"StatusCodes": {
"Status2xx": 47,
"Status3xx": 0,
"Status4xx": 1,
"Status5xx": 0
}
},
"Causes": [],
"Color": "Green",
"HealthStatus": "Ok",
"InstanceId": "i-08691cc7",
"LaunchedAt": "2015-08-13T19:17:09Z",
"System": {
"CPUUtilization": {
"IOWait": 0.2,
"IRQ": 0,
"Idle": 97.8,
"Nice": 0.1,
"SoftIRQ": 0.1,
"System": 0.3,
"User": 1.5
},
"LoadAverage": [
0,
0.02,
0.05
]
}
}
],
"RefreshedAt": "2015-08-20T21:09:08Z"
}Body
| Name | Data Type | Description |
|---|---|---|
InvalidRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Describes the version of the platform.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribePlatformVersionRequest
|
object |
Properties
PlatformArn
|
PlatformArn |
The ARN of the version of the platform. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribePlatformVersionResult
|
object |
Properties
PlatformDescription
|
PlatformDescription |
Detailed information about the version of the platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientPrivilegesException
|
Body
| Name | Data Type | Description |
|---|---|---|
ElasticBeanstalkServiceException
|
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAvailableSolutionStacksResultMessage
|
object |
A list of available AWS Elastic Beanstalk solution stacks. |
Properties
SolutionStackDetails
|
AvailableSolutionStackDetailsList |
A list of available solution stacks and their SolutionStackDescription. |
|||||||||||||||||
|
|||||||||||||||||||
SolutionStacks
|
AvailableSolutionStackNamesList |
A list of available solution stacks. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"SolutionStackDetails": [
{
"PermittedFileTypes": [
"zip"
],
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js"
}
],
"SolutionStacks": [
"64bit Amazon Linux 2015.03 v2.0.0 running Node.js",
"64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6",
"64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5",
"64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4",
"64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4",
"64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7",
"64bit Amazon Linux 2015.03 v2.0.0 running Python",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)",
"64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3",
"64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
"64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7",
"64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6",
"64bit Windows Server Core 2012 R2 running IIS 8.5",
"64bit Windows Server 2012 R2 running IIS 8.5",
"64bit Windows Server 2012 running IIS 8",
"64bit Windows Server 2008 R2 running IIS 7.5",
"64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2",
"64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)",
"64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)",
"64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)",
"64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)",
"64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)",
"64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)"
]
}Lists the available platforms.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListPlatformVersionsRequest
|
object |
Properties
NextToken
|
Token |
The starting index into the remaining list of platforms. Use the |
||||||||||||||||||||
|
||||||||||||||||||||||
MaxRecords
|
PlatformMaxRecords |
The maximum number of platform values returned in one call. |
||||||||||||||||||||
|
||||||||||||||||||||||
Filters
|
PlatformFilters |
List only the platforms where the platform member value relates to one of the supplied values. |
||||||||||||||||||||
|
||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListPlatformVersionsResult
|
object |
Properties
NextToken
|
Token |
The starting index into the remaining list of platforms. if this value is not |
||||||||||||||||
|
||||||||||||||||||
PlatformSummaryList
|
PlatformSummaryList |
Detailed information about the platforms. |
||||||||||||||||
| ||||||||||||||||||