describeFaq method

Future<DescribeFaqResponse> describeFaq({
  1. required String id,
  2. required String indexId,
})

Gets information about an FAQ list.

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

Parameter id : The unique identifier of the FAQ.

Parameter indexId : The identifier of the index that contains the FAQ.

Implementation

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

  return DescribeFaqResponse.fromJson(jsonResponse.body);
}