describeConfigurationSets method

Future<DescribeConfigurationSetsResult> describeConfigurationSets({
  1. List<String>? configurationSetNames,
  2. List<ConfigurationSetFilter>? filters,
  3. int? maxResults,
  4. String? nextToken,
})

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn't valid, an error is returned.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter configurationSetNames : An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

Parameter filters : An array of filters to apply to the results that are returned.

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.

Implementation

Future<DescribeConfigurationSetsResult> describeConfigurationSets({
  List<String>? configurationSetNames,
  List<ConfigurationSetFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeConfigurationSets'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (configurationSetNames != null)
        'ConfigurationSetNames': configurationSetNames,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeConfigurationSetsResult.fromJson(jsonResponse.body);
}