:doc:`ElasticBeanstalk <../../elasticbeanstalk>` / Client / describe_configuration_settings

*******************************
describe_configuration_settings
*******************************



.. py:method:: 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.

   

  Related Topics

   

  
  *  DeleteEnvironmentConfiguration
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeConfigurationSettings>`_  


  **Request Syntax**
  ::

    response = client.describe_configuration_settings(
        ApplicationName='string',
        TemplateName='string',
        EnvironmentName='string'
    )
    
  :type ApplicationName: string
  :param ApplicationName: **[REQUIRED]** 

    The application for the environment or configuration template.

    

  
  :type TemplateName: string
  :param 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 EnvironmentName: string
  :param 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.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html>`__ in the *AWS 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 AWS resource.

                
              

              - **OptionName** *(string) --* 

                The name of the configuration option.

                
              

              - **Value** *(string) --* 

                The current value for the configuration option.

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`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': {
            '...': '...',
        },
    }

  