describeConfigurationSettings method

Future<ConfigurationSettingsDescriptions> describeConfigurationSettings({ required String applicationName, String? environmentName, String? templateName, })

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

May throw TooManyBucketsException.

Parameter applicationName : The application for the environment or configuration template.

Parameter 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.

Parameter 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.

Implementation

Future<ConfigurationSettingsDescriptions> describeConfigurationSettings({
  required String applicationName,
  String? environmentName,
  String? templateName,
}) async {
  ArgumentError.checkNotNull(applicationName, 'applicationName');
  _s.validateStringLength(
    'applicationName',
    applicationName,
    1,
    100,
    isRequired: true,
  );
  _s.validateStringLength(
    'environmentName',
    environmentName,
    4,
    40,
  );
  _s.validateStringLength(
    'templateName',
    templateName,
    1,
    100,
  );
  final $request = <String, dynamic>{};
  $request['ApplicationName'] = applicationName;
  environmentName?.also((arg) => $request['EnvironmentName'] = arg);
  templateName?.also((arg) => $request['TemplateName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeConfigurationSettings',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeConfigurationSettingsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeConfigurationSettingsResult',
  );
  return ConfigurationSettingsDescriptions.fromXml($result);
}