| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Neptune.DescribeDBParameterGroups
Description
Returns a list of DBParameterGroup descriptions. If a
DBParameterGroupName is specified, the list will contain only the
description of the specified DB parameter group.
This operation returns paginated results.
Synopsis
- data DescribeDBParameterGroups = DescribeDBParameterGroups' {}
- newDescribeDBParameterGroups :: DescribeDBParameterGroups
- describeDBParameterGroups_filters :: Lens' DescribeDBParameterGroups (Maybe [Filter])
- describeDBParameterGroups_dbParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text)
- describeDBParameterGroups_marker :: Lens' DescribeDBParameterGroups (Maybe Text)
- describeDBParameterGroups_maxRecords :: Lens' DescribeDBParameterGroups (Maybe Int)
- data DescribeDBParameterGroupsResponse = DescribeDBParameterGroupsResponse' {}
- newDescribeDBParameterGroupsResponse :: Int -> DescribeDBParameterGroupsResponse
- describeDBParameterGroupsResponse_marker :: Lens' DescribeDBParameterGroupsResponse (Maybe Text)
- describeDBParameterGroupsResponse_dbParameterGroups :: Lens' DescribeDBParameterGroupsResponse (Maybe [DBParameterGroup])
- describeDBParameterGroupsResponse_httpStatus :: Lens' DescribeDBParameterGroupsResponse Int
Creating a Request
data DescribeDBParameterGroups Source #
See: newDescribeDBParameterGroups smart constructor.
Constructors
| DescribeDBParameterGroups' | |
Fields
| |
Instances
newDescribeDBParameterGroups :: DescribeDBParameterGroups Source #
Create a value of DescribeDBParameterGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBParameterGroups', describeDBParameterGroups_filters - This parameter is not currently supported.
$sel:dbParameterGroupName:DescribeDBParameterGroups', describeDBParameterGroups_dbParameterGroupName - The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:marker:DescribeDBParameterGroups', describeDBParameterGroups_marker - An optional pagination token provided by a previous
DescribeDBParameterGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
$sel:maxRecords:DescribeDBParameterGroups', describeDBParameterGroups_maxRecords - 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.
Request Lenses
describeDBParameterGroups_filters :: Lens' DescribeDBParameterGroups (Maybe [Filter]) Source #
This parameter is not currently supported.
describeDBParameterGroups_dbParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text) Source #
The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
describeDBParameterGroups_marker :: Lens' DescribeDBParameterGroups (Maybe Text) Source #
An optional pagination token provided by a previous
DescribeDBParameterGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
describeDBParameterGroups_maxRecords :: Lens' DescribeDBParameterGroups (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.
Destructuring the Response
data DescribeDBParameterGroupsResponse Source #
See: newDescribeDBParameterGroupsResponse smart constructor.
Constructors
| DescribeDBParameterGroupsResponse' | |
Fields
| |
Instances
newDescribeDBParameterGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeDBParameterGroupsResponse |
Create a value of DescribeDBParameterGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBParameterGroups', describeDBParameterGroupsResponse_marker - 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.
$sel:dbParameterGroups:DescribeDBParameterGroupsResponse', describeDBParameterGroupsResponse_dbParameterGroups - A list of DBParameterGroup instances.
$sel:httpStatus:DescribeDBParameterGroupsResponse', describeDBParameterGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeDBParameterGroupsResponse_marker :: Lens' DescribeDBParameterGroupsResponse (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.
describeDBParameterGroupsResponse_dbParameterGroups :: Lens' DescribeDBParameterGroupsResponse (Maybe [DBParameterGroup]) Source #
A list of DBParameterGroup instances.
describeDBParameterGroupsResponse_httpStatus :: Lens' DescribeDBParameterGroupsResponse Int Source #
The response's http status code.