amazonka-redshift-1.6.1: Amazon Redshift SDK.

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

Network.AWS.Redshift.DescribeOrderableClusterOptions

Contents

Description

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. 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

describeOrderableClusterOptions :: DescribeOrderableClusterOptions #

Creates a value of DescribeOrderableClusterOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • docoMarker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions 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.
  • docoMaxRecords - 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.
  • docoClusterVersion - The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions .
  • docoNodeType - The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

data DescribeOrderableClusterOptions #

See: describeOrderableClusterOptions smart constructor.

Instances
Eq DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Data DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Methods

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

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

toConstr :: DescribeOrderableClusterOptions -> Constr #

dataTypeOf :: DescribeOrderableClusterOptions -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeOrderableClusterOptions -> DescribeOrderableClusterOptions #

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

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

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

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

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

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

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

Read DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Show DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Generic DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Associated Types

type Rep DescribeOrderableClusterOptions :: Type -> Type #

Hashable DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

AWSPager DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

AWSRequest DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Associated Types

type Rs DescribeOrderableClusterOptions :: Type #

ToHeaders DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

ToPath DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

ToQuery DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

NFData DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

type Rep DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

type Rep DescribeOrderableClusterOptions = D1 (MetaData "DescribeOrderableClusterOptions" "Network.AWS.Redshift.DescribeOrderableClusterOptions" "amazonka-redshift-1.6.1-7E7pXybui4gHstewEovezS" False) (C1 (MetaCons "DescribeOrderableClusterOptions'" PrefixI True) ((S1 (MetaSel (Just "_docoMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_docoMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_docoClusterVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_docoNodeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs DescribeOrderableClusterOptions # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Request Lenses

docoMarker :: Lens' DescribeOrderableClusterOptions (Maybe Text) #

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

docoMaxRecords :: Lens' DescribeOrderableClusterOptions (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.

docoClusterVersion :: Lens' DescribeOrderableClusterOptions (Maybe Text) #

The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions .

docoNodeType :: Lens' DescribeOrderableClusterOptions (Maybe Text) #

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

Destructuring the Response

describeOrderableClusterOptionsResponse #

Creates a value of DescribeOrderableClusterOptionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • docorsMarker - 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.
  • docorsOrderableClusterOptions - An OrderableClusterOption structure containing information about orderable options for the cluster.
  • docorsResponseStatus - -- | The response status code.

data DescribeOrderableClusterOptionsResponse #

Contains the output from the DescribeOrderableClusterOptions action.

See: describeOrderableClusterOptionsResponse smart constructor.

Instances
Eq DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Data DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Methods

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

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

toConstr :: DescribeOrderableClusterOptionsResponse -> Constr #

dataTypeOf :: DescribeOrderableClusterOptionsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeOrderableClusterOptionsResponse -> DescribeOrderableClusterOptionsResponse #

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

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

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

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

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

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

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

Read DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Show DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

Generic DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

NFData DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

type Rep DescribeOrderableClusterOptionsResponse # 
Instance details

Defined in Network.AWS.Redshift.DescribeOrderableClusterOptions

type Rep DescribeOrderableClusterOptionsResponse = D1 (MetaData "DescribeOrderableClusterOptionsResponse" "Network.AWS.Redshift.DescribeOrderableClusterOptions" "amazonka-redshift-1.6.1-7E7pXybui4gHstewEovezS" False) (C1 (MetaCons "DescribeOrderableClusterOptionsResponse'" PrefixI True) (S1 (MetaSel (Just "_docorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_docorsOrderableClusterOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [OrderableClusterOption])) :*: S1 (MetaSel (Just "_docorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

docorsMarker :: Lens' DescribeOrderableClusterOptionsResponse (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.

docorsOrderableClusterOptions :: Lens' DescribeOrderableClusterOptionsResponse [OrderableClusterOption] #

An OrderableClusterOption structure containing information about orderable options for the cluster.