listPartnerEventSources method

Future<ListPartnerEventSourcesResponse> listPartnerEventSources({ required String namePrefix, int? limit, String? nextToken, })

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.

May throw InternalException. May throw OperationDisabledException.

Parameter namePrefix : If you specify this, the results are limited to only those partner event sources that start with the string you specify.

Parameter limit : pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

Parameter nextToken : The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Implementation

Future<ListPartnerEventSourcesResponse> listPartnerEventSources({
  required String namePrefix,
  int? limit,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSEvents.ListPartnerEventSources'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'NamePrefix': namePrefix,
      if (limit != null) 'Limit': limit,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return ListPartnerEventSourcesResponse.fromJson(jsonResponse.body);
}