describeAvailabilityOptions method

Future<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions({ required String domainName, })

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

May throw BaseException. May throw InternalException. May throw InvalidTypeException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw DisabledOperationException.

Parameter domainName : The name of the domain you want to describe.

Implementation

Future<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions({
  required String domainName,
}) async {
  ArgumentError.checkNotNull(domainName, 'domainName');
  _s.validateStringLength(
    'domainName',
    domainName,
    3,
    28,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['DomainName'] = domainName;
  final $result = await _protocol.send(
    $request,
    action: 'DescribeAvailabilityOptions',
    version: '2011-02-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeAvailabilityOptionsRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeAvailabilityOptionsResult',
  );
  return DescribeAvailabilityOptionsResponse.fromXml($result);
}