- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetRelationalDatabaseBlueprintsCommand
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, GetRelationalDatabaseBlueprintsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetRelationalDatabaseBlueprintsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetRelationalDatabaseBlueprintsRequest
pageToken: "STRING_VALUE",
};
const command = new GetRelationalDatabaseBlueprintsCommand(input);
const response = await client.send(command);
// { // GetRelationalDatabaseBlueprintsResult
// blueprints: [ // RelationalDatabaseBlueprintList
// { // RelationalDatabaseBlueprint
// blueprintId: "STRING_VALUE",
// engine: "mysql",
// engineVersion: "STRING_VALUE",
// engineDescription: "STRING_VALUE",
// engineVersionDescription: "STRING_VALUE",
// isEngineDefault: true || false,
// },
// ],
// nextPageToken: "STRING_VALUE",
// };
GetRelationalDatabaseBlueprintsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
pageToken | string | undefined | The token to advance to the next page of results from your request. To get a page token, perform an initial |
GetRelationalDatabaseBlueprintsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
blueprints | RelationalDatabaseBlueprint[] | undefined | An object describing the result of your get relational database blueprints request. |
nextPageToken | string | undefined | The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
| AccountSetupInProgressException | client | Lightsail throws this exception when an account is still in the setup in progress state. |
| InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
| NotFoundException | client | Lightsail throws this exception when it cannot find a resource. |
| OperationFailureException | client | Lightsail throws this exception when an operation fails to execute. |
| ServiceException | server | A general service exception. |
| UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
| LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |