| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.RDS.DescribeReservedDBInstances
Description
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
See: AWS API Reference for DescribeReservedDBInstances.
This operation returns paginated results.
- describeReservedDBInstances :: DescribeReservedDBInstances
- data DescribeReservedDBInstances
- drdiProductDescription :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiFilters :: Lens' DescribeReservedDBInstances [Filter]
- drdiReservedDBInstanceId :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiDBInstanceClass :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiMarker :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiMaxRecords :: Lens' DescribeReservedDBInstances (Maybe Int)
- drdiMultiAZ :: Lens' DescribeReservedDBInstances (Maybe Bool)
- drdiReservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiOfferingType :: Lens' DescribeReservedDBInstances (Maybe Text)
- drdiDuration :: Lens' DescribeReservedDBInstances (Maybe Text)
- describeReservedDBInstancesResponse :: Int -> DescribeReservedDBInstancesResponse
- data DescribeReservedDBInstancesResponse
- drdirsReservedDBInstances :: Lens' DescribeReservedDBInstancesResponse [ReservedDBInstance]
- drdirsMarker :: Lens' DescribeReservedDBInstancesResponse (Maybe Text)
- drdirsResponseStatus :: Lens' DescribeReservedDBInstancesResponse Int
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:
data DescribeReservedDBInstances Source
See: describeReservedDBInstances smart constructor.
Instances
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
Arguments
| :: Int | |
| -> DescribeReservedDBInstancesResponse |
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:
data DescribeReservedDBInstancesResponse Source
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
See: describeReservedDBInstancesResponse smart constructor.
Instances
Response Lenses
drdirsReservedDBInstances :: Lens' DescribeReservedDBInstancesResponse [ReservedDBInstance] Source
A list of reserved DB instances.
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.
drdirsResponseStatus :: Lens' DescribeReservedDBInstancesResponse Int Source
The response status code.