import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConfigurationOptionsDescription, DescribeConfigurationOptionsMessage } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeConfigurationOptionsCommand}. */ export interface DescribeConfigurationOptionsCommandInput extends DescribeConfigurationOptionsMessage { } /** * @public * * The output of {@link DescribeConfigurationOptionsCommand}. */ export interface DescribeConfigurationOptionsCommandOutput extends ConfigurationOptionsDescription, __MetadataBearer { } declare const DescribeConfigurationOptionsCommand_base: { new (input: DescribeConfigurationOptionsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeConfigurationOptionsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the configuration options that are used in a particular configuration * template or environment, or that a specified solution stack defines. The description includes * the values the options, their default values, and an indication of the required action on a * running environment if an option value is changed.

*

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.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElasticBeanstalkClient, DescribeConfigurationOptionsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import * // const { ElasticBeanstalkClient, DescribeConfigurationOptionsCommand } = 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 = { // DescribeConfigurationOptionsMessage * ApplicationName: "STRING_VALUE", * TemplateName: "STRING_VALUE", * EnvironmentName: "STRING_VALUE", * SolutionStackName: "STRING_VALUE", * PlatformArn: "STRING_VALUE", * Options: [ // OptionsSpecifierList * { // OptionSpecification * ResourceName: "STRING_VALUE", * Namespace: "STRING_VALUE", * OptionName: "STRING_VALUE", * }, * ], * }; * const command = new DescribeConfigurationOptionsCommand(input); * const response = await client.send(command); * // { // ConfigurationOptionsDescription * // SolutionStackName: "STRING_VALUE", * // PlatformArn: "STRING_VALUE", * // Options: [ // ConfigurationOptionDescriptionsList * // { // ConfigurationOptionDescription * // Namespace: "STRING_VALUE", * // Name: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // ChangeSeverity: "STRING_VALUE", * // UserDefined: true || false, * // ValueType: "Scalar" || "List", * // ValueOptions: [ // ConfigurationOptionPossibleValues * // "STRING_VALUE", * // ], * // MinValue: Number("int"), * // MaxValue: Number("int"), * // MaxLength: Number("int"), * // Regex: { // OptionRestrictionRegex * // Pattern: "STRING_VALUE", * // Label: "STRING_VALUE", * // }, * // }, * // ], * // }; * * ``` * * @param DescribeConfigurationOptionsCommandInput - {@link DescribeConfigurationOptionsCommandInput} * @returns {@link DescribeConfigurationOptionsCommandOutput} * @see {@link DescribeConfigurationOptionsCommandInput} for command's `input` shape. * @see {@link DescribeConfigurationOptionsCommandOutput} 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 configuration options for an environment * ```javascript * // The following operation retrieves descriptions of all available configuration options for an environment named my-env: * const input = { * ApplicationName: "my-app", * EnvironmentName: "my-env" * }; * const command = new DescribeConfigurationOptionsCommand(input); * const response = await client.send(command); * /* response is * { * Options: [ * { * ChangeSeverity: "NoInterruption", * DefaultValue: "30", * MaxValue: 300, * MinValue: 5, * Name: "Interval", * Namespace: "aws:elb:healthcheck", * UserDefined: false, * ValueType: "Scalar" * }, * { * ChangeSeverity: "NoInterruption", * DefaultValue: "2000000", * MinValue: 0, * Name: "LowerThreshold", * Namespace: "aws:autoscaling:trigger", * UserDefined: false, * ValueType: "Scalar" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeConfigurationOptionsCommand extends DescribeConfigurationOptionsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeConfigurationOptionsMessage; output: ConfigurationOptionsDescription; }; sdk: { input: DescribeConfigurationOptionsCommandInput; output: DescribeConfigurationOptionsCommandOutput; }; }; }