describeDomainEndpointOptions method

Future<DescribeDomainEndpointOptionsResponse> describeDomainEndpointOptions({ required String domainName, bool? deployed, })

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

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

Parameter domainName : A string that represents the name of a domain.

Parameter deployed : Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

Implementation

Future<DescribeDomainEndpointOptionsResponse> describeDomainEndpointOptions({
  required String domainName,
  bool? deployed,
}) async {
  ArgumentError.checkNotNull(domainName, 'domainName');
  _s.validateStringLength(
    'domainName',
    domainName,
    3,
    28,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['DomainName'] = domainName;
  deployed?.also((arg) => $request['Deployed'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDomainEndpointOptions',
    version: '2013-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDomainEndpointOptionsRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeDomainEndpointOptionsResult',
  );
  return DescribeDomainEndpointOptionsResponse.fromXml($result);
}