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

Contents

Description

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

This operation returns paginated results.

Synopsis

Creating a Request

describeReservedDBInstances :: DescribeReservedDBInstances Source #

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

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

  • drdiProductDescription - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
  • drdiFilters - This parameter is not currently supported.
  • drdiReservedDBInstanceId - The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
  • drdiDBInstanceClass - The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
  • drdiMarker - 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 .
  • drdiMaxRecords - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • drdiMultiAZ - The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
  • drdiReservedDBInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
  • drdiOfferingType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
  • drdiDuration - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000

data DescribeReservedDBInstances Source #

See: describeReservedDBInstances smart constructor.

Instances

Eq DescribeReservedDBInstances Source # 
Data DescribeReservedDBInstances Source # 

Methods

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

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

toConstr :: DescribeReservedDBInstances -> Constr #

dataTypeOf :: DescribeReservedDBInstances -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeReservedDBInstances -> DescribeReservedDBInstances #

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

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

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

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

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

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

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

Read DescribeReservedDBInstances Source # 
Show DescribeReservedDBInstances Source # 
Generic DescribeReservedDBInstances Source # 
Hashable DescribeReservedDBInstances Source # 
NFData DescribeReservedDBInstances Source # 
AWSPager DescribeReservedDBInstances Source # 
AWSRequest DescribeReservedDBInstances Source # 
ToPath DescribeReservedDBInstances Source # 
ToHeaders DescribeReservedDBInstances Source # 
ToQuery DescribeReservedDBInstances Source # 
type Rep DescribeReservedDBInstances Source # 
type Rep DescribeReservedDBInstances = D1 (MetaData "DescribeReservedDBInstances" "Network.AWS.RDS.DescribeReservedDBInstances" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeReservedDBInstances'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_drdiProductDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drdiFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])))) ((:*:) (S1 (MetaSel (Just Symbol "_drdiReservedDBInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_drdiDBInstanceClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drdiMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_drdiMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_drdiMultiAZ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_drdiReservedDBInstancesOfferingId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_drdiOfferingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drdiDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Rs DescribeReservedDBInstances Source # 

Request Lenses

drdiProductDescription :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

drdiFilters :: Lens' DescribeReservedDBInstances [Filter] Source #

This parameter is not currently supported.

drdiReservedDBInstanceId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

drdiDBInstanceClass :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

drdiMarker :: Lens' DescribeReservedDBInstances (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 .

drdiMaxRecords :: Lens' DescribeReservedDBInstances (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

drdiMultiAZ :: Lens' DescribeReservedDBInstances (Maybe Bool) Source #

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

drdiReservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

drdiOfferingType :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

drdiDuration :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000

Destructuring the Response

describeReservedDBInstancesResponse Source #

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

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

  • drdirsReservedDBInstances - A list of reserved DB instances.
  • drdirsMarker - 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 .
  • drdirsResponseStatus - -- | The response status code.

data DescribeReservedDBInstancesResponse Source #

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

See: describeReservedDBInstancesResponse smart constructor.

Instances

Eq DescribeReservedDBInstancesResponse Source # 
Data DescribeReservedDBInstancesResponse Source # 

Methods

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

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

toConstr :: DescribeReservedDBInstancesResponse -> Constr #

dataTypeOf :: DescribeReservedDBInstancesResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeReservedDBInstancesResponse -> DescribeReservedDBInstancesResponse #

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

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

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

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

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

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

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

Read DescribeReservedDBInstancesResponse Source # 
Show DescribeReservedDBInstancesResponse Source # 
Generic DescribeReservedDBInstancesResponse Source # 
NFData DescribeReservedDBInstancesResponse Source # 
type Rep DescribeReservedDBInstancesResponse Source # 
type Rep DescribeReservedDBInstancesResponse = D1 (MetaData "DescribeReservedDBInstancesResponse" "Network.AWS.RDS.DescribeReservedDBInstances" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeReservedDBInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drdirsReservedDBInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ReservedDBInstance]))) ((:*:) (S1 (MetaSel (Just Symbol "_drdirsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drdirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

drdirsMarker :: Lens' DescribeReservedDBInstancesResponse (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 .