Network.AWS.RDS.DownloadDBLogFilePortion

Downloads all or a portion of the specified log file, up to 1 MB in size.

This operation returns paginated results.

Creating a Request

downloadDBLogFilePortion

Arguments

:: Text

ddlfpDBInstanceIdentifier

-> Text

ddlfpLogFileName

-> DownloadDBLogFilePortion

Creates a value of DownloadDBLogFilePortion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddlfpNumberOfLines - The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. * If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. * If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. * If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. * You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
• ddlfpMarker - The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
• ddlfpDBInstanceIdentifier - The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: * Must match the identifier of an existing DBInstance.
• ddlfpLogFileName - The name of the log file to be downloaded.

data DownloadDBLogFilePortion

See: downloadDBLogFilePortion smart constructor.

Instances

Eq DownloadDBLogFilePortion

Methods

(==) :: DownloadDBLogFilePortion -> DownloadDBLogFilePortion -> Bool

(/=) :: DownloadDBLogFilePortion -> DownloadDBLogFilePortion -> Bool

Data DownloadDBLogFilePortion

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DownloadDBLogFilePortion -> c DownloadDBLogFilePortion

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DownloadDBLogFilePortion

toConstr :: DownloadDBLogFilePortion -> Constr

dataTypeOf :: DownloadDBLogFilePortion -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DownloadDBLogFilePortion)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DownloadDBLogFilePortion)

gmapT :: (forall b. Data b => b -> b) -> DownloadDBLogFilePortion -> DownloadDBLogFilePortion

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DownloadDBLogFilePortion -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DownloadDBLogFilePortion -> r

gmapQ :: (forall d. Data d => d -> u) -> DownloadDBLogFilePortion -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DownloadDBLogFilePortion -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortion -> m DownloadDBLogFilePortion

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortion -> m DownloadDBLogFilePortion

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortion -> m DownloadDBLogFilePortion

Read DownloadDBLogFilePortion

Methods

readsPrec :: Int -> ReadS DownloadDBLogFilePortion

readList :: ReadS [DownloadDBLogFilePortion]

readPrec :: ReadPrec DownloadDBLogFilePortion

readListPrec :: ReadPrec [DownloadDBLogFilePortion]

Show DownloadDBLogFilePortion

Methods

showsPrec :: Int -> DownloadDBLogFilePortion -> ShowS

show :: DownloadDBLogFilePortion -> String

showList :: [DownloadDBLogFilePortion] -> ShowS

Generic DownloadDBLogFilePortion

Associated Types

type Rep DownloadDBLogFilePortion :: * -> *

Methods

from :: DownloadDBLogFilePortion -> Rep DownloadDBLogFilePortion x

to :: Rep DownloadDBLogFilePortion x -> DownloadDBLogFilePortion

Hashable DownloadDBLogFilePortion

Methods

hashWithSalt :: Int -> DownloadDBLogFilePortion -> Int

hash :: DownloadDBLogFilePortion -> Int

NFData DownloadDBLogFilePortion

Methods

rnf :: DownloadDBLogFilePortion -> ()

AWSPager DownloadDBLogFilePortion

Methods

page :: DownloadDBLogFilePortion -> Rs DownloadDBLogFilePortion -> Maybe DownloadDBLogFilePortion

AWSRequest DownloadDBLogFilePortion

Associated Types

type Rs DownloadDBLogFilePortion :: *

Methods

request :: DownloadDBLogFilePortion -> Request DownloadDBLogFilePortion

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DownloadDBLogFilePortion -> ClientResponse -> m (Response DownloadDBLogFilePortion)

ToHeaders DownloadDBLogFilePortion

Methods

toHeaders :: DownloadDBLogFilePortion -> [Header]

ToPath DownloadDBLogFilePortion

Methods

toPath :: DownloadDBLogFilePortion -> ByteString

ToQuery DownloadDBLogFilePortion

Methods

toQuery :: DownloadDBLogFilePortion -> QueryString

type Rep DownloadDBLogFilePortion

type Rep DownloadDBLogFilePortion = D1 * (MetaData "DownloadDBLogFilePortion" "Network.AWS.RDS.DownloadDBLogFilePortion" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DownloadDBLogFilePortion'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ddlfpNumberOfLines") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ddlfpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddlfpDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ddlfpLogFileName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs DownloadDBLogFilePortion

type Rs DownloadDBLogFilePortion = DownloadDBLogFilePortionResponse

Request Lenses

ddlfpNumberOfLines :: Lens' DownloadDBLogFilePortion (Maybe Int)

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. * If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. * If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. * If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. * You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

ddlfpMarker :: Lens' DownloadDBLogFilePortion (Maybe Text)

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

ddlfpDBInstanceIdentifier :: Lens' DownloadDBLogFilePortion Text

The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: * Must match the identifier of an existing DBInstance.

ddlfpLogFileName :: Lens' DownloadDBLogFilePortion Text

The name of the log file to be downloaded.

Destructuring the Response

downloadDBLogFilePortionResponse

Arguments

:: Int

ddlfprsResponseStatus

-> DownloadDBLogFilePortionResponse

Creates a value of DownloadDBLogFilePortionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddlfprsLogFileData - Entries from the specified log file.
• ddlfprsAdditionalDataPending - Boolean value that if true, indicates there is more data to be downloaded.
• ddlfprsMarker - A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
• ddlfprsResponseStatus - -- | The response status code.

data DownloadDBLogFilePortionResponse

This data type is used as a response element to DownloadDBLogFilePortion .

See: downloadDBLogFilePortionResponse smart constructor.

Instances

Eq DownloadDBLogFilePortionResponse

Methods

(==) :: DownloadDBLogFilePortionResponse -> DownloadDBLogFilePortionResponse -> Bool

(/=) :: DownloadDBLogFilePortionResponse -> DownloadDBLogFilePortionResponse -> Bool

Data DownloadDBLogFilePortionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DownloadDBLogFilePortionResponse -> c DownloadDBLogFilePortionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DownloadDBLogFilePortionResponse

toConstr :: DownloadDBLogFilePortionResponse -> Constr

dataTypeOf :: DownloadDBLogFilePortionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DownloadDBLogFilePortionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DownloadDBLogFilePortionResponse)

gmapT :: (forall b. Data b => b -> b) -> DownloadDBLogFilePortionResponse -> DownloadDBLogFilePortionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DownloadDBLogFilePortionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DownloadDBLogFilePortionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DownloadDBLogFilePortionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DownloadDBLogFilePortionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortionResponse -> m DownloadDBLogFilePortionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortionResponse -> m DownloadDBLogFilePortionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DownloadDBLogFilePortionResponse -> m DownloadDBLogFilePortionResponse

Read DownloadDBLogFilePortionResponse

Methods

readsPrec :: Int -> ReadS DownloadDBLogFilePortionResponse

readList :: ReadS [DownloadDBLogFilePortionResponse]

readPrec :: ReadPrec DownloadDBLogFilePortionResponse

readListPrec :: ReadPrec [DownloadDBLogFilePortionResponse]

Show DownloadDBLogFilePortionResponse

Methods

showsPrec :: Int -> DownloadDBLogFilePortionResponse -> ShowS

show :: DownloadDBLogFilePortionResponse -> String

showList :: [DownloadDBLogFilePortionResponse] -> ShowS

Generic DownloadDBLogFilePortionResponse

Associated Types

type Rep DownloadDBLogFilePortionResponse :: * -> *

Methods

from :: DownloadDBLogFilePortionResponse -> Rep DownloadDBLogFilePortionResponse x

to :: Rep DownloadDBLogFilePortionResponse x -> DownloadDBLogFilePortionResponse

NFData DownloadDBLogFilePortionResponse

Methods

rnf :: DownloadDBLogFilePortionResponse -> ()

type Rep DownloadDBLogFilePortionResponse

type Rep DownloadDBLogFilePortionResponse = D1 * (MetaData "DownloadDBLogFilePortionResponse" "Network.AWS.RDS.DownloadDBLogFilePortion" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DownloadDBLogFilePortionResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ddlfprsLogFileData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ddlfprsAdditionalDataPending") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddlfprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ddlfprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ddlfprsLogFileData :: Lens' DownloadDBLogFilePortionResponse (Maybe Text)

Entries from the specified log file.

ddlfprsAdditionalDataPending :: Lens' DownloadDBLogFilePortionResponse (Maybe Bool)

Boolean value that if true, indicates there is more data to be downloaded.

ddlfprsMarker :: Lens' DownloadDBLogFilePortionResponse (Maybe Text)

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

ddlfprsResponseStatus :: Lens' DownloadDBLogFilePortionResponse Int

• - | The response status code.