describeEventSubscriptions method
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon
Redshift returns all event notification subscriptions that match any
combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and
admin
and test
for tag values, all subscriptions
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
May throw SubscriptionNotFoundFault. May throw InvalidTagFault.
Parameter marker
:
An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeEventSubscriptions request
exceed the value specified in MaxRecords
, AWS returns a value
in the Marker
field of the response. You can retrieve the
next set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.
Parameter maxRecords
:
The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next set
of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
Parameter subscriptionName
:
The name of the Amazon Redshift event notification subscription to be
described.
Parameter tagKeys
:
A tag key or keys for which you want to return all matching event
notification subscriptions that are associated with the specified key or
keys. For example, suppose that you have subscriptions that are tagged
with keys called owner
and environment
. If you
specify both of these tag keys in the request, Amazon Redshift returns a
response with the subscriptions that have either or both of these tag keys
associated with them.
Parameter tagValues
:
A tag value or values for which you want to return all matching event
notification subscriptions that are associated with the specified tag
value or values. For example, suppose that you have subscriptions that are
tagged with values called admin
and test
. If you
specify both of these tag values in the request, Amazon Redshift returns a
response with the subscriptions that have either or both of these tag
values associated with them.
Implementation
Future<EventSubscriptionsMessage> describeEventSubscriptions({
String? marker,
int? maxRecords,
String? subscriptionName,
List<String>? tagKeys,
List<String>? tagValues,
}) async {
_s.validateStringLength(
'marker',
marker,
0,
2147483647,
);
_s.validateStringLength(
'subscriptionName',
subscriptionName,
0,
2147483647,
);
final $request = <String, dynamic>{};
marker?.also((arg) => $request['Marker'] = arg);
maxRecords?.also((arg) => $request['MaxRecords'] = arg);
subscriptionName?.also((arg) => $request['SubscriptionName'] = arg);
tagKeys?.also((arg) => $request['TagKeys'] = arg);
tagValues?.also((arg) => $request['TagValues'] = arg);
final $result = await _protocol.send(
$request,
action: 'DescribeEventSubscriptions',
version: '2012-12-01',
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
shape: shapes['DescribeEventSubscriptionsMessage'],
shapes: shapes,
resultWrapper: 'DescribeEventSubscriptionsResult',
);
return EventSubscriptionsMessage.fromXml($result);
}