DescribeConfigurationSettings
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 (p. 46)
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 231).
ApplicationName
The application for the environment or configuration template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes EnvironmentName
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No TemplateName
The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
Response Elements
Errors
ConfigurationSettings.member.N
A list of ConfigurationSettingsDescription (p. 169).
Type: Array of ConfigurationSettingsDescription (p. 169) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 233).
TooManyBuckets
The specified account has reached its limit of Amazon S3 buckets.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeConfigurationSettings.
Sample Request
<ConfigurationSettings>
<member>
<SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
<OptionSettings>
<member>
<SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName>
<OptionSettings>
<member>
<OptionName>ImageId</OptionName>
<Value>ami-f2f0069b</Value>
<Namespace>aws:autoscaling:launchconfiguration</Namespace>
</member>
<member>
<OptionName>Notification Endpoint</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
</member>
<member>
<OptionName>PARAM4</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
Examples
<member>
<OptionName>JDBC_CONNECTION_STRING</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>SecurityGroups</OptionName>
<Value>elasticbeanstalk-default</Value>
<Namespace>aws:autoscaling:launchconfiguration</Namespace>
</member>
<member>
<OptionName>UnhealthyThreshold</OptionName>
<Value>5</Value>
<Namespace>aws:elb:healthcheck</Namespace>
</member>
<member>
<OptionName>InstanceType</OptionName>
<Value>t1.micro</Value>
<Namespace>aws:autoscaling:launchconfiguration</Namespace>
</member>
<member>
<OptionName>Statistic</OptionName>
<Value>Average</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>LoadBalancerHTTPSPort</OptionName>
<Value>OFF</Value>
<Namespace>aws:elb:loadbalancer</Namespace>
</member>
<member>
<OptionName>Stickiness Cookie Expiration</OptionName>
<Value>0</Value>
<Namespace>aws:elb:policies</Namespace>
</member>
<member>
<OptionName>PARAM5</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>MeasureName</OptionName>
<Value>NetworkOut</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>Interval</OptionName>
<Value>30</Value>
<Namespace>aws:elb:healthcheck</Namespace>
</member>
<member>
<OptionName>Application Healthcheck URL</OptionName>
<Value>/</Value>
<Namespace>aws:elasticbeanstalk:application</Namespace>
</member>
<member>
<OptionName>Notification Topic ARN</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
</member>
<member>
<OptionName>LowerBreachScaleIncrement</OptionName>
<Value>-1</Value>
Examples
<OptionName>XX:MaxPermSize</OptionName>
<Value>64m</Value>
<Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
</member>
<member>
<OptionName>UpperBreachScaleIncrement</OptionName>
<Value>1</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>MinSize</OptionName>
<Value>1</Value>
<Namespace>aws:autoscaling:asg</Namespace>
</member>
<member>
<OptionName>Custom Availability Zones</OptionName>
<Value>us-east-1a</Value>
<Namespace>aws:autoscaling:asg</Namespace>
</member>
<member>
<OptionName>Availability Zones</OptionName>
<Value>Any 1</Value>
<Namespace>aws:autoscaling:asg</Namespace>
</member>
<member>
<OptionName>LogPublicationControl</OptionName>
<Value>false</Value>
<Namespace>aws:elasticbeanstalk:hostmanager</Namespace>
</member>
<member>
<OptionName>JVM Options</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
</member>
<member>
<OptionName>Notification Topic Name</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
</member>
<member>
<OptionName>PARAM2</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>LoadBalancerHTTPPort</OptionName>
<Value>80</Value>
<Namespace>aws:elb:loadbalancer</Namespace>
</member>
<member>
<OptionName>Timeout</OptionName>
<Value>5</Value>
<Namespace>aws:elb:healthcheck</Namespace>
</member>
<member>
<OptionName>BreachDuration</OptionName>
<Value>2</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>MonitoringInterval</OptionName>
<Value>5 minute</Value>
<Namespace>aws:autoscaling:launchconfiguration</Namespace>
</member>
<member>
<OptionName>PARAM1</OptionName>
Examples
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>MaxSize</OptionName>
<Value>4</Value>
<Namespace>aws:autoscaling:asg</Namespace>
</member>
<member>
<OptionName>LowerThreshold</OptionName>
<Value>2000000</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>AWS_SECRET_KEY</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>AWS_ACCESS_KEY_ID</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>UpperThreshold</OptionName>
<Value>6000000</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>Notification Protocol</OptionName>
<Value>email</Value>
<Namespace>aws:elasticbeanstalk:sns:topics</Namespace>
</member>
<member>
<OptionName>Unit</OptionName>
<Value>Bytes</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>Xmx</OptionName>
<Value>256m</Value>
<Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
</member>
<member>
<OptionName>Cooldown</OptionName>
<Value>360</Value>
<Namespace>aws:autoscaling:asg</Namespace>
</member>
<member>
<OptionName>Period</OptionName>
<Value>1</Value>
<Namespace>aws:autoscaling:trigger</Namespace>
</member>
<member>
<OptionName>Xms</OptionName>
<Value>256m</Value>
<Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace>
</member>
<member>
<OptionName>EC2KeyName</OptionName>
<Value/>
<Namespace>aws:autoscaling:launchconfiguration</Namespace>
</member>
See Also
<Namespace>aws:elb:policies</Namespace>
</member>
<member>
<OptionName>PARAM3</OptionName>
<Value/>
<Namespace>aws:elasticbeanstalk:application:environment</Namespace>
</member>
<member>
<OptionName>HealthyThreshold</OptionName>
<Value>3</Value>
<Namespace>aws:elb:healthcheck</Namespace>
</member>
<member>
<OptionName>SSLCertificateId</OptionName>
<Value/>
<Namespace>aws:elb:loadbalancer</Namespace>
</member>
</OptionSettings>
<Description>Default Configuration Template</Description>
<ApplicationName>SampleApp</ApplicationName>
<DateCreated>2010-11-17T03:20:17.832Z</DateCreated>
<TemplateName>Default</TemplateName>
<DateUpdated>2010-11-17T03:20:17.832Z</DateUpdated>
</member>
</ConfigurationSettings>
</DescribeConfigurationSettingsResult>
<ResponseMetadata>
<RequestId>4bde8884-f273-11df-8a78-9f77047e0d0c</RequestId>
</ResponseMetadata>
</DescribeConfigurationSettingsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeEnvironmentHealth
DescribeEnvironmentHealth
Returns information about the overall health of the specified environment. The
DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 231).
AttributeNames.member.N
Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.
Type: Array of strings
Valid Values: Status | Color | Causes | ApplicationMetrics | InstancesHealth | All | HealthStatus | RefreshedAt
Required: No EnvironmentId
Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.
Type: String Required: No EnvironmentName
Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Required: No
Response Elements
The following elements are returned by the service.
ApplicationMetrics
Application request metrics for the environment.
Type: ApplicationMetrics (p. 156) object Causes.member.N
Descriptions of the data that contributed to the environment's current health status.
Errors
Color
The health color of the environment.
Type: String EnvironmentName
The environment's name.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
HealthStatus
The health status of the environment. For example, Ok.
Type: String InstancesHealth
Summary health information for the instances in the environment.
Type: InstanceHealthSummary (p. 188) object RefreshedAt
The date and time that the health information was retrieved.
Type: Timestamp Status
The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
Type: String
Valid Values: Green | Yellow | Red | Grey
Errors
For information about the errors that are common to all actions, see Common Errors (p. 233).
ElasticBeanstalkService
A generic service exception has occurred.
HTTP Status Code: 400 InvalidRequest
One or more input parameters is not valid. Please correct the input parameters and try the operation again.
HTTP Status Code: 400