Network.AWS.RDS.DescribeDBInstances

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

This operation returns paginated results.

Creating a Request

describeDBInstances :: DescribeDBInstances

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:

• ddbiFilters - This parameter is not currently supported.
• ddbiDBInstanceIdentifier - 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
• ddbiMarker - 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 .
• ddbiMaxRecords - 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.

data DescribeDBInstances

See: describeDBInstances smart constructor.

Instances

Eq DescribeDBInstances

Methods

(==) :: DescribeDBInstances -> DescribeDBInstances -> Bool

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

Data DescribeDBInstances

Methods

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

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

toConstr :: DescribeDBInstances -> Constr

dataTypeOf :: DescribeDBInstances -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDBInstances

Methods

readsPrec :: Int -> ReadS DescribeDBInstances

readList :: ReadS [DescribeDBInstances]

readPrec :: ReadPrec DescribeDBInstances

readListPrec :: ReadPrec [DescribeDBInstances]

Show DescribeDBInstances

Methods

showsPrec :: Int -> DescribeDBInstances -> ShowS

show :: DescribeDBInstances -> String

showList :: [DescribeDBInstances] -> ShowS

Generic DescribeDBInstances

Associated Types

type Rep DescribeDBInstances :: * -> *

Methods

from :: DescribeDBInstances -> Rep DescribeDBInstances x

to :: Rep DescribeDBInstances x -> DescribeDBInstances

Hashable DescribeDBInstances

Methods

hashWithSalt :: Int -> DescribeDBInstances -> Int

hash :: DescribeDBInstances -> Int

NFData DescribeDBInstances

Methods

rnf :: DescribeDBInstances -> ()

AWSPager DescribeDBInstances

Methods

page :: DescribeDBInstances -> Rs DescribeDBInstances -> Maybe DescribeDBInstances

AWSRequest DescribeDBInstances

Associated Types

type Rs DescribeDBInstances :: *

Methods

request :: DescribeDBInstances -> Request DescribeDBInstances

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDBInstances -> ClientResponse -> m (Response DescribeDBInstances)

ToPath DescribeDBInstances

Methods

toPath :: DescribeDBInstances -> ByteString

ToHeaders DescribeDBInstances

Methods

toHeaders :: DescribeDBInstances -> [Header]

ToQuery DescribeDBInstances

Methods

toQuery :: DescribeDBInstances -> QueryString

type Rep DescribeDBInstances

type Rep DescribeDBInstances = D1 (MetaData "DescribeDBInstances" "Network.AWS.RDS.DescribeDBInstances" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBInstances'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddbiFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_ddbiDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ddbiMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddbiMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeDBInstances

type Rs DescribeDBInstances = DescribeDBInstancesResponse

Request Lenses

ddbiFilters :: Lens' DescribeDBInstances [Filter]

This parameter is not currently supported.

ddbiDBInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text)

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

ddbiMarker :: Lens' DescribeDBInstances (Maybe Text)

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 .

ddbiMaxRecords :: Lens' DescribeDBInstances (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 that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

Destructuring the Response

describeDBInstancesResponse

Arguments

:: Int

ddbirsResponseStatus

-> DescribeDBInstancesResponse

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:

• ddbirsDBInstances - A list of DBInstance instances.
• ddbirsMarker - 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 .
• ddbirsResponseStatus - -- | The response status code.

data DescribeDBInstancesResponse

Contains the result of a successful invocation of the DescribeDBInstances action.

See: describeDBInstancesResponse smart constructor.

Instances

Eq DescribeDBInstancesResponse

Methods

(==) :: DescribeDBInstancesResponse -> DescribeDBInstancesResponse -> Bool

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

Data DescribeDBInstancesResponse

Methods

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

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

toConstr :: DescribeDBInstancesResponse -> Constr

dataTypeOf :: DescribeDBInstancesResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDBInstancesResponse

Methods

readsPrec :: Int -> ReadS DescribeDBInstancesResponse

readList :: ReadS [DescribeDBInstancesResponse]

readPrec :: ReadPrec DescribeDBInstancesResponse

readListPrec :: ReadPrec [DescribeDBInstancesResponse]

Show DescribeDBInstancesResponse

Methods

showsPrec :: Int -> DescribeDBInstancesResponse -> ShowS

show :: DescribeDBInstancesResponse -> String

showList :: [DescribeDBInstancesResponse] -> ShowS

Generic DescribeDBInstancesResponse

Associated Types

type Rep DescribeDBInstancesResponse :: * -> *

Methods

from :: DescribeDBInstancesResponse -> Rep DescribeDBInstancesResponse x

to :: Rep DescribeDBInstancesResponse x -> DescribeDBInstancesResponse

NFData DescribeDBInstancesResponse

Methods

rnf :: DescribeDBInstancesResponse -> ()

type Rep DescribeDBInstancesResponse

type Rep DescribeDBInstancesResponse = D1 (MetaData "DescribeDBInstancesResponse" "Network.AWS.RDS.DescribeDBInstances" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddbirsDBInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DBInstance]))) ((:*:) (S1 (MetaSel (Just Symbol "_ddbirsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddbirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ddbirsDBInstances :: Lens' DescribeDBInstancesResponse [DBInstance]

A list of DBInstance instances.

ddbirsMarker :: Lens' DescribeDBInstancesResponse (Maybe Text)

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 .

ddbirsResponseStatus :: Lens' DescribeDBInstancesResponse Int

• - | The response status code.