describeApplication method

Future<DescribeApplicationResponse> describeApplication({
  1. required String applicationName,
  2. bool? includeAdditionalDetails,
})

Returns information about a specific Kinesis Data Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

May throw ResourceNotFoundException. May throw InvalidArgumentException. May throw InvalidRequestException.

Parameter applicationName : The name of the application.

Parameter includeAdditionalDetails : Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

Implementation

Future<DescribeApplicationResponse> describeApplication({
  required String applicationName,
  bool? includeAdditionalDetails,
}) async {
  ArgumentError.checkNotNull(applicationName, 'applicationName');
  _s.validateStringLength(
    'applicationName',
    applicationName,
    1,
    128,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'KinesisAnalytics_20180523.DescribeApplication'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ApplicationName': applicationName,
      if (includeAdditionalDetails != null)
        'IncludeAdditionalDetails': includeAdditionalDetails,
    },
  );

  return DescribeApplicationResponse.fromJson(jsonResponse.body);
}