describeIndex method

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

Describes a search index.

Requires permission to access the DescribeIndex action.

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

Parameter indexName : The index name.

Implementation

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