| 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.DescribeOptionGroups
Description
Describes the available option groups.
See: AWS API Reference for DescribeOptionGroups.
This operation returns paginated results.
- describeOptionGroups :: DescribeOptionGroups
- data DescribeOptionGroups
- dogFilters :: Lens' DescribeOptionGroups [Filter]
- dogEngineName :: Lens' DescribeOptionGroups (Maybe Text)
- dogMajorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text)
- dogMarker :: Lens' DescribeOptionGroups (Maybe Text)
- dogMaxRecords :: Lens' DescribeOptionGroups (Maybe Int)
- dogOptionGroupName :: Lens' DescribeOptionGroups (Maybe Text)
- describeOptionGroupsResponse :: Int -> DescribeOptionGroupsResponse
- data DescribeOptionGroupsResponse
- dogrsMarker :: Lens' DescribeOptionGroupsResponse (Maybe Text)
- dogrsOptionGroupsList :: Lens' DescribeOptionGroupsResponse [OptionGroup]
- dogrsResponseStatus :: Lens' DescribeOptionGroupsResponse Int
Creating a Request
describeOptionGroups :: DescribeOptionGroups Source
Creates a value of DescribeOptionGroups with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeOptionGroups Source
See: describeOptionGroups smart constructor.
Instances
Request Lenses
dogFilters :: Lens' DescribeOptionGroups [Filter] Source
This parameter is not currently supported.
dogEngineName :: Lens' DescribeOptionGroups (Maybe Text) Source
Filters the list of option groups to only include groups associated with a specific database engine.
dogMajorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text) Source
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
dogMarker :: Lens' DescribeOptionGroups (Maybe Text) Source
An optional pagination token provided by a previous DescribeOptionGroups
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords.
dogMaxRecords :: Lens' DescribeOptionGroups (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.
dogOptionGroupName :: Lens' DescribeOptionGroups (Maybe Text) Source
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
Destructuring the Response
describeOptionGroupsResponse Source
Arguments
| :: Int | |
| -> DescribeOptionGroupsResponse |
Creates a value of DescribeOptionGroupsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeOptionGroupsResponse Source
List of option groups.
See: describeOptionGroupsResponse smart constructor.
Response Lenses
dogrsMarker :: Lens' DescribeOptionGroupsResponse (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.
dogrsOptionGroupsList :: Lens' DescribeOptionGroupsResponse [OptionGroup] Source
List of option groups.
dogrsResponseStatus :: Lens' DescribeOptionGroupsResponse Int Source
The response status code.