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

Copyright(c) 2013-2015 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.DescribeDBInstances

Contents

Description

Returns information about provisioned RDS instances. This API supports pagination.

See: AWS API Reference for DescribeDBInstances.

This operation returns paginated results.

Synopsis

Creating a Request

describeDBInstances :: DescribeDBInstances Source

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

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

Request Lenses

ddbiFilters :: Lens' DescribeDBInstances [Filter] Source

This parameter is not currently supported.

ddbiDBInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text) Source

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

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

ddbiMaxRecords :: Lens' DescribeDBInstances (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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

ddbiMarker :: Lens' DescribeDBInstances (Maybe Text) Source

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Destructuring the Response

describeDBInstancesResponse Source

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

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

Response Lenses

ddbirsMarker :: Lens' DescribeDBInstancesResponse (Maybe Text) Source

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .