Network.AWS.Redshift.DescribeClusters

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.

Creating a Request

describeClusters :: DescribeClusters

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 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 - 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 - 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 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 - 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.

data DescribeClusters

See: describeClusters smart constructor.

Instances

Eq DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

(==) :: DescribeClusters -> DescribeClusters -> Bool

(/=) :: DescribeClusters -> DescribeClusters -> Bool

Data DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusters -> c DescribeClusters

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusters

toConstr :: DescribeClusters -> Constr

dataTypeOf :: DescribeClusters -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusters)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusters)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusters -> DescribeClusters

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusters -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusters -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusters -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusters -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

Read DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClusters

readList :: ReadS [DescribeClusters]

readPrec :: ReadPrec DescribeClusters

readListPrec :: ReadPrec [DescribeClusters]

Show DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

showsPrec :: Int -> DescribeClusters -> ShowS

show :: DescribeClusters -> String

showList :: [DescribeClusters] -> ShowS

Generic DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Associated Types

type Rep DescribeClusters :: Type -> Type

Methods

from :: DescribeClusters -> Rep DescribeClusters x

to :: Rep DescribeClusters x -> DescribeClusters

Hashable DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

hashWithSalt :: Int -> DescribeClusters -> Int

hash :: DescribeClusters -> Int

AWSPager DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

page :: DescribeClusters -> Rs DescribeClusters -> Maybe DescribeClusters

AWSRequest DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Associated Types

type Rs DescribeClusters :: Type

Methods

request :: DescribeClusters -> Request DescribeClusters

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeClusters -> ClientResponse -> m (Response DescribeClusters)

ToHeaders DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

toHeaders :: DescribeClusters -> [Header]

ToPath DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

toPath :: DescribeClusters -> ByteString

ToQuery DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

toQuery :: DescribeClusters -> QueryString

NFData DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

Methods

rnf :: DescribeClusters -> ()

type Rep DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

type Rep DescribeClusters = D1 (MetaData "DescribeClusters" "Network.AWS.Redshift.DescribeClusters" "amazonka-redshift-1.6.1-5k9dueihUQf2a2gxNGkSPi" False) (C1 (MetaCons "DescribeClusters'" PrefixI True) ((S1 (MetaSel (Just "_dcTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_dcTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_dcClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dcMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeClusters

Defined in Network.AWS.Redshift.DescribeClusters

type Rs DescribeClusters = DescribeClustersResponse

Request Lenses

dcTagValues :: Lens' DescribeClusters [Text]

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]

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)

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)

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)

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

Arguments

:: Int

dcrsResponseStatus

-> DescribeClustersResponse

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 the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
• dcrsClusters - A list of Cluster objects, where each object describes one cluster.
• dcrsResponseStatus - -- | The response status code.

data DescribeClustersResponse

Contains the output from the DescribeClusters action.

See: describeClustersResponse smart constructor.

Instances

Eq DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Methods

(==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool

(/=) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool

Data DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClustersResponse -> c DescribeClustersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClustersResponse

toConstr :: DescribeClustersResponse -> Constr

dataTypeOf :: DescribeClustersResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClustersResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClustersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeClustersResponse -> DescribeClustersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClustersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClustersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClustersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClustersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

Read DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClustersResponse

readList :: ReadS [DescribeClustersResponse]

readPrec :: ReadPrec DescribeClustersResponse

readListPrec :: ReadPrec [DescribeClustersResponse]

Show DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Methods

showsPrec :: Int -> DescribeClustersResponse -> ShowS

show :: DescribeClustersResponse -> String

showList :: [DescribeClustersResponse] -> ShowS

Generic DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Associated Types

type Rep DescribeClustersResponse :: Type -> Type

Methods

from :: DescribeClustersResponse -> Rep DescribeClustersResponse x

to :: Rep DescribeClustersResponse x -> DescribeClustersResponse

NFData DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

Methods

rnf :: DescribeClustersResponse -> ()

type Rep DescribeClustersResponse

Defined in Network.AWS.Redshift.DescribeClusters

type Rep DescribeClustersResponse = D1 (MetaData "DescribeClustersResponse" "Network.AWS.Redshift.DescribeClusters" "amazonka-redshift-1.6.1-5k9dueihUQf2a2gxNGkSPi" False) (C1 (MetaCons "DescribeClustersResponse'" PrefixI True) (S1 (MetaSel (Just "_dcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dcrsClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Cluster])) :*: S1 (MetaSel (Just "_dcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dcrsMarker :: Lens' DescribeClustersResponse (Maybe Text)

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]

A list of Cluster objects, where each object describes one cluster.

dcrsResponseStatus :: Lens' DescribeClustersResponse Int

• - | The response status code.