Lightsail / Client / get_relational_database_parameters

get_relational_database_parameters#

Lightsail.Client.get_relational_database_parameters(**kwargs)#

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

response = client.get_relational_database_parameters(
    relationalDatabaseName='string',
    pageToken='string'
)

Parameters:

relationalDatabaseName (string) –
[REQUIRED]

The name of your database for which to get parameters.
pageToken (string) –
The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseParameters 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.

Return type:

dict

Returns:

Response Syntax

{
    'parameters': [
        {
            'allowedValues': 'string',
            'applyMethod': 'string',
            'applyType': 'string',
            'dataType': 'string',
            'description': 'string',
            'isModifiable': True|False,
            'parameterName': 'string',
            'parameterValue': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- parameters (list) –
  
  An object describing the result of your get relational database parameters request.
  - (dict) –
    
    Describes the parameters of a database.
    - allowedValues (string) –
      
      Specifies the valid range of values for the parameter.
    - applyMethod (string) –
      
      Indicates when parameter updates are applied.
      
      Can be immediate or pending-reboot.
    - applyType (string) –
      
      Specifies the engine-specific parameter type.
    - dataType (string) –
      
      Specifies the valid data type for the parameter.
    - description (string) –
      
      Provides a description of the parameter.
    - isModifiable (boolean) –
      
      A Boolean value indicating whether the parameter can be modified.
    - parameterName (string) –
      
      Specifies the name of the parameter.
    - parameterValue (string) –
      
      Specifies the value of the parameter.
- nextPageToken (string) –
  
  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 GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.AccountSetupInProgressException
Lightsail.Client.exceptions.UnauthenticatedException