2015/05/18 - AWS Elastic Beanstalk - 7 updated api methods
{'OptionSettings': {'ResourceName': 'string'}}
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.
Related Topics
DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks
Request Syntax
client.create_configuration_template(
ApplicationName='string',
TemplateName='string',
SolutionStackName='string',
SourceConfiguration={
'ApplicationName': 'string',
'TemplateName': 'string'
},
EnvironmentId='string',
Description='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
[REQUIRED]
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
dict
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.
If no configuration template is found, returns an InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
ApplicationName (string) --
The name of the application associated with the configuration.
TemplateName (string) --
The name of the configuration template.
string
The ID of the environment used with this configuration template.
string
Describes this configuration.
list
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.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
dict
Response Syntax
{
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Describes the settings for a configuration set.
SolutionStackName (string) --
The name of the solution stack this configuration set uses.
ApplicationName (string) --
The name of the application associated with this configuration set.
TemplateName (string) --
If not null, the name of the configuration template for this configuration set.
Description (string) --
Describes this configuration set.
EnvironmentName (string) --
If not null, the name of the environment for this configuration set.
DeploymentStatus (string) --
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration, that failed to successfully deploy.
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration that failed to successfully deploy.
DateCreated (datetime) --
The date (in UTC time) when this configuration set was created.
DateUpdated (datetime) --
The date (in UTC time) when this configuration set was last modified.
OptionSettings (list) --
A list of the configuration options and their values in this configuration set.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
{'OptionSettings': {'ResourceName': 'string'},
'OptionsToRemove': {'ResourceName': 'string'}}
Launches an environment for the specified application using the specified configuration.
Request Syntax
client.create_environment(
ApplicationName='string',
EnvironmentName='string',
Description='string',
CNAMEPrefix='string',
Tier={
'Name': 'string',
'Type': 'string',
'Version': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionLabel='string',
TemplateName='string',
SolutionStackName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
string
[REQUIRED]
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.
string
[REQUIRED]
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
string
Describes this environment.
string
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.
dict
This specifies the tier to use for creating this environment.
Name (string) --
The name of this environment tier.
Type (string) --
The type of this environment tier.
Version (string) --
The version of this environment tier.
list
This specifies the tags applied to resources in the environment.
(dict) --
Describes a tag applied to a resource in an environment.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
string
The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
string
The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
string
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
list
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.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
list
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
(dict) --
A specification identifying an individual configuration option.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
dict
Response Syntax
{
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
}
Response Structure
(dict) --
Describes the properties of an environment.
EnvironmentName (string) --
The name of this environment.
EnvironmentId (string) --
The ID of this environment.
ApplicationName (string) --
The name of the application associated with this environment.
VersionLabel (string) --
The application version deployed in this environment.
SolutionStackName (string) --
The name of the SolutionStack deployed with this environment.
TemplateName (string) --
The name of the configuration template used to originally launch this environment.
Description (string) --
Describes this environment.
EndpointURL (string) --
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
CNAME (string) --
The URL to the CNAME for this environment.
DateCreated (datetime) --
The creation date for this environment.
DateUpdated (datetime) --
The last modified date for this environment.
Status (string) --
The current operational status of the environment:
Launching: Environment is in the process of initial deployment.
Updating: Environment is in the process of updating its configuration settings or application version.
Ready: Environment is available to have an action performed on it, such as update or terminate.
Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
AbortableOperationInProgress (boolean) --
Lists in-progress environment updates and application version deployments that you can cancel.
Health (string) --
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working.
Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.
Green: Indicates the environment is healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green: Indicates the environment is healthy and fully functional.
Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default: Grey
Resources (dict) --
The description of the AWS resources used by this environment.
LoadBalancer (dict) --
Describes the LoadBalancer.
LoadBalancerName (string) --
The name of the LoadBalancer.
Domain (string) --
The domain name of the LoadBalancer.
Listeners (list) --
A list of Listeners used by the LoadBalancer.
(dict) --
Describes the properties of a Listener for the LoadBalancer.
Protocol (string) --
The protocol that is used by the Listener.
Port (integer) --
The port that is used by the Listener.
Tier (dict) --
Describes the current tier of this environment.
Name (string) --
The name of this environment tier.
Type (string) --
The type of this environment tier.
Version (string) --
The version of this environment tier.
{'Options': {'ResourceName': 'string'}}
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 Syntax
client.describe_configuration_options(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string',
SolutionStackName='string',
Options=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
string
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
string
The name of the configuration template whose configuration options you want to describe.
string
The name of the environment whose configuration options you want to describe.
string
The name of the solution stack whose configuration options you want to describe.
list
If specified, restricts the descriptions to only the specified options.
(dict) --
A specification identifying an individual configuration option.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
dict
Response Syntax
{
'SolutionStackName': 'string',
'Options': [
{
'Namespace': 'string',
'Name': 'string',
'DefaultValue': 'string',
'ChangeSeverity': 'string',
'UserDefined': True|False,
'ValueType': 'Scalar'|'List',
'ValueOptions': [
'string',
],
'MinValue': 123,
'MaxValue': 123,
'MaxLength': 123,
'Regex': {
'Pattern': 'string',
'Label': 'string'
}
},
]
}
Response Structure
(dict) --
Describes the settings for a specified configuration set.
SolutionStackName (string) --
The name of the solution stack these configuration options belong to.
Options (list) --
A list of ConfigurationOptionDescription.
(dict) --
Describes the possible values for a configuration option.
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
Name (string) --
The name of the configuration option.
DefaultValue (string) --
The default value for this configuration option.
ChangeSeverity (string) --
An indication of which action is required if the value for this configuration option changes:
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption : There is no interruption to the environment or application availability.
RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
UserDefined (boolean) --
An indication of whether the user defined this configuration option:
true : This configuration option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings.
false : This configuration was not defined by the user.
true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.
false : This configuration was not defined by the user.
Constraint: You can remove only UserDefined options from a configuration.
Valid Values: true | false
ValueType (string) --
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar : Values for this option are a single selection from the possible values, or a unformatted string or numeric value governed by the MIN/MAX/Regex constraints:
List : Values for this option are multiple selections of the possible values.
Boolean : Values for this option are either true or false .
Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
List : Values for this option are multiple selections from the possible values.
Boolean : Values for this option are either true or false .
ValueOptions (list) --
If specified, values for the configuration option are selected from this list.
(string) --
MinValue (integer) --
If specified, the configuration option must be a numeric value greater than this value.
MaxValue (integer) --
If specified, the configuration option must be a numeric value less than this value.
MaxLength (integer) --
If specified, the configuration option must be a string value no longer than this value.
Regex (dict) --
If specified, the configuration option must be a string value that satisfies this regular expression.
Pattern (string) --
The regular expression pattern that a string configuration option value with this restriction must match.
Label (string) --
A unique name representing this regular expression.
{'ConfigurationSettings': {'OptionSettings': {'ResourceName': 'string'}}}
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
DeleteEnvironmentConfiguration
Request Syntax
client.describe_configuration_settings(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string'
)
string
[REQUIRED]
The application for the environment or configuration template.
string
The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
string
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
dict
Response Syntax
{
'ConfigurationSettings': [
{
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
The results from a request to change the configuration settings of an environment.
ConfigurationSettings (list) --
A list of ConfigurationSettingsDescription.
(dict) --
Describes the settings for a configuration set.
SolutionStackName (string) --
The name of the solution stack this configuration set uses.
ApplicationName (string) --
The name of the application associated with this configuration set.
TemplateName (string) --
If not null, the name of the configuration template for this configuration set.
Description (string) --
Describes this configuration set.
EnvironmentName (string) --
If not null, the name of the environment for this configuration set.
DeploymentStatus (string) --
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration, that failed to successfully deploy.
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration that failed to successfully deploy.
DateCreated (datetime) --
The date (in UTC time) when this configuration set was created.
DateUpdated (datetime) --
The date (in UTC time) when this configuration set was last modified.
OptionSettings (list) --
A list of the configuration options and their values in this configuration set.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
{'OptionSettings': {'ResourceName': 'string'},
'OptionsToRemove': {'ResourceName': 'string'}}
Response {'OptionSettings': {'ResourceName': 'string'}}
Updates the specified configuration template to have the specified properties or configuration option values.
Related Topics
DescribeConfigurationOptions
Request Syntax
client.update_configuration_template(
ApplicationName='string',
TemplateName='string',
Description='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
string
[REQUIRED]
The name of the application associated with the configuration template to update.
If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
string
[REQUIRED]
The name of the configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
string
A new description for the configuration.
list
A list of configuration option settings to update with the new specified option value.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
list
A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined configuration options.
(dict) --
A specification identifying an individual configuration option.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
dict
Response Syntax
{
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Describes the settings for a configuration set.
SolutionStackName (string) --
The name of the solution stack this configuration set uses.
ApplicationName (string) --
The name of the application associated with this configuration set.
TemplateName (string) --
If not null, the name of the configuration template for this configuration set.
Description (string) --
Describes this configuration set.
EnvironmentName (string) --
If not null, the name of the environment for this configuration set.
DeploymentStatus (string) --
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration, that failed to successfully deploy.
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration that failed to successfully deploy.
DateCreated (datetime) --
The date (in UTC time) when this configuration set was created.
DateUpdated (datetime) --
The date (in UTC time) when this configuration set was last modified.
OptionSettings (list) --
A list of the configuration options and their values in this configuration set.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
{'OptionSettings': {'ResourceName': 'string'},
'OptionsToRemove': {'ResourceName': 'string'}}
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
Request Syntax
client.update_environment(
EnvironmentId='string',
EnvironmentName='string',
Description='string',
Tier={
'Name': 'string',
'Type': 'string',
'Version': 'string'
},
VersionLabel='string',
TemplateName='string',
SolutionStackName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
string
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
string
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
string
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
dict
This specifies the tier to use to update the environment.
Condition: You can only update the tier version for an environment. If you change the name of the type, AWS Elastic Beanstalk returns InvalidParameterValue error.
Name (string) --
The name of this environment tier.
Type (string) --
The type of this environment tier.
Version (string) --
The version of this environment tier.
string
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
string
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
This specifies the platform version that the environment will run after the environment is updated.
list
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
list
A list of custom user-defined configuration options to remove from the configuration set for this environment.
(dict) --
A specification identifying an individual configuration option.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
dict
Response Syntax
{
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
}
Response Structure
(dict) --
Describes the properties of an environment.
EnvironmentName (string) --
The name of this environment.
EnvironmentId (string) --
The ID of this environment.
ApplicationName (string) --
The name of the application associated with this environment.
VersionLabel (string) --
The application version deployed in this environment.
SolutionStackName (string) --
The name of the SolutionStack deployed with this environment.
TemplateName (string) --
The name of the configuration template used to originally launch this environment.
Description (string) --
Describes this environment.
EndpointURL (string) --
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
CNAME (string) --
The URL to the CNAME for this environment.
DateCreated (datetime) --
The creation date for this environment.
DateUpdated (datetime) --
The last modified date for this environment.
Status (string) --
The current operational status of the environment:
Launching: Environment is in the process of initial deployment.
Updating: Environment is in the process of updating its configuration settings or application version.
Ready: Environment is available to have an action performed on it, such as update or terminate.
Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
AbortableOperationInProgress (boolean) --
Lists in-progress environment updates and application version deployments that you can cancel.
Health (string) --
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working.
Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.
Green: Indicates the environment is healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green: Indicates the environment is healthy and fully functional.
Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default: Grey
Resources (dict) --
The description of the AWS resources used by this environment.
LoadBalancer (dict) --
Describes the LoadBalancer.
LoadBalancerName (string) --
The name of the LoadBalancer.
Domain (string) --
The domain name of the LoadBalancer.
Listeners (list) --
A list of Listeners used by the LoadBalancer.
(dict) --
Describes the properties of a Listener for the LoadBalancer.
Protocol (string) --
The protocol that is used by the Listener.
Port (integer) --
The port that is used by the Listener.
Tier (dict) --
Describes the current tier of this environment.
Name (string) --
The name of this environment tier.
Type (string) --
The type of this environment tier.
Version (string) --
The version of this environment tier.
{'OptionSettings': {'ResourceName': 'string'}}
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
Request Syntax
client.validate_configuration_settings(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application that the configuration template or environment belongs to.
string
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
string
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
list
[REQUIRED]
A list of the options and desired values to evaluate.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
ResourceName (string) --
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
dict
Response Syntax
{
'Messages': [
{
'Message': 'string',
'Severity': 'error'|'warning',
'Namespace': 'string',
'OptionName': 'string'
},
]
}
Response Structure
(dict) --
Provides a list of validation messages.
Messages (list) --
A list of ValidationMessage.
(dict) --
An error or warning for a desired configuration option value.
Message (string) --
A message describing the error or warning.
Severity (string) --
An indication of the severity of this message:
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
Namespace (string) --
OptionName (string) --