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 |
Returns the detailed parameter list for a particular DB parameter group.
See: AWS API Reference for DescribeDBParameters.
This operation returns paginated results.
- describeDBParameters :: Text -> DescribeDBParameters
- data DescribeDBParameters
- ddpFilters :: Lens' DescribeDBParameters [Filter]
- ddpMaxRecords :: Lens' DescribeDBParameters (Maybe Int)
- ddpMarker :: Lens' DescribeDBParameters (Maybe Text)
- ddpSource :: Lens' DescribeDBParameters (Maybe Text)
- ddpDBParameterGroupName :: Lens' DescribeDBParameters Text
- describeDBParametersResponse :: Int -> DescribeDBParametersResponse
- data DescribeDBParametersResponse
- ddprsParameters :: Lens' DescribeDBParametersResponse [Parameter]
- ddprsMarker :: Lens' DescribeDBParametersResponse (Maybe Text)
- ddprsStatus :: Lens' DescribeDBParametersResponse Int
Creating a Request
Creates a value of DescribeDBParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBParameters Source
See: describeDBParameters
smart constructor.
Request Lenses
ddpFilters :: Lens' DescribeDBParameters [Filter] Source
This parameter is not currently supported.
ddpMaxRecords :: Lens' DescribeDBParameters (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.
ddpMarker :: Lens' DescribeDBParameters (Maybe Text) Source
An optional pagination token provided by a previous
DescribeDBParameters
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
ddpSource :: Lens' DescribeDBParameters (Maybe Text) Source
The parameter types to return.
Default: All parameter types returned
Valid Values: 'user | system | engine-default'
ddpDBParameterGroupName :: Lens' DescribeDBParameters Text Source
The name of a specific DB parameter group to return details for.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Destructuring the Response
describeDBParametersResponse Source
Creates a value of DescribeDBParametersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBParametersResponse Source
Contains the result of a successful invocation of the DescribeDBParameters action.
See: describeDBParametersResponse
smart constructor.
Response Lenses
ddprsParameters :: Lens' DescribeDBParametersResponse [Parameter] Source
A list of Parameter values.
ddprsMarker :: Lens' DescribeDBParametersResponse (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
.
ddprsStatus :: Lens' DescribeDBParametersResponse Int Source
The response status code.