Amazon Lightsail
API Reference (API Version 2016-11-28)

GetRelationalDatabaseParameters

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

Request Syntax

{ "pageToken": "string", "relationalDatabaseName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

pageToken

A token used for advancing to a specific page of results for your get relational database parameters request.

Type: String

Required: No

relationalDatabaseName

The name of your database for which to get parameters.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

Response Syntax

{ "nextPageToken": "string", "parameters": [ { "allowedValues": "string", "applyMethod": "string", "applyType": "string", "dataType": "string", "description": "string", "isModifiable": boolean, "parameterName": "string", "parameterValue": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextPageToken

A token used for advancing to the next page of results from your get static IPs request.

Type: String

parameters

An object describing the result of your get relational database parameters request.

Type: Array of RelationalDatabaseParameter objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: