libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Description

Returns a list of log events for a database in Amazon Lightsail.

Synopsis

Creating a Request

data GetRelationalDatabaseLogEvents Source #

See: newGetRelationalDatabaseLogEvents smart constructor.

Constructors

GetRelationalDatabaseLogEvents' 

Fields

  • startTime :: Maybe POSIX

    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.

  • startFromHead :: Maybe Bool

    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. If false is specified, the log event starts from the tail of the log.

    For PostgreSQL, the default value of false is the only option available.

  • endTime :: Maybe POSIX

    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.

  • pageToken :: Maybe Text

    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.

  • relationalDatabaseName :: Text

    The name of your database for which to get log events.

  • logStreamName :: Text

    The name of the log stream.

    Use the get relational database log streams operation to get a list of available log streams.

Instances

Instances details
Eq GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

(==) :: GetRelationalDatabaseLogEvents -> GetRelationalDatabaseLogEvents -> Bool #

(/=) :: GetRelationalDatabaseLogEvents -> GetRelationalDatabaseLogEvents -> Bool #

Read GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

readsPrec :: Int -> ReadS GetRelationalDatabaseLogEvents #

readList :: ReadS [GetRelationalDatabaseLogEvents] #

readPrec :: ReadPrec GetRelationalDatabaseLogEvents #

readListPrec :: ReadPrec [GetRelationalDatabaseLogEvents] #

Show GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

showsPrec :: Int -> GetRelationalDatabaseLogEvents -> ShowS #

show :: GetRelationalDatabaseLogEvents -> String #

showList :: [GetRelationalDatabaseLogEvents] -> ShowS #

Generic GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Associated Types

type Rep GetRelationalDatabaseLogEvents :: Type -> Type #

Methods

from :: GetRelationalDatabaseLogEvents -> Rep GetRelationalDatabaseLogEvents x #

to :: Rep GetRelationalDatabaseLogEvents x -> GetRelationalDatabaseLogEvents #

NFData GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

rnf :: GetRelationalDatabaseLogEvents -> () #

Hashable GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

hashWithSalt :: Int -> GetRelationalDatabaseLogEvents -> Int #

hash :: GetRelationalDatabaseLogEvents -> Int #

ToJSON GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

toJSON :: GetRelationalDatabaseLogEvents -> Value #

toEncoding :: GetRelationalDatabaseLogEvents -> Encoding #

toJSONList :: [GetRelationalDatabaseLogEvents] -> Value #

toEncodingList :: [GetRelationalDatabaseLogEvents] -> Encoding #

AWSRequest GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Associated Types

type AWSResponse GetRelationalDatabaseLogEvents #

Methods

request :: GetRelationalDatabaseLogEvents -> Request GetRelationalDatabaseLogEvents #

response :: MonadResource m => Logger -> Service -> Proxy GetRelationalDatabaseLogEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRelationalDatabaseLogEvents))) #

ToHeaders GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

toHeaders :: GetRelationalDatabaseLogEvents -> [Header] #

ToPath GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

toPath :: GetRelationalDatabaseLogEvents -> ByteString #

ToQuery GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

toQuery :: GetRelationalDatabaseLogEvents -> QueryString #

type Rep GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

type Rep GetRelationalDatabaseLogEvents = D1 ('MetaData "GetRelationalDatabaseLogEvents" "Amazonka.Lightsail.GetRelationalDatabaseLogEvents" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetRelationalDatabaseLogEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "startFromHead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "relationalDatabaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetRelationalDatabaseLogEvents Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

type AWSResponse GetRelationalDatabaseLogEvents = GetRelationalDatabaseLogEventsResponse

newGetRelationalDatabaseLogEvents Source #

Arguments

:: Text

$sel:relationalDatabaseName:GetRelationalDatabaseLogEvents'

-> Text

$sel:logStreamName:GetRelationalDatabaseLogEvents'

-> GetRelationalDatabaseLogEvents 

Create a value of GetRelationalDatabaseLogEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startTime:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_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.

$sel:startFromHead:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_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. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

$sel:endTime:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_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.

$sel:pageToken:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_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.

$sel:relationalDatabaseName:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_relationalDatabaseName - The name of your database for which to get log events.

$sel:logStreamName:GetRelationalDatabaseLogEvents', getRelationalDatabaseLogEvents_logStreamName - The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

Request Lenses

getRelationalDatabaseLogEvents_startTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

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.

getRelationalDatabaseLogEvents_startFromHead :: Lens' GetRelationalDatabaseLogEvents (Maybe Bool) Source #

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. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

getRelationalDatabaseLogEvents_endTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

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.

getRelationalDatabaseLogEvents_pageToken :: Lens' GetRelationalDatabaseLogEvents (Maybe Text) Source #

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.

getRelationalDatabaseLogEvents_relationalDatabaseName :: Lens' GetRelationalDatabaseLogEvents Text Source #

The name of your database for which to get log events.

getRelationalDatabaseLogEvents_logStreamName :: Lens' GetRelationalDatabaseLogEvents Text Source #

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

Destructuring the Response

data GetRelationalDatabaseLogEventsResponse Source #

See: newGetRelationalDatabaseLogEventsResponse smart constructor.

Constructors

GetRelationalDatabaseLogEventsResponse' 

Fields

Instances

Instances details
Eq GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

(==) :: GetRelationalDatabaseLogEventsResponse -> GetRelationalDatabaseLogEventsResponse -> Bool #

(/=) :: GetRelationalDatabaseLogEventsResponse -> GetRelationalDatabaseLogEventsResponse -> Bool #

Read GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

readsPrec :: Int -> ReadS GetRelationalDatabaseLogEventsResponse #

readList :: ReadS [GetRelationalDatabaseLogEventsResponse] #

readPrec :: ReadPrec GetRelationalDatabaseLogEventsResponse #

readListPrec :: ReadPrec [GetRelationalDatabaseLogEventsResponse] #

Show GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

showsPrec :: Int -> GetRelationalDatabaseLogEventsResponse -> ShowS #

show :: GetRelationalDatabaseLogEventsResponse -> String #

showList :: [GetRelationalDatabaseLogEventsResponse] -> ShowS #

Generic GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Associated Types

type Rep GetRelationalDatabaseLogEventsResponse :: Type -> Type #

Methods

from :: GetRelationalDatabaseLogEventsResponse -> Rep GetRelationalDatabaseLogEventsResponse x #

to :: Rep GetRelationalDatabaseLogEventsResponse x -> GetRelationalDatabaseLogEventsResponse #

NFData GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

Methods

rnf :: GetRelationalDatabaseLogEventsResponse -> () #

type Rep GetRelationalDatabaseLogEventsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetRelationalDatabaseLogEvents

type Rep GetRelationalDatabaseLogEventsResponse = D1 ('MetaData "GetRelationalDatabaseLogEventsResponse" "Amazonka.Lightsail.GetRelationalDatabaseLogEvents" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetRelationalDatabaseLogEventsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextBackwardToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceLogEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogEvent]))) :*: (S1 ('MetaSel ('Just "nextForwardToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRelationalDatabaseLogEventsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetRelationalDatabaseLogEventsResponse'

-> GetRelationalDatabaseLogEventsResponse 

Create a value of GetRelationalDatabaseLogEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextBackwardToken:GetRelationalDatabaseLogEventsResponse', getRelationalDatabaseLogEventsResponse_nextBackwardToken - A token used for advancing to the previous page of results from your get relational database log events request.

$sel:resourceLogEvents:GetRelationalDatabaseLogEventsResponse', getRelationalDatabaseLogEventsResponse_resourceLogEvents - An object describing the result of your get relational database log events request.

$sel:nextForwardToken:GetRelationalDatabaseLogEventsResponse', getRelationalDatabaseLogEventsResponse_nextForwardToken - A token used for advancing to the next page of results from your get relational database log events request.

$sel:httpStatus:GetRelationalDatabaseLogEventsResponse', getRelationalDatabaseLogEventsResponse_httpStatus - The response's http status code.

Response Lenses

getRelationalDatabaseLogEventsResponse_nextBackwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

A token used for advancing to the previous page of results from your get relational database log events request.

getRelationalDatabaseLogEventsResponse_resourceLogEvents :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe [LogEvent]) Source #

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

getRelationalDatabaseLogEventsResponse_nextForwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

A token used for advancing to the next page of results from your get relational database log events request.

getRelationalDatabaseLogEventsResponse_httpStatus :: Lens' GetRelationalDatabaseLogEventsResponse Int Source #

The response's http status code.