listPricingPlans method

Future<ListPricingPlansOutput> listPricingPlans({
  1. String? billingPeriod,
  2. ListPricingPlansFilter? filters,
  3. int? maxResults,
  4. String? nextToken,
})

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.

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

Parameter billingPeriod : The preferred billing period to get pricing plan.

Parameter filters : A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

Parameter maxResults : The maximum number of pricing plans to retrieve.

Parameter nextToken : The pagination token that's used on subsequent call to get pricing plans.

Implementation

Future<ListPricingPlansOutput> listPricingPlans({
  String? billingPeriod,
  ListPricingPlansFilter? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $payload = <String, dynamic>{
    if (billingPeriod != null) 'BillingPeriod': billingPeriod,
    if (filters != null) 'Filters': filters,
    if (maxResults != null) 'MaxResults': maxResults,
    if (nextToken != null) 'NextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/list-pricing-plans',
    exceptionFnMap: _exceptionFns,
  );
  return ListPricingPlansOutput.fromJson(response);
}