libZSservicesZSamazonka-rdsZSamazonka-rds
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.RDS.DescribeDBLogFiles

Description

Returns a list of DB log files for the DB instance.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBLogFiles Source #

See: newDescribeDBLogFiles smart constructor.

Constructors

DescribeDBLogFiles' 

Fields

  • filenameContains :: Maybe Text

    Filters the available log files for log file names that contain the specified string.

  • filters :: Maybe [Filter]

    This parameter isn't currently supported.

  • fileSize :: Maybe Integer

    Filters the available log files for files larger than the specified size.

  • fileLastWritten :: Maybe Integer

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

  • marker :: Maybe Text

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

  • maxRecords :: Maybe Int

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

  • 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.

Instances

Instances details
Eq DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Read DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Show DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Generic DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Associated Types

type Rep DescribeDBLogFiles :: Type -> Type #

NFData DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Methods

rnf :: DescribeDBLogFiles -> () #

Hashable DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

AWSPager DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

AWSRequest DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Associated Types

type AWSResponse DescribeDBLogFiles #

ToHeaders DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

ToPath DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

ToQuery DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

type Rep DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

type Rep DescribeDBLogFiles = D1 ('MetaData "DescribeDBLogFiles" "Amazonka.RDS.DescribeDBLogFiles" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBLogFiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filenameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "fileSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "fileLastWritten") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeDBLogFiles Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

newDescribeDBLogFiles Source #

Create a value of DescribeDBLogFiles 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:filenameContains:DescribeDBLogFiles', describeDBLogFiles_filenameContains - Filters the available log files for log file names that contain the specified string.

$sel:filters:DescribeDBLogFiles', describeDBLogFiles_filters - This parameter isn't currently supported.

$sel:fileSize:DescribeDBLogFiles', describeDBLogFiles_fileSize - Filters the available log files for files larger than the specified size.

$sel:fileLastWritten:DescribeDBLogFiles', describeDBLogFiles_fileLastWritten - Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

$sel:marker:DescribeDBLogFiles', describeDBLogFiles_marker - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

$sel:maxRecords:DescribeDBLogFiles', describeDBLogFiles_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

$sel:dbInstanceIdentifier:DescribeDBLogFiles', describeDBLogFiles_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.

Request Lenses

describeDBLogFiles_filenameContains :: Lens' DescribeDBLogFiles (Maybe Text) Source #

Filters the available log files for log file names that contain the specified string.

describeDBLogFiles_filters :: Lens' DescribeDBLogFiles (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBLogFiles_fileSize :: Lens' DescribeDBLogFiles (Maybe Integer) Source #

Filters the available log files for files larger than the specified size.

describeDBLogFiles_fileLastWritten :: Lens' DescribeDBLogFiles (Maybe Integer) Source #

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

describeDBLogFiles_marker :: Lens' DescribeDBLogFiles (Maybe Text) Source #

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

describeDBLogFiles_maxRecords :: Lens' DescribeDBLogFiles (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

describeDBLogFiles_dbInstanceIdentifier :: Lens' DescribeDBLogFiles 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.

Destructuring the Response

data DescribeDBLogFilesResponse Source #

The response from a call to DescribeDBLogFiles.

See: newDescribeDBLogFilesResponse smart constructor.

Constructors

DescribeDBLogFilesResponse' 

Fields

Instances

Instances details
Eq DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Read DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Show DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Generic DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

Associated Types

type Rep DescribeDBLogFilesResponse :: Type -> Type #

NFData DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

type Rep DescribeDBLogFilesResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBLogFiles

type Rep DescribeDBLogFilesResponse = D1 ('MetaData "DescribeDBLogFilesResponse" "Amazonka.RDS.DescribeDBLogFiles" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBLogFilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "describeDBLogFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DescribeDBLogFilesDetails])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBLogFilesResponse Source #

Create a value of DescribeDBLogFilesResponse 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:describeDBLogFiles:DescribeDBLogFilesResponse', describeDBLogFilesResponse_describeDBLogFiles - The DB log files returned.

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

$sel:httpStatus:DescribeDBLogFilesResponse', describeDBLogFilesResponse_httpStatus - The response's http status code.

Response Lenses

describeDBLogFilesResponse_marker :: Lens' DescribeDBLogFilesResponse (Maybe Text) Source #

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