getBlueprints method

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

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

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 indicating whether to include inactive 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 GetBlueprints 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<GetBlueprintsResult> getBlueprints({
  bool? includeInactive,
  String? pageToken,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Lightsail_20161128.GetBlueprints'
  };
  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 GetBlueprintsResult.fromJson(jsonResponse.body);
}