Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SavingsPlans.CreateSavingsPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Savings Plan.

Synopsis

data CreateSavingsPlan = CreateSavingsPlan' {
- clientToken :: Maybe Text
- purchaseTime :: Maybe POSIX
- upfrontPaymentAmount :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- savingsPlanOfferingId :: Text
- commitment :: Text
}
newCreateSavingsPlan :: Text -> Text -> CreateSavingsPlan
createSavingsPlan_clientToken :: Lens' CreateSavingsPlan (Maybe Text)
createSavingsPlan_purchaseTime :: Lens' CreateSavingsPlan (Maybe UTCTime)
createSavingsPlan_upfrontPaymentAmount :: Lens' CreateSavingsPlan (Maybe Text)
createSavingsPlan_tags :: Lens' CreateSavingsPlan (Maybe (HashMap Text Text))
createSavingsPlan_savingsPlanOfferingId :: Lens' CreateSavingsPlan Text
createSavingsPlan_commitment :: Lens' CreateSavingsPlan Text
data CreateSavingsPlanResponse = CreateSavingsPlanResponse' {
- savingsPlanId :: Maybe Text
- httpStatus :: Int
}
newCreateSavingsPlanResponse :: Int -> CreateSavingsPlanResponse
createSavingsPlanResponse_savingsPlanId :: Lens' CreateSavingsPlanResponse (Maybe Text)
createSavingsPlanResponse_httpStatus :: Lens' CreateSavingsPlanResponse Int

Creating a Request

data CreateSavingsPlan Source #

See: newCreateSavingsPlan smart constructor.

Constructors

CreateSavingsPlan'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
purchaseTime :: Maybe POSIX
The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
upfrontPaymentAmount :: Maybe Text
The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.
tags :: Maybe (HashMap Text Text)
One or more tags.
savingsPlanOfferingId :: Text
The ID of the offering.
commitment :: Text
The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than three digits after the decimal point.

Instances

Instances details

Eq CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods (==) :: CreateSavingsPlan -> CreateSavingsPlan -> Bool # (/=) :: CreateSavingsPlan -> CreateSavingsPlan -> Bool #
Read CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods readsPrec :: Int -> ReadS CreateSavingsPlan # readList :: ReadS [CreateSavingsPlan] # readPrec :: ReadPrec CreateSavingsPlan # readListPrec :: ReadPrec [CreateSavingsPlan] #
Show CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods showsPrec :: Int -> CreateSavingsPlan -> ShowS # show :: CreateSavingsPlan -> String # showList :: [CreateSavingsPlan] -> ShowS #
Generic CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Associated Types type Rep CreateSavingsPlan :: Type -> Type # Methods from :: CreateSavingsPlan -> Rep CreateSavingsPlan x # to :: Rep CreateSavingsPlan x -> CreateSavingsPlan #
NFData CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods rnf :: CreateSavingsPlan -> () #
Hashable CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods hashWithSalt :: Int -> CreateSavingsPlan -> Int # hash :: CreateSavingsPlan -> Int #
ToJSON CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods toJSON :: CreateSavingsPlan -> Value # toEncoding :: CreateSavingsPlan -> Encoding # toJSONList :: [CreateSavingsPlan] -> Value # toEncodingList :: [CreateSavingsPlan] -> Encoding #
AWSRequest CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Associated Types type AWSResponse CreateSavingsPlan # Methods request :: CreateSavingsPlan -> Request CreateSavingsPlan # response :: MonadResource m => Logger -> Service -> Proxy CreateSavingsPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSavingsPlan))) #
ToHeaders CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods toHeaders :: CreateSavingsPlan -> [Header] #
ToPath CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods toPath :: CreateSavingsPlan -> ByteString #
ToQuery CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods toQuery :: CreateSavingsPlan -> QueryString #
type Rep CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan type Rep CreateSavingsPlan = D1 ('MetaData "CreateSavingsPlan" "Amazonka.SavingsPlans.CreateSavingsPlan" "libZSservicesZSamazonka-savingsplansZSamazonka-savingsplans" 'False) (C1 ('MetaCons "CreateSavingsPlan'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "purchaseTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "upfrontPaymentAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "savingsPlanOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "commitment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateSavingsPlan Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan type AWSResponse CreateSavingsPlan = CreateSavingsPlanResponse

newCreateSavingsPlan Source #

Arguments

:: Text	`$sel:savingsPlanOfferingId:CreateSavingsPlan'`
-> Text	`$sel:commitment:CreateSavingsPlan'`
-> CreateSavingsPlan

Create a value of CreateSavingsPlan 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:clientToken:CreateSavingsPlan', createSavingsPlan_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:purchaseTime:CreateSavingsPlan', createSavingsPlan_purchaseTime - The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

$sel:upfrontPaymentAmount:CreateSavingsPlan', createSavingsPlan_upfrontPaymentAmount - The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.

$sel:tags:CreateSavingsPlan', createSavingsPlan_tags - One or more tags.

$sel:savingsPlanOfferingId:CreateSavingsPlan', createSavingsPlan_savingsPlanOfferingId - The ID of the offering.

$sel:commitment:CreateSavingsPlan', createSavingsPlan_commitment - The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than three digits after the decimal point.

Request Lenses

createSavingsPlan_clientToken :: Lens' CreateSavingsPlan (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createSavingsPlan_purchaseTime :: Lens' CreateSavingsPlan (Maybe UTCTime) Source #

The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

createSavingsPlan_upfrontPaymentAmount :: Lens' CreateSavingsPlan (Maybe Text) Source #

The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.

createSavingsPlan_tags :: Lens' CreateSavingsPlan (Maybe (HashMap Text Text)) Source #

One or more tags.

createSavingsPlan_savingsPlanOfferingId :: Lens' CreateSavingsPlan Text Source #

The ID of the offering.

createSavingsPlan_commitment :: Lens' CreateSavingsPlan Text Source #

The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than three digits after the decimal point.

Destructuring the Response

data CreateSavingsPlanResponse Source #

See: newCreateSavingsPlanResponse smart constructor.

Constructors

CreateSavingsPlanResponse'
Fields savingsPlanId :: Maybe Text The ID of the Savings Plan. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods (==) :: CreateSavingsPlanResponse -> CreateSavingsPlanResponse -> Bool # (/=) :: CreateSavingsPlanResponse -> CreateSavingsPlanResponse -> Bool #
Read CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods readsPrec :: Int -> ReadS CreateSavingsPlanResponse # readList :: ReadS [CreateSavingsPlanResponse] # readPrec :: ReadPrec CreateSavingsPlanResponse # readListPrec :: ReadPrec [CreateSavingsPlanResponse] #
Show CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods showsPrec :: Int -> CreateSavingsPlanResponse -> ShowS # show :: CreateSavingsPlanResponse -> String # showList :: [CreateSavingsPlanResponse] -> ShowS #
Generic CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Associated Types type Rep CreateSavingsPlanResponse :: Type -> Type # Methods from :: CreateSavingsPlanResponse -> Rep CreateSavingsPlanResponse x # to :: Rep CreateSavingsPlanResponse x -> CreateSavingsPlanResponse #
NFData CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan Methods rnf :: CreateSavingsPlanResponse -> () #
type Rep CreateSavingsPlanResponse Source #
Instance details Defined in Amazonka.SavingsPlans.CreateSavingsPlan type Rep CreateSavingsPlanResponse = D1 ('MetaData "CreateSavingsPlanResponse" "Amazonka.SavingsPlans.CreateSavingsPlan" "libZSservicesZSamazonka-savingsplansZSamazonka-savingsplans" 'False) (C1 ('MetaCons "CreateSavingsPlanResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "savingsPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSavingsPlanResponse Source #

Arguments

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

Create a value of CreateSavingsPlanResponse 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:savingsPlanId:CreateSavingsPlanResponse', createSavingsPlanResponse_savingsPlanId - The ID of the Savings Plan.

$sel:httpStatus:CreateSavingsPlanResponse', createSavingsPlanResponse_httpStatus - The response's http status code.

Response Lenses

createSavingsPlanResponse_savingsPlanId :: Lens' CreateSavingsPlanResponse (Maybe Text) Source #

The ID of the Savings Plan.

createSavingsPlanResponse_httpStatus :: Lens' CreateSavingsPlanResponse Int Source #

The response's http status code.