describe_configuration_settings ¶

def describe_configuration_settings(
    self,
    application_name: "capo_elastic_beanstalk.types.application_name.ApplicationName",
    *,
    config_overrides: Optional[ElasticBeanstalkClientConfig] = None,
    template_name: Optional[
        "capo_elastic_beanstalk.types.configuration_template_name.ConfigurationTemplateName"
    ] = None,
    environment_name: Optional[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ] = None,
) -> "capo_elastic_beanstalk.types.configuration_settings_descriptions.ConfigurationSettingsDescriptions":
    """<p>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.</p> <p>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.</p> <p>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.</p> <note> <p>The <a href="https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html">AWSElasticBeanstalkReadOnly</a> managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html"> Managing Elastic Beanstalk user policies</a> in the <i>Elastic Beanstalk Developer Guide</i>. For detailed instructions to attach a policy to a user or group, see the section <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed"> Controlling access with managed policies</a> in the same topic.</p> </note> <p>Related Topics</p> <ul> <li> <p> <a>DeleteEnvironmentConfiguration</a> </p> </li> </ul>

    Args:
        application_name: <p>The application for the environment or configuration template.</p>
        template_name: <p>The name of the configuration template to describe.</p> <p> Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </p>
        environment_name: <p>The name of the environment to describe.</p> <p> Condition: You must specify either this or a TemplateName, but not both. If you specify both, Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>

    Raises:
        capo_elastic_beanstalk.errors.too_many_buckets_exception.TooManyBucketsException: <p>The specified account has reached its limit of Amazon S3 buckets.</p>
        capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To view configurations settings for an environment
        The following operation retrieves configuration settings for an environment named my-env:

        >>> client.describe_configuration_settings(application_name='my-app', environment_name='my-env')
    """

    def _handler(
        req: "OperationRequest[capo_elastic_beanstalk.types.describe_configuration_settings_message.DescribeConfigurationSettingsMessage]",
    ) -> OperationResponse[
        "capo_elastic_beanstalk.types.configuration_settings_descriptions.ConfigurationSettingsDescriptions"
    ]:
        import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_configuration_settings

        output, http_response = (
            capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_configuration_settings.describe_configuration_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfigurationSettings")
    )
    input_: capo_elastic_beanstalk.types.describe_configuration_settings_message.DescribeConfigurationSettingsMessage = {
        "application_name": application_name
    }
    if template_name is not None:
        input_["template_name"] = template_name
    if environment_name is not None:
        input_["environment_name"] = environment_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output