getBundles method

Future<GetBundlesResult> getBundles({
  1. bool? includeInactive,
  2. String? pageToken,
})

Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).

May throw ServiceException. May throw InvalidInputException. May throw NotFoundException. May throw OperationFailureException. May throw AccessDeniedException. May throw AccountSetupInProgressException. May throw UnauthenticatedException.

Parameter includeInactive : A Boolean value that indicates whether to include inactive bundle results in your request.

Parameter pageToken : The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Implementation

Future<GetBundlesResult> getBundles({
  bool? includeInactive,
  String? pageToken,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Lightsail_20161128.GetBundles'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (includeInactive != null) 'includeInactive': includeInactive,
      if (pageToken != null) 'pageToken': pageToken,
    },
  );

  return GetBundlesResult.fromJson(jsonResponse.body);
}