describeRecommender method

Future<DescribeRecommenderResponse> describeRecommender({ required String recommenderArn, })

Describes the given recommender, including its status.

A recommender can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
• STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
• DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter recommenderArn : The Amazon Resource Name (ARN) of the recommender to describe.

Implementation

Future<DescribeRecommenderResponse> describeRecommender({
  required String recommenderArn,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonPersonalize.DescribeRecommender'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'recommenderArn': recommenderArn,
    },
  );

  return DescribeRecommenderResponse.fromJson(jsonResponse.body);
}