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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeNodeConfigurationOptions Source #

See: newDescribeNodeConfigurationOptions smart constructor.

Constructors

DescribeNodeConfigurationOptions'

Fields

clusterIdentifier :: Maybe Text
The identifier of the cluster to evaluate for possible node configurations.
filters :: Maybe [NodeConfigurationOptionsFilter]
A set of name, operator, and value items to filter the results.
marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions 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: 500
Constraints: minimum 100, maximum 500.
ownerAccount :: Maybe Text
The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
snapshotArn :: Maybe Text
The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
snapshotIdentifier :: Maybe Text
The identifier of the snapshot to evaluate for possible node configurations.
actionType :: ActionType
The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.

Instances

Instances details

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

newDescribeNodeConfigurationOptions Source #

Arguments

:: ActionType	`$sel:actionType:DescribeNodeConfigurationOptions'`
-> DescribeNodeConfigurationOptions

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

DescribeNodeConfigurationOptions, describeNodeConfigurationOptions_clusterIdentifier - The identifier of the cluster to evaluate for possible node configurations.

$sel:filters:DescribeNodeConfigurationOptions', describeNodeConfigurationOptions_filters - A set of name, operator, and value items to filter the results.

DescribeNodeConfigurationOptions, describeNodeConfigurationOptions_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions 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:DescribeNodeConfigurationOptions', describeNodeConfigurationOptions_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: 500

Constraints: minimum 100, maximum 500.

DescribeNodeConfigurationOptions, describeNodeConfigurationOptions_ownerAccount - The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

$sel:snapshotArn:DescribeNodeConfigurationOptions', describeNodeConfigurationOptions_snapshotArn - The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

DescribeNodeConfigurationOptions, describeNodeConfigurationOptions_snapshotIdentifier - The identifier of the snapshot to evaluate for possible node configurations.

$sel:actionType:DescribeNodeConfigurationOptions', describeNodeConfigurationOptions_actionType - The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.

Request Lenses

describeNodeConfigurationOptions_clusterIdentifier :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The identifier of the cluster to evaluate for possible node configurations.

describeNodeConfigurationOptions_filters :: Lens' DescribeNodeConfigurationOptions (Maybe [NodeConfigurationOptionsFilter]) Source #

A set of name, operator, and value items to filter the results.

describeNodeConfigurationOptions_marker :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

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

describeNodeConfigurationOptions_maxRecords :: Lens' DescribeNodeConfigurationOptions (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: 500

Constraints: minimum 100, maximum 500.

describeNodeConfigurationOptions_ownerAccount :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

describeNodeConfigurationOptions_snapshotArn :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

describeNodeConfigurationOptions_snapshotIdentifier :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The identifier of the snapshot to evaluate for possible node configurations.

describeNodeConfigurationOptions_actionType :: Lens' DescribeNodeConfigurationOptions ActionType Source #

The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.

Destructuring the Response

data DescribeNodeConfigurationOptionsResponse Source #

See: newDescribeNodeConfigurationOptionsResponse smart constructor.

Constructors

DescribeNodeConfigurationOptionsResponse'

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.
nodeConfigurationOptionList :: Maybe [NodeConfigurationOption]
A list of valid node configurations.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeNodeConfigurationOptionsResponse Source #

Arguments

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

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

DescribeNodeConfigurationOptions, describeNodeConfigurationOptionsResponse_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:nodeConfigurationOptionList:DescribeNodeConfigurationOptionsResponse', describeNodeConfigurationOptionsResponse_nodeConfigurationOptionList - A list of valid node configurations.

$sel:httpStatus:DescribeNodeConfigurationOptionsResponse', describeNodeConfigurationOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeNodeConfigurationOptionsResponse_marker :: Lens' DescribeNodeConfigurationOptionsResponse (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.

describeNodeConfigurationOptionsResponse_nodeConfigurationOptionList :: Lens' DescribeNodeConfigurationOptionsResponse (Maybe [NodeConfigurationOption]) Source #

A list of valid node configurations.

describeNodeConfigurationOptionsResponse_httpStatus :: Lens' DescribeNodeConfigurationOptionsResponse Int Source #

The response's http status code.