GetRelationalDatabaseLogEvents
Returns a list of log events for a database in Amazon Lightsail.
Request Syntax
{
"endTime": number
,
"logStreamName": "string
",
"pageToken": "string
",
"relationalDatabaseName": "string
",
"startFromHead": boolean
,
"startTime": number
}
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.
- endTime
-
The end of the time interval from which to get log events.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the end time.
Type: Timestamp
Required: No
-
- logStreamName
-
The name of the log stream.
Use the
get relational database log streams
operation to get a list of available log streams.Type: String
Required: Yes
- pageToken
-
The token to advance to the next or previous page of results from your request.
To get a page token, perform an initial
GetRelationalDatabaseLogEvents
request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.Type: String
Required: No
- relationalDatabaseName
-
The name of your database for which to get log events.
Type: String
Pattern:
\w[\w\-]*\w
Required: Yes
- startFromHead
-
Parameter to specify if the log should start from head or tail. If
true
is specified, the log event starts from the head of the log. Iffalse
is specified, the log event starts from the tail of the log.Note
For PostgreSQL, the default value of
false
is the only option available.Type: Boolean
Required: No
- startTime
-
The start of the time interval from which to get log events.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the start time.
Type: Timestamp
Required: No
-
Response Syntax
{
"nextBackwardToken": "string",
"nextForwardToken": "string",
"resourceLogEvents": [
{
"createdAt": number,
"message": "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.
- nextBackwardToken
-
A token used for advancing to the previous page of results from your get relational database log events request.
Type: String
- nextForwardToken
-
A token used for advancing to the next page of results from your get relational database log events request.
Type: String
- resourceLogEvents
-
An object describing the result of your get relational database log events request.
Type: Array of LogEvent 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 and distribution APIs are only available in the N. Virginia (
us-east-1
) AWS Region. Please set your AWS Region configuration tous-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: