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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedNodeOfferings Source #

See: newDescribeReservedNodeOfferings smart constructor.

Constructors

DescribeReservedNodeOfferings'

Fields

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings 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.
reservedNodeOfferingId :: Maybe Text
The unique identifier for the offering.

Instances

Instances details

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

newDescribeReservedNodeOfferings :: DescribeReservedNodeOfferings Source #

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

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

DescribeReservedNodeOfferings, describeReservedNodeOfferings_reservedNodeOfferingId - The unique identifier for the offering.

Request Lenses

describeReservedNodeOfferings_marker :: Lens' DescribeReservedNodeOfferings (Maybe Text) Source #

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

describeReservedNodeOfferings_maxRecords :: Lens' DescribeReservedNodeOfferings (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.

describeReservedNodeOfferings_reservedNodeOfferingId :: Lens' DescribeReservedNodeOfferings (Maybe Text) Source #

The unique identifier for the offering.

Destructuring the Response

data DescribeReservedNodeOfferingsResponse Source #

See: newDescribeReservedNodeOfferingsResponse smart constructor.

Constructors

DescribeReservedNodeOfferingsResponse'

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.
reservedNodeOfferings :: Maybe [ReservedNodeOffering]
A list of ReservedNodeOffering objects.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeReservedNodeOfferingsResponse Source #

Arguments

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

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

DescribeReservedNodeOfferings, describeReservedNodeOfferingsResponse_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:reservedNodeOfferings:DescribeReservedNodeOfferingsResponse', describeReservedNodeOfferingsResponse_reservedNodeOfferings - A list of ReservedNodeOffering objects.

$sel:httpStatus:DescribeReservedNodeOfferingsResponse', describeReservedNodeOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedNodeOfferingsResponse_marker :: Lens' DescribeReservedNodeOfferingsResponse (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.

describeReservedNodeOfferingsResponse_reservedNodeOfferings :: Lens' DescribeReservedNodeOfferingsResponse (Maybe [ReservedNodeOffering]) Source #

A list of ReservedNodeOffering objects.

describeReservedNodeOfferingsResponse_httpStatus :: Lens' DescribeReservedNodeOfferingsResponse Int Source #

The response's http status code.