Copyright | (c) 2013-2016 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 properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This operation returns paginated results.
- describeClusters :: DescribeClusters
- data DescribeClusters
- dcTagValues :: Lens' DescribeClusters [Text]
- dcTagKeys :: Lens' DescribeClusters [Text]
- dcClusterIdentifier :: Lens' DescribeClusters (Maybe Text)
- dcMarker :: Lens' DescribeClusters (Maybe Text)
- dcMaxRecords :: Lens' DescribeClusters (Maybe Int)
- describeClustersResponse :: Int -> DescribeClustersResponse
- data DescribeClustersResponse
- dcrsMarker :: Lens' DescribeClustersResponse (Maybe Text)
- dcrsClusters :: Lens' DescribeClustersResponse [Cluster]
- dcrsResponseStatus :: Lens' DescribeClustersResponse Int
Creating a Request
describeClusters :: DescribeClusters Source #
Creates a value of DescribeClusters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcTagValues
- A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values calledadmin
andtest
. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.dcTagKeys
- A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys calledowner
andenvironment
. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.dcClusterIdentifier
- The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.dcMarker
- An optional parameter that specifies the starting point to return a set of response records. When the results of aDescribeClusters
request exceed the value specified inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.dcMaxRecords
- The maximum number of response records to return in each call. If the number of remaining response records exceeds the specifiedMaxRecords
value, a value is returned in amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default:100
Constraints: minimum 20, maximum 100.
data DescribeClusters Source #
See: describeClusters
smart constructor.
Request Lenses
dcTagValues :: Lens' DescribeClusters [Text] Source #
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin
and test
. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
dcTagKeys :: Lens' DescribeClusters [Text] Source #
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner
and environment
. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
dcClusterIdentifier :: Lens' DescribeClusters (Maybe Text) Source #
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.
dcMarker :: Lens' DescribeClusters (Maybe Text) Source #
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters
request exceed the value specified in MaxRecords
, AWS returns a value in the Marker
field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker
parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
dcMaxRecords :: Lens' DescribeClusters (Maybe Int) Source #
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords
value, a value is returned in a marker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100
Constraints: minimum 20, maximum 100.
Destructuring the Response
describeClustersResponse Source #
Creates a value of DescribeClustersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcrsMarker
- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in theMarker
parameter and retrying the command. If theMarker
field is empty, all response records have been retrieved for the request.dcrsClusters
- A list ofCluster
objects, where each object describes one cluster.dcrsResponseStatus
- -- | The response status code.
data DescribeClustersResponse Source #
Contains the output from the DescribeClusters
action.
See: describeClustersResponse
smart constructor.
Response Lenses
dcrsMarker :: Lens' DescribeClustersResponse (Maybe Text) Source #
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker
parameter and retrying the command. If the Marker
field is empty, all response records have been retrieved for the request.
dcrsClusters :: Lens' DescribeClustersResponse [Cluster] Source #
A list of Cluster
objects, where each object describes one cluster.
dcrsResponseStatus :: Lens' DescribeClustersResponse Int Source #
- - | The response status code.