Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- describeDBClusters :: DescribeDBClusters
- data DescribeDBClusters
- ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text)
- ddcFilters :: Lens' DescribeDBClusters [Filter]
- ddcMarker :: Lens' DescribeDBClusters (Maybe Text)
- ddcMaxRecords :: Lens' DescribeDBClusters (Maybe Int)
- describeDBClustersResponse :: Int -> DescribeDBClustersResponse
- data DescribeDBClustersResponse
- ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster]
- ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text)
- ddcrsResponseStatus :: Lens' DescribeDBClustersResponse Int
Creating a Request
describeDBClusters :: DescribeDBClusters Source #
Creates a value of DescribeDBClusters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddcDBClusterIdentifier
- The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DBClusterIdentifier.ddcFilters
- A filter that specifies one or more DB clusters to describe. Supported filters: *db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.ddcMarker
- An optional pagination token provided by a previousDescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.ddcMaxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
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.
data DescribeDBClusters Source #
See: describeDBClusters
smart constructor.
Request Lenses
ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source #
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DBClusterIdentifier.
ddcFilters :: Lens' DescribeDBClusters [Filter] Source #
A filter that specifies one or more DB clusters to describe. Supported filters: * db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
ddcMarker :: Lens' DescribeDBClusters (Maybe Text) Source #
An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
ddcMaxRecords :: Lens' DescribeDBClusters (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
describeDBClustersResponse Source #
Creates a value of DescribeDBClustersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddcrsDBClusters
- Contains a list of DB clusters for the user.ddcrsMarker
- A pagination token that can be used in a subsequent DescribeDBClusters request.ddcrsResponseStatus
- -- | The response status code.
data DescribeDBClustersResponse Source #
Contains the result of a successful invocation of the DescribeDBClusters
action.
See: describeDBClustersResponse
smart constructor.
Response Lenses
ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster] Source #
Contains a list of DB clusters for the user.
ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text) Source #
A pagination token that can be used in a subsequent DescribeDBClusters request.
ddcrsResponseStatus :: Lens' DescribeDBClustersResponse Int Source #
- - | The response status code.