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

Amazonka.Redshift.DescribeClusterVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClusterVersions Source #

See: newDescribeClusterVersions smart constructor.

Constructors

DescribeClusterVersions'

Fields

clusterParameterGroupFamily :: Maybe Text
The name of a specific cluster parameter group family to return details for.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
clusterVersion :: Maybe Text
The specific cluster version to return.
Example: 1.0
marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions 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.
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

ToHeaders DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods toHeaders :: DescribeClusterVersions -> [Header] #
ToPath DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods toPath :: DescribeClusterVersions -> ByteString #
ToQuery DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods toQuery :: DescribeClusterVersions -> QueryString #
AWSPager DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods page :: DescribeClusterVersions -> AWSResponse DescribeClusterVersions -> Maybe DescribeClusterVersions #
AWSRequest DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Associated Types type AWSResponse DescribeClusterVersions # Methods request :: (Service -> Service) -> DescribeClusterVersions -> Request DescribeClusterVersions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClusterVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusterVersions))) #
Generic DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Associated Types type Rep DescribeClusterVersions :: Type -> Type # Methods from :: DescribeClusterVersions -> Rep DescribeClusterVersions x # to :: Rep DescribeClusterVersions x -> DescribeClusterVersions #
Read DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods readsPrec :: Int -> ReadS DescribeClusterVersions # readList :: ReadS [DescribeClusterVersions] # readPrec :: ReadPrec DescribeClusterVersions # readListPrec :: ReadPrec [DescribeClusterVersions] #
Show DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods showsPrec :: Int -> DescribeClusterVersions -> ShowS # show :: DescribeClusterVersions -> String # showList :: [DescribeClusterVersions] -> ShowS #
NFData DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods rnf :: DescribeClusterVersions -> () #
Eq DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods (==) :: DescribeClusterVersions -> DescribeClusterVersions -> Bool # (/=) :: DescribeClusterVersions -> DescribeClusterVersions -> Bool #
Hashable DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions Methods hashWithSalt :: Int -> DescribeClusterVersions -> Int # hash :: DescribeClusterVersions -> Int #
type AWSResponse DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions type AWSResponse DescribeClusterVersions = DescribeClusterVersionsResponse
type Rep DescribeClusterVersions Source #
Instance details Defined in Amazonka.Redshift.DescribeClusterVersions type Rep DescribeClusterVersions = D1 ('MetaData "DescribeClusterVersions" "Amazonka.Redshift.DescribeClusterVersions" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeClusterVersions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterVersion") '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)))))

newDescribeClusterVersions :: DescribeClusterVersions Source #

Create a value of DescribeClusterVersions 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:

DescribeClusterVersions, describeClusterVersions_clusterParameterGroupFamily - The name of a specific cluster parameter group family to return details for.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

DescribeClusterVersions, describeClusterVersions_clusterVersion - The specific cluster version to return.

Example: 1.0

DescribeClusterVersions, describeClusterVersions_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions 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.

$sel:maxRecords:DescribeClusterVersions', describeClusterVersions_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

describeClusterVersions_clusterParameterGroupFamily :: Lens' DescribeClusterVersions (Maybe Text) Source #

The name of a specific cluster parameter group family to return details for.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

describeClusterVersions_clusterVersion :: Lens' DescribeClusterVersions (Maybe Text) Source #

The specific cluster version to return.

Example: 1.0

describeClusterVersions_marker :: Lens' DescribeClusterVersions (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions 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.

describeClusterVersions_maxRecords :: Lens' DescribeClusterVersions (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 DescribeClusterVersionsResponse Source #

Contains the output from the DescribeClusterVersions action.

See: newDescribeClusterVersionsResponse smart constructor.

Constructors

DescribeClusterVersionsResponse'

Fields

clusterVersions :: Maybe [ClusterVersion]
A list of Version elements.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeClusterVersionsResponse Source #

Arguments

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

Create a value of DescribeClusterVersionsResponse 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:clusterVersions:DescribeClusterVersionsResponse', describeClusterVersionsResponse_clusterVersions - A list of Version elements.

DescribeClusterVersions, describeClusterVersionsResponse_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:httpStatus:DescribeClusterVersionsResponse', describeClusterVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeClusterVersionsResponse_clusterVersions :: Lens' DescribeClusterVersionsResponse (Maybe [ClusterVersion]) Source #

A list of Version elements.

describeClusterVersionsResponse_marker :: Lens' DescribeClusterVersionsResponse (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.

describeClusterVersionsResponse_httpStatus :: Lens' DescribeClusterVersionsResponse Int Source #

The response's http status code.