libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.DescribeClusterVersions

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

  • clusterVersion :: Maybe Text

    The specific cluster version to return.

    Example: 1.0

Instances

Instances details
Eq DescribeClusterVersions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

Methods

(==) :: DescribeClusterVersions -> DescribeClusterVersions -> Bool #

(/=) :: DescribeClusterVersions -> DescribeClusterVersions -> Bool #

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 #

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 #

NFData DescribeClusterVersions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

Methods

rnf :: DescribeClusterVersions -> () #

Hashable DescribeClusterVersions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

Methods

hashWithSalt :: Int -> DescribeClusterVersions -> Int #

hash :: DescribeClusterVersions -> Int #

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 :: DescribeClusterVersions -> Request DescribeClusterVersions #

response :: MonadResource m => Logger -> Service -> Proxy DescribeClusterVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusterVersions))) #

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 #

type Rep DescribeClusterVersions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

type Rep DescribeClusterVersions = D1 ('MetaData "DescribeClusterVersions" "Amazonka.Redshift.DescribeClusterVersions" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeClusterVersions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterParameterGroupFamily") '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)) :*: S1 ('MetaSel ('Just "clusterVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeClusterVersions Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

type AWSResponse DescribeClusterVersions = DescribeClusterVersionsResponse

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:

$sel:clusterParameterGroupFamily: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

$sel:marker: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.

$sel:clusterVersion:DescribeClusterVersions', describeClusterVersions_clusterVersion - The specific cluster version to return.

Example: 1.0

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

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

The specific cluster version to return.

Example: 1.0

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
Eq DescribeClusterVersionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

Methods

(==) :: DescribeClusterVersionsResponse -> DescribeClusterVersionsResponse -> Bool #

(/=) :: DescribeClusterVersionsResponse -> DescribeClusterVersionsResponse -> Bool #

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 #

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 #

NFData DescribeClusterVersionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

Methods

rnf :: DescribeClusterVersionsResponse -> () #

type Rep DescribeClusterVersionsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeClusterVersions

type Rep DescribeClusterVersionsResponse = D1 ('MetaData "DescribeClusterVersionsResponse" "Amazonka.Redshift.DescribeClusterVersions" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" '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.

$sel:marker: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.