GetRelationalDatabasesCommand

Suggest an Edit

Returns information about all of your databases in Amazon Lightsail.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LightsailClient, GetRelationalDatabasesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetRelationalDatabasesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetRelationalDatabasesRequest
  pageToken: "STRING_VALUE",
};
const command = new GetRelationalDatabasesCommand(input);
const response = await client.send(command);
// { // GetRelationalDatabasesResult
//   relationalDatabases: [ // RelationalDatabaseList
//     { // RelationalDatabase
//       name: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       supportCode: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       location: { // ResourceLocation
//         availabilityZone: "STRING_VALUE",
//         regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "eu-north-1",
//       },
//       resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket",
//       tags: [ // TagList
//         { // Tag
//           key: "STRING_VALUE",
//           value: "STRING_VALUE",
//         },
//       ],
//       relationalDatabaseBlueprintId: "STRING_VALUE",
//       relationalDatabaseBundleId: "STRING_VALUE",
//       masterDatabaseName: "STRING_VALUE",
//       hardware: { // RelationalDatabaseHardware
//         cpuCount: Number("int"),
//         diskSizeInGb: Number("int"),
//         ramSizeInGb: Number("float"),
//       },
//       state: "STRING_VALUE",
//       secondaryAvailabilityZone: "STRING_VALUE",
//       backupRetentionEnabled: true || false,
//       pendingModifiedValues: { // PendingModifiedRelationalDatabaseValues
//         masterUserPassword: "STRING_VALUE",
//         engineVersion: "STRING_VALUE",
//         backupRetentionEnabled: true || false,
//       },
//       engine: "STRING_VALUE",
//       engineVersion: "STRING_VALUE",
//       latestRestorableTime: new Date("TIMESTAMP"),
//       masterUsername: "STRING_VALUE",
//       parameterApplyStatus: "STRING_VALUE",
//       preferredBackupWindow: "STRING_VALUE",
//       preferredMaintenanceWindow: "STRING_VALUE",
//       publiclyAccessible: true || false,
//       masterEndpoint: { // RelationalDatabaseEndpoint
//         port: Number("int"),
//         address: "STRING_VALUE",
//       },
//       pendingMaintenanceActions: [ // PendingMaintenanceActionList
//         { // PendingMaintenanceAction
//           action: "STRING_VALUE",
//           description: "STRING_VALUE",
//           currentApplyDate: new Date("TIMESTAMP"),
//         },
//       ],
//       caCertificateIdentifier: "STRING_VALUE",
//     },
//   ],
//   nextPageToken: "STRING_VALUE",
// };

GetRelationalDatabasesCommand Input

See GetRelationalDatabasesCommandInput for more details

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 GetRelationalDatabases 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.

GetRelationalDatabasesCommand Output

See GetRelationalDatabasesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this 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 GetRelationalDatabases request and specify the next page token using the pageToken parameter.

relationalDatabases
RelationalDatabase[] | undefined

An object describing the result of your get relational databases request.

Throws

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 (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

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.