ElasticBeanstalk / Client / describe_configuration_settings

describe_configuration_settings¶

ElasticBeanstalk.Client.describe_configuration_settings(**kwargs)¶

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.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

Note

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Request Syntax

response = client.describe_configuration_settings(
    ApplicationName='string',
    TemplateName='string',
    EnvironmentName='string'
)

Parameters:

ApplicationName (string) –
[REQUIRED]

The application for the environment or configuration template.
TemplateName (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, Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, Elastic Beanstalk returns a MissingRequiredParameter error.
EnvironmentName (string) –
The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, Elastic Beanstalk returns MissingRequiredParameter error.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSettings': [
        {
            'SolutionStackName': 'string',
            'PlatformArn': '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.
    - PlatformArn (string) –
      
      The ARN of the platform version.
    - 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.
    - 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 namespaces and option values, see Option Values in the Elastic Beanstalk Developer Guide.
        
        ResourceName (string) –
        
        A unique resource name for the option setting. Use it for a time–based scaling configuration option.
        
        Namespace (string) –
        
        A unique namespace that identifies the option’s associated Amazon Web Services resource.
        
        OptionName (string) –
        
        The name of the configuration option.
        
        Value (string) –
        
        The current value for the configuration option.

Exceptions

ElasticBeanstalk.Client.exceptions.TooManyBucketsException

Examples

The following operation retrieves configuration settings for an environment named my-env:

response = client.describe_configuration_settings(
    ApplicationName='my-app',
    EnvironmentName='my-env',
)

print(response)

Expected Output:

{
    'ConfigurationSettings': [
        {
            'ApplicationName': 'my-app',
            'DateCreated': datetime(2015, 8, 13, 19, 16, 25, 3, 225, 0),
            'DateUpdated': datetime(2015, 8, 13, 23, 30, 7, 3, 225, 0),
            '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',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}