describeEventSubscriptions method

Future<DescribeEventSubscriptionsResponse> describeEventSubscriptions({ List<Filter>? filters, String? marker, int? maxRecords, String? subscriptionName, })

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

May throw ResourceNotFoundFault.

Parameter filters : Filters applied to event subscriptions.

Parameter marker : An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameter subscriptionName : The name of the AWS DMS event subscription to be described.

Implementation

Future<DescribeEventSubscriptionsResponse> describeEventSubscriptions({
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
  String? subscriptionName,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.DescribeEventSubscriptions'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (marker != null) 'Marker': marker,
      if (maxRecords != null) 'MaxRecords': maxRecords,
      if (subscriptionName != null) 'SubscriptionName': subscriptionName,
    },
  );

  return DescribeEventSubscriptionsResponse.fromJson(jsonResponse.body);
}