Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.DownloadDBLogFilePortion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data DownloadDBLogFilePortion Source #

See: newDownloadDBLogFilePortion smart constructor.

Constructors

DownloadDBLogFilePortion'

Fields

numberOfLines :: 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 isn't 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.
marker :: 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.
dbInstanceIdentifier :: 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.
logFileName :: Text
The name of the log file to be downloaded.

Instances

Instances details

Eq DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods (==) :: DownloadDBLogFilePortion -> DownloadDBLogFilePortion -> Bool # (/=) :: DownloadDBLogFilePortion -> DownloadDBLogFilePortion -> Bool #
Read DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods readsPrec :: Int -> ReadS DownloadDBLogFilePortion # readList :: ReadS [DownloadDBLogFilePortion] # readPrec :: ReadPrec DownloadDBLogFilePortion # readListPrec :: ReadPrec [DownloadDBLogFilePortion] #
Show DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods showsPrec :: Int -> DownloadDBLogFilePortion -> ShowS # show :: DownloadDBLogFilePortion -> String # showList :: [DownloadDBLogFilePortion] -> ShowS #
Generic DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Associated Types type Rep DownloadDBLogFilePortion :: Type -> Type # Methods from :: DownloadDBLogFilePortion -> Rep DownloadDBLogFilePortion x # to :: Rep DownloadDBLogFilePortion x -> DownloadDBLogFilePortion #
NFData DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods rnf :: DownloadDBLogFilePortion -> () #
Hashable DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods hashWithSalt :: Int -> DownloadDBLogFilePortion -> Int # hash :: DownloadDBLogFilePortion -> Int #
AWSPager DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods page :: DownloadDBLogFilePortion -> AWSResponse DownloadDBLogFilePortion -> Maybe DownloadDBLogFilePortion #
AWSRequest DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Associated Types type AWSResponse DownloadDBLogFilePortion # Methods request :: DownloadDBLogFilePortion -> Request DownloadDBLogFilePortion # response :: MonadResource m => Logger -> Service -> Proxy DownloadDBLogFilePortion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DownloadDBLogFilePortion))) #
ToHeaders DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods toHeaders :: DownloadDBLogFilePortion -> [Header] #
ToPath DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods toPath :: DownloadDBLogFilePortion -> ByteString #
ToQuery DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods toQuery :: DownloadDBLogFilePortion -> QueryString #
type Rep DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion type Rep DownloadDBLogFilePortion = D1 ('MetaData "DownloadDBLogFilePortion" "Amazonka.RDS.DownloadDBLogFilePortion" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DownloadDBLogFilePortion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numberOfLines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logFileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DownloadDBLogFilePortion Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion type AWSResponse DownloadDBLogFilePortion = DownloadDBLogFilePortionResponse

newDownloadDBLogFilePortion Source #

Arguments

:: Text	`$sel:dbInstanceIdentifier:DownloadDBLogFilePortion'`
-> Text	`$sel:logFileName:DownloadDBLogFilePortion'`
-> DownloadDBLogFilePortion

Create a value of DownloadDBLogFilePortion 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:numberOfLines:DownloadDBLogFilePortion', downloadDBLogFilePortion_numberOfLines - 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 isn't 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.

$sel:marker:DownloadDBLogFilePortion', downloadDBLogFilePortion_marker - 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.

$sel:dbInstanceIdentifier:DownloadDBLogFilePortion', downloadDBLogFilePortion_dbInstanceIdentifier - 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.

$sel:logFileName:DownloadDBLogFilePortion', downloadDBLogFilePortion_logFileName - The name of the log file to be downloaded.

Request Lenses

downloadDBLogFilePortion_numberOfLines :: Lens' DownloadDBLogFilePortion (Maybe Int) Source #

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 isn't 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.

downloadDBLogFilePortion_marker :: Lens' DownloadDBLogFilePortion (Maybe Text) Source #

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.

downloadDBLogFilePortion_dbInstanceIdentifier :: Lens' DownloadDBLogFilePortion Text Source #

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.

downloadDBLogFilePortion_logFileName :: Lens' DownloadDBLogFilePortion Text Source #

The name of the log file to be downloaded.

Destructuring the Response

data DownloadDBLogFilePortionResponse Source #

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

See: newDownloadDBLogFilePortionResponse smart constructor.

Constructors

DownloadDBLogFilePortionResponse'
Fields logFileData :: Maybe Text Entries from the specified log file. additionalDataPending :: Maybe Bool Boolean value that if true, indicates there is more data to be downloaded. marker :: Maybe Text A pagination token that can be used in a later DownloadDBLogFilePortion request. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods (==) :: DownloadDBLogFilePortionResponse -> DownloadDBLogFilePortionResponse -> Bool # (/=) :: DownloadDBLogFilePortionResponse -> DownloadDBLogFilePortionResponse -> Bool #
Read DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods readsPrec :: Int -> ReadS DownloadDBLogFilePortionResponse # readList :: ReadS [DownloadDBLogFilePortionResponse] # readPrec :: ReadPrec DownloadDBLogFilePortionResponse # readListPrec :: ReadPrec [DownloadDBLogFilePortionResponse] #
Show DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods showsPrec :: Int -> DownloadDBLogFilePortionResponse -> ShowS # show :: DownloadDBLogFilePortionResponse -> String # showList :: [DownloadDBLogFilePortionResponse] -> ShowS #
Generic DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Associated Types type Rep DownloadDBLogFilePortionResponse :: Type -> Type # Methods from :: DownloadDBLogFilePortionResponse -> Rep DownloadDBLogFilePortionResponse x # to :: Rep DownloadDBLogFilePortionResponse x -> DownloadDBLogFilePortionResponse #
NFData DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion Methods rnf :: DownloadDBLogFilePortionResponse -> () #
type Rep DownloadDBLogFilePortionResponse Source #
Instance details Defined in Amazonka.RDS.DownloadDBLogFilePortion type Rep DownloadDBLogFilePortionResponse = D1 ('MetaData "DownloadDBLogFilePortionResponse" "Amazonka.RDS.DownloadDBLogFilePortion" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DownloadDBLogFilePortionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "logFileData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "additionalDataPending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDownloadDBLogFilePortionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DownloadDBLogFilePortionResponse'`
-> DownloadDBLogFilePortionResponse

Create a value of DownloadDBLogFilePortionResponse 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:logFileData:DownloadDBLogFilePortionResponse', downloadDBLogFilePortionResponse_logFileData - Entries from the specified log file.

$sel:additionalDataPending:DownloadDBLogFilePortionResponse', downloadDBLogFilePortionResponse_additionalDataPending - Boolean value that if true, indicates there is more data to be downloaded.

$sel:marker:DownloadDBLogFilePortion', downloadDBLogFilePortionResponse_marker - A pagination token that can be used in a later DownloadDBLogFilePortion request.

$sel:httpStatus:DownloadDBLogFilePortionResponse', downloadDBLogFilePortionResponse_httpStatus - The response's http status code.

Response Lenses

downloadDBLogFilePortionResponse_logFileData :: Lens' DownloadDBLogFilePortionResponse (Maybe Text) Source #

Entries from the specified log file.

downloadDBLogFilePortionResponse_additionalDataPending :: Lens' DownloadDBLogFilePortionResponse (Maybe Bool) Source #

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

downloadDBLogFilePortionResponse_marker :: Lens' DownloadDBLogFilePortionResponse (Maybe Text) Source #

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

downloadDBLogFilePortionResponse_httpStatus :: Lens' DownloadDBLogFilePortionResponse Int Source #

The response's http status code.