describeIndex method

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

Describes an existing Amazon Kendra index

May throw ValidationException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw AccessDeniedException. May throw InternalServerException.

Parameter id : The name of the index to describe.

Implementation

Future<DescribeIndexResponse> describeIndex({
  required String id,
}) async {
  ArgumentError.checkNotNull(id, 'id');
  _s.validateStringLength(
    'id',
    id,
    36,
    36,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSKendraFrontendService.DescribeIndex'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Id': id,
    },
  );

  return DescribeIndexResponse.fromJson(jsonResponse.body);
}