amazonka-rds-1.4.5: Amazon Relational Database Service SDK.

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

Network.AWS.RDS.DownloadDBLogFilePortion

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

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 will be 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 contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens
  • ddlfpLogFileName - The name of the log file to be downloaded.

data DownloadDBLogFilePortion #

See: downloadDBLogFilePortion smart constructor.

Instances

Eq DownloadDBLogFilePortion # 
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 # 
Show DownloadDBLogFilePortion # 
Generic DownloadDBLogFilePortion # 
Hashable DownloadDBLogFilePortion # 
NFData DownloadDBLogFilePortion # 
AWSPager DownloadDBLogFilePortion # 
AWSRequest DownloadDBLogFilePortion # 
ToQuery DownloadDBLogFilePortion # 
ToPath DownloadDBLogFilePortion # 
ToHeaders DownloadDBLogFilePortion # 
type Rep DownloadDBLogFilePortion # 
type Rep DownloadDBLogFilePortion = D1 (MetaData "DownloadDBLogFilePortion" "Network.AWS.RDS.DownloadDBLogFilePortion" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" 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 # 

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 will be 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 contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

ddlfpLogFileName :: Lens' DownloadDBLogFilePortion Text #

The name of the log file to be downloaded.

Destructuring the Response

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:

data DownloadDBLogFilePortionResponse #

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

See: downloadDBLogFilePortionResponse smart constructor.

Instances

Eq DownloadDBLogFilePortionResponse # 
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 # 
Show DownloadDBLogFilePortionResponse # 
Generic DownloadDBLogFilePortionResponse # 
NFData DownloadDBLogFilePortionResponse # 
type Rep DownloadDBLogFilePortionResponse # 
type Rep DownloadDBLogFilePortionResponse = D1 (MetaData "DownloadDBLogFilePortionResponse" "Network.AWS.RDS.DownloadDBLogFilePortion" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" 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 DecidedUnpack) (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.