import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConfigurationSettingsDescriptions, DescribeConfigurationSettingsMessage } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeConfigurationSettingsCommand}. */ export interface DescribeConfigurationSettingsCommandInput extends DescribeConfigurationSettingsMessage { } /** * @public * * The output of {@link DescribeConfigurationSettingsCommand}. */ export interface DescribeConfigurationSettingsCommandOutput extends ConfigurationSettingsDescriptions, __MetadataBearer { } declare const DescribeConfigurationSettingsCommand_base: { new (input: DescribeConfigurationSettingsCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeConfigurationSettingsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

* *

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.

*
*

Related Topics

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElasticBeanstalkClient, DescribeConfigurationSettingsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import * // const { ElasticBeanstalkClient, DescribeConfigurationSettingsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import * // import type { ElasticBeanstalkClientConfig } from "@aws-sdk/client-elastic-beanstalk"; * const config = {}; // type is ElasticBeanstalkClientConfig * const client = new ElasticBeanstalkClient(config); * const input = { // DescribeConfigurationSettingsMessage * ApplicationName: "STRING_VALUE", // required * TemplateName: "STRING_VALUE", * EnvironmentName: "STRING_VALUE", * }; * const command = new DescribeConfigurationSettingsCommand(input); * const response = await client.send(command); * // { // ConfigurationSettingsDescriptions * // ConfigurationSettings: [ // ConfigurationSettingsDescriptionList * // { // ConfigurationSettingsDescription * // SolutionStackName: "STRING_VALUE", * // PlatformArn: "STRING_VALUE", * // ApplicationName: "STRING_VALUE", * // TemplateName: "STRING_VALUE", * // Description: "STRING_VALUE", * // EnvironmentName: "STRING_VALUE", * // DeploymentStatus: "deployed" || "pending" || "failed", * // DateCreated: new Date("TIMESTAMP"), * // DateUpdated: new Date("TIMESTAMP"), * // OptionSettings: [ // ConfigurationOptionSettingsList * // { // ConfigurationOptionSetting * // ResourceName: "STRING_VALUE", * // Namespace: "STRING_VALUE", * // OptionName: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }; * * ``` * * @param DescribeConfigurationSettingsCommandInput - {@link DescribeConfigurationSettingsCommandInput} * @returns {@link DescribeConfigurationSettingsCommandOutput} * @see {@link DescribeConfigurationSettingsCommandInput} for command's `input` shape. * @see {@link DescribeConfigurationSettingsCommandOutput} for command's `response` shape. * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape. * * @throws {@link TooManyBucketsException} (client fault) *

The specified account has reached its limit of Amazon S3 buckets.

* * @throws {@link ElasticBeanstalkSyntheticServiceException} *

Base exception class for all service exceptions from ElasticBeanstalk service.

* * * @example To view configurations settings for an environment * ```javascript * // The following operation retrieves configuration settings for an environment named my-env: * const input = { * ApplicationName: "my-app", * EnvironmentName: "my-env" * }; * const command = new DescribeConfigurationSettingsCommand(input); * const response = await client.send(command); * /* response is * { * ConfigurationSettings: [ * { * ApplicationName: "my-app", * DateCreated: "2015-08-13T19:16:25Z", * DateUpdated: "2015-08-13T23:30:07Z", * 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" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeConfigurationSettingsCommand extends DescribeConfigurationSettingsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeConfigurationSettingsMessage; output: ConfigurationSettingsDescriptions; }; sdk: { input: DescribeConfigurationSettingsCommandInput; output: DescribeConfigurationSettingsCommandOutput; }; }; }