describeConfigurationOptions method

Future<ConfigurationOptionsDescription> describeConfigurationOptions({ String? applicationName, String? environmentName, List<OptionSpecification>? options, String? platformArn, String? solutionStackName, String? templateName, })

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.

May throw TooManyBucketsException.

Parameter applicationName : The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Parameter environmentName : The name of the environment whose configuration options you want to describe.

Parameter options : If specified, restricts the descriptions to only the specified options.

Parameter platformArn : The ARN of the custom platform.

Parameter solutionStackName : The name of the solution stack whose configuration options you want to describe.

Parameter templateName : The name of the configuration template whose configuration options you want to describe.

Implementation

Future<ConfigurationOptionsDescription> describeConfigurationOptions({
  String? applicationName,
  String? environmentName,
  List<OptionSpecification>? options,
  String? platformArn,
  String? solutionStackName,
  String? templateName,
}) async {
  _s.validateStringLength(
    'applicationName',
    applicationName,
    1,
    100,
  );
  _s.validateStringLength(
    'environmentName',
    environmentName,
    4,
    40,
  );
  _s.validateStringLength(
    'templateName',
    templateName,
    1,
    100,
  );
  final $request = <String, dynamic>{};
  applicationName?.also((arg) => $request['ApplicationName'] = arg);
  environmentName?.also((arg) => $request['EnvironmentName'] = arg);
  options?.also((arg) => $request['Options'] = arg);
  platformArn?.also((arg) => $request['PlatformArn'] = arg);
  solutionStackName?.also((arg) => $request['SolutionStackName'] = arg);
  templateName?.also((arg) => $request['TemplateName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeConfigurationOptions',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeConfigurationOptionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeConfigurationOptionsResult',
  );
  return ConfigurationOptionsDescription.fromXml($result);
}