describeIndex method

Future<DescribeIndexResponse> describeIndex({
  1. required String indexName,
})

Describes a search index.

May throw InvalidRequestException. May throw ThrottlingException. May throw UnauthorizedException. May throw ServiceUnavailableException. May throw InternalFailureException. May throw ResourceNotFoundException.

Parameter indexName : The index name.

Implementation

Future<DescribeIndexResponse> describeIndex({
  required String indexName,
}) async {
  ArgumentError.checkNotNull(indexName, 'indexName');
  _s.validateStringLength(
    'indexName',
    indexName,
    1,
    128,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/indices/${Uri.encodeComponent(indexName)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeIndexResponse.fromJson(response);
}