describeNotifyConfigurations method
Describes the specified notify configurations or all notify configurations in your account.
If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don't specify notify configuration IDs or filters, the output includes information for all notify configurations.
If you specify a notify configuration ID that isn't valid, an error is returned.
May throw AccessDeniedException.
May throw InternalServerException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
May throw ValidationException.
Parameter filters :
An array of NotifyConfigurationFilter objects to filter the results on.
Parameter maxResults :
The maximum number of results to return per each request.
Parameter nextToken :
The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
Parameter notifyConfigurationIds :
An array of notify configuration IDs to describe.
Implementation
Future<DescribeNotifyConfigurationsResult> describeNotifyConfigurations({
List<NotifyConfigurationFilter>? filters,
int? maxResults,
String? nextToken,
List<String>? notifyConfigurationIds,
}) async {
_s.validateNumRange(
'maxResults',
maxResults,
1,
100,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.0',
'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeNotifyConfigurations'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
if (filters != null) 'Filters': filters,
if (maxResults != null) 'MaxResults': maxResults,
if (nextToken != null) 'NextToken': nextToken,
if (notifyConfigurationIds != null)
'NotifyConfigurationIds': notifyConfigurationIds,
},
);
return DescribeNotifyConfigurationsResult.fromJson(jsonResponse.body);
}