Copyright	(c) 2013-2021 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

Amazonka.Redshift.DescribeClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data DescribeClusters = DescribeClusters' {
- tagValues :: Maybe [Text]
- tagKeys :: Maybe [Text]
- clusterIdentifier :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeClusters :: DescribeClusters
describeClusters_tagValues :: Lens' DescribeClusters (Maybe [Text])
describeClusters_tagKeys :: Lens' DescribeClusters (Maybe [Text])
describeClusters_clusterIdentifier :: Lens' DescribeClusters (Maybe Text)
describeClusters_marker :: Lens' DescribeClusters (Maybe Text)
describeClusters_maxRecords :: Lens' DescribeClusters (Maybe Int)
data DescribeClustersResponse = DescribeClustersResponse' {
- marker :: Maybe Text
- clusters :: Maybe [Cluster]
- httpStatus :: Int
}
newDescribeClustersResponse :: Int -> DescribeClustersResponse
describeClustersResponse_marker :: Lens' DescribeClustersResponse (Maybe Text)
describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster])
describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int

Creating a Request

data DescribeClusters Source #

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters'

Fields

tagValues :: Maybe [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.
tagKeys :: Maybe [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.
clusterIdentifier :: 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.
marker :: 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, Amazon Web Services 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.
maxRecords :: 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.

Instances

Instances details

Eq DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods (==) :: DescribeClusters -> DescribeClusters -> Bool # (/=) :: DescribeClusters -> DescribeClusters -> Bool #
Read DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods readsPrec :: Int -> ReadS DescribeClusters # readList :: ReadS [DescribeClusters] # readPrec :: ReadPrec DescribeClusters # readListPrec :: ReadPrec [DescribeClusters] #
Show DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods showsPrec :: Int -> DescribeClusters -> ShowS # show :: DescribeClusters -> String # showList :: [DescribeClusters] -> ShowS #
Generic DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Associated Types type Rep DescribeClusters :: Type -> Type # Methods from :: DescribeClusters -> Rep DescribeClusters x # to :: Rep DescribeClusters x -> DescribeClusters #
NFData DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods rnf :: DescribeClusters -> () #
Hashable DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods hashWithSalt :: Int -> DescribeClusters -> Int # hash :: DescribeClusters -> Int #
AWSPager DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods page :: DescribeClusters -> AWSResponse DescribeClusters -> Maybe DescribeClusters #
AWSRequest DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Associated Types type AWSResponse DescribeClusters # Methods request :: DescribeClusters -> Request DescribeClusters # response :: MonadResource m => Logger -> Service -> Proxy DescribeClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusters))) #
ToHeaders DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods toHeaders :: DescribeClusters -> [Header] #
ToPath DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods toPath :: DescribeClusters -> ByteString #
ToQuery DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods toQuery :: DescribeClusters -> QueryString #
type Rep DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.Redshift.DescribeClusters" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeClusters Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters type AWSResponse DescribeClusters = DescribeClustersResponse

newDescribeClusters :: DescribeClusters Source #

Create a value of DescribeClusters 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:tagValues:DescribeClusters', describeClusters_tagValues - 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.

$sel:tagKeys:DescribeClusters', describeClusters_tagKeys - 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.

$sel:clusterIdentifier:DescribeClusters', describeClusters_clusterIdentifier - 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.

$sel:marker:DescribeClusters', describeClusters_marker - 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, Amazon Web Services 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.

$sel:maxRecords:DescribeClusters', describeClusters_maxRecords - 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.

Request Lenses

describeClusters_tagValues :: Lens' DescribeClusters (Maybe [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.

describeClusters_tagKeys :: Lens' DescribeClusters (Maybe [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.

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

describeClusters_marker :: 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, Amazon Web Services 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.

describeClusters_maxRecords :: 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

data DescribeClustersResponse Source #

Contains the output from the DescribeClusters action.

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse'

Fields

marker :: 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.
clusters :: Maybe [Cluster]
A list of Cluster objects, where each object describes one cluster.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods (==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool # (/=) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool #
Read DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods readsPrec :: Int -> ReadS DescribeClustersResponse # readList :: ReadS [DescribeClustersResponse] # readPrec :: ReadPrec DescribeClustersResponse # readListPrec :: ReadPrec [DescribeClustersResponse] #
Show DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods showsPrec :: Int -> DescribeClustersResponse -> ShowS # show :: DescribeClustersResponse -> String # showList :: [DescribeClustersResponse] -> ShowS #
Generic DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Associated Types type Rep DescribeClustersResponse :: Type -> Type # Methods from :: DescribeClustersResponse -> Rep DescribeClustersResponse x # to :: Rep DescribeClustersResponse x -> DescribeClustersResponse #
NFData DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters Methods rnf :: DescribeClustersResponse -> () #
type Rep DescribeClustersResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeClusters type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.Redshift.DescribeClusters" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClustersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeClustersResponse'`
-> DescribeClustersResponse

Create a value of DescribeClustersResponse 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:marker:DescribeClusters', describeClustersResponse_marker - 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.

$sel:clusters:DescribeClustersResponse', describeClustersResponse_clusters - A list of Cluster objects, where each object describes one cluster.

$sel:httpStatus:DescribeClustersResponse', describeClustersResponse_httpStatus - The response's http status code.

Response Lenses

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

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #

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

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.