describeServiceAccessPolicies method

Future<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies({
  1. required String domainName,
  2. bool? deployed,
})

Gets information about the access policies that control access to the domain's document and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch Developer Guide.

May throw BaseException. May throw InternalException. May throw ResourceNotFoundException.

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

Parameter deployed : Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Implementation

Future<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies({
  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: 'DescribeServiceAccessPolicies',
    version: '2013-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeServiceAccessPoliciesRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeServiceAccessPoliciesResult',
  );
  return DescribeServiceAccessPoliciesResponse.fromXml($result);
}