listApplications method

Future<ListApplicationsResponse> listApplications({ String? exclusiveStartApplicationName, int? limit, })

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Parameter exclusiveStartApplicationName : Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

Parameter limit : Maximum number of applications to list.

Implementation

Future<ListApplicationsResponse> listApplications({
  String? exclusiveStartApplicationName,
  int? limit,
}) async {
  _s.validateStringLength(
    'exclusiveStartApplicationName',
    exclusiveStartApplicationName,
    1,
    128,
  );
  _s.validateNumRange(
    'limit',
    limit,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'KinesisAnalytics_20150814.ListApplications'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (exclusiveStartApplicationName != null)
        'ExclusiveStartApplicationName': exclusiveStartApplicationName,
      if (limit != null) 'Limit': limit,
    },
  );

  return ListApplicationsResponse.fromJson(jsonResponse.body);
}