Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about DB proxies.
This operation returns paginated results.
Synopsis
- data DescribeDBProxies = DescribeDBProxies' {}
- newDescribeDBProxies :: DescribeDBProxies
- describeDBProxies_dbProxyName :: Lens' DescribeDBProxies (Maybe Text)
- describeDBProxies_filters :: Lens' DescribeDBProxies (Maybe [Filter])
- describeDBProxies_marker :: Lens' DescribeDBProxies (Maybe Text)
- describeDBProxies_maxRecords :: Lens' DescribeDBProxies (Maybe Natural)
- data DescribeDBProxiesResponse = DescribeDBProxiesResponse' {}
- newDescribeDBProxiesResponse :: Int -> DescribeDBProxiesResponse
- describeDBProxiesResponse_dbProxies :: Lens' DescribeDBProxiesResponse (Maybe [DBProxy])
- describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (Maybe Text)
- describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int
Creating a Request
data DescribeDBProxies Source #
See: newDescribeDBProxies
smart constructor.
DescribeDBProxies' | |
|
Instances
newDescribeDBProxies :: DescribeDBProxies Source #
Create a value of DescribeDBProxies
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:
DescribeDBProxies
, describeDBProxies_dbProxyName
- The name of the DB proxy. If you omit this parameter, the output
includes information about all DB proxies owned by your Amazon Web
Services account ID.
$sel:filters:DescribeDBProxies'
, describeDBProxies_filters
- This parameter is not currently supported.
DescribeDBProxies
, describeDBProxies_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:maxRecords:DescribeDBProxies'
, describeDBProxies_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
describeDBProxies_dbProxyName :: Lens' DescribeDBProxies (Maybe Text) Source #
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
describeDBProxies_filters :: Lens' DescribeDBProxies (Maybe [Filter]) Source #
This parameter is not currently supported.
describeDBProxies_marker :: Lens' DescribeDBProxies (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
.
describeDBProxies_maxRecords :: Lens' DescribeDBProxies (Maybe Natural) 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 DescribeDBProxiesResponse Source #
See: newDescribeDBProxiesResponse
smart constructor.
DescribeDBProxiesResponse' | |
|
Instances
newDescribeDBProxiesResponse Source #
Create a value of DescribeDBProxiesResponse
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:dbProxies:DescribeDBProxiesResponse'
, describeDBProxiesResponse_dbProxies
- A return value representing an arbitrary number of DBProxy
data
structures.
DescribeDBProxies
, describeDBProxiesResponse_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:httpStatus:DescribeDBProxiesResponse'
, describeDBProxiesResponse_httpStatus
- The response's http status code.
Response Lenses
describeDBProxiesResponse_dbProxies :: Lens' DescribeDBProxiesResponse (Maybe [DBProxy]) Source #
A return value representing an arbitrary number of DBProxy
data
structures.
describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (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
.
describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int Source #
The response's http status code.