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.MediaLive.PurchaseOffering

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Purchase an offering and create a reservation.

Synopsis

data PurchaseOffering' = PurchaseOffering'' {
- name :: Maybe Text
- renewalSettings :: Maybe RenewalSettings
- requestId :: Maybe Text
- start :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- offeringId :: Text
- count :: Natural
}
newPurchaseOffering' :: Text -> Natural -> PurchaseOffering'
purchaseOffering'_name :: Lens' PurchaseOffering' (Maybe Text)
purchaseOffering'_renewalSettings :: Lens' PurchaseOffering' (Maybe RenewalSettings)
purchaseOffering'_requestId :: Lens' PurchaseOffering' (Maybe Text)
purchaseOffering'_start :: Lens' PurchaseOffering' (Maybe Text)
purchaseOffering'_tags :: Lens' PurchaseOffering' (Maybe (HashMap Text Text))
purchaseOffering'_offeringId :: Lens' PurchaseOffering' Text
purchaseOffering'_count :: Lens' PurchaseOffering' Natural
data PurchaseOfferingResponse = PurchaseOfferingResponse' {
- reservation :: Maybe Reservation
- httpStatus :: Int
}
newPurchaseOfferingResponse :: Int -> PurchaseOfferingResponse
purchaseOfferingResponse_reservation :: Lens' PurchaseOfferingResponse (Maybe Reservation)
purchaseOfferingResponse_httpStatus :: Lens' PurchaseOfferingResponse Int

Creating a Request

data PurchaseOffering' Source #

Placeholder documentation for PurchaseOfferingRequest

See: newPurchaseOffering' smart constructor.

Constructors

PurchaseOffering''

Fields

name :: Maybe Text
Name for the new reservation
renewalSettings :: Maybe RenewalSettings
Renewal settings for the reservation
requestId :: Maybe Text
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.
start :: Maybe Text
Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.
tags :: Maybe (HashMap Text Text)
A collection of key-value pairs
offeringId :: Text
Offering to purchase, e.g. '87654321'
count :: Natural
Number of resources

Instances

Instances details

ToJSON PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods toJSON :: PurchaseOffering' -> Value # toEncoding :: PurchaseOffering' -> Encoding # toJSONList :: [PurchaseOffering'] -> Value # toEncodingList :: [PurchaseOffering'] -> Encoding #
ToHeaders PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods toHeaders :: PurchaseOffering' -> [Header] #
ToPath PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods toPath :: PurchaseOffering' -> ByteString #
ToQuery PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods toQuery :: PurchaseOffering' -> QueryString #
AWSRequest PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Associated Types type AWSResponse PurchaseOffering' # Methods request :: (Service -> Service) -> PurchaseOffering' -> Request PurchaseOffering' # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PurchaseOffering' -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PurchaseOffering'))) #
Generic PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Associated Types type Rep PurchaseOffering' :: Type -> Type # Methods from :: PurchaseOffering' -> Rep PurchaseOffering' x # to :: Rep PurchaseOffering' x -> PurchaseOffering' #
Read PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods readsPrec :: Int -> ReadS PurchaseOffering' # readList :: ReadS [PurchaseOffering'] # readPrec :: ReadPrec PurchaseOffering' # readListPrec :: ReadPrec [PurchaseOffering'] #
Show PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods showsPrec :: Int -> PurchaseOffering' -> ShowS # show :: PurchaseOffering' -> String # showList :: [PurchaseOffering'] -> ShowS #
NFData PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods rnf :: PurchaseOffering' -> () #
Eq PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods (==) :: PurchaseOffering' -> PurchaseOffering' -> Bool # (/=) :: PurchaseOffering' -> PurchaseOffering' -> Bool #
Hashable PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods hashWithSalt :: Int -> PurchaseOffering' -> Int # hash :: PurchaseOffering' -> Int #
type AWSResponse PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering type AWSResponse PurchaseOffering' = PurchaseOfferingResponse
type Rep PurchaseOffering' Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering type Rep PurchaseOffering' = D1 ('MetaData "PurchaseOffering'" "Amazonka.MediaLive.PurchaseOffering" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "PurchaseOffering''" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "renewalSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenewalSettings)) :: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "offeringId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newPurchaseOffering' Source #

Arguments

:: Text	`PurchaseOffering'`
-> Natural	`PurchaseOffering'`
-> PurchaseOffering'

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

PurchaseOffering', purchaseOffering'_name - Name for the new reservation

PurchaseOffering', purchaseOffering'_renewalSettings - Renewal settings for the reservation

$sel:requestId:PurchaseOffering'', purchaseOffering'_requestId - Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

PurchaseOffering', purchaseOffering'_start - Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.

PurchaseOffering', purchaseOffering'_tags - A collection of key-value pairs

PurchaseOffering', purchaseOffering'_offeringId - Offering to purchase, e.g. '87654321'

PurchaseOffering', purchaseOffering'_count - Number of resources

Request Lenses

purchaseOffering'_name :: Lens' PurchaseOffering' (Maybe Text) Source #

Name for the new reservation

purchaseOffering'_renewalSettings :: Lens' PurchaseOffering' (Maybe RenewalSettings) Source #

Renewal settings for the reservation

purchaseOffering'_requestId :: Lens' PurchaseOffering' (Maybe Text) Source #

Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

purchaseOffering'_start :: Lens' PurchaseOffering' (Maybe Text) Source #

Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.

purchaseOffering'_tags :: Lens' PurchaseOffering' (Maybe (HashMap Text Text)) Source #

A collection of key-value pairs

purchaseOffering'_offeringId :: Lens' PurchaseOffering' Text Source #

Offering to purchase, e.g. '87654321'

purchaseOffering'_count :: Lens' PurchaseOffering' Natural Source #

Number of resources

Destructuring the Response

data PurchaseOfferingResponse Source #

Placeholder documentation for PurchaseOfferingResponse

See: newPurchaseOfferingResponse smart constructor.

Constructors

PurchaseOfferingResponse'
Fields reservation :: Maybe Reservation httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Associated Types type Rep PurchaseOfferingResponse :: Type -> Type # Methods from :: PurchaseOfferingResponse -> Rep PurchaseOfferingResponse x # to :: Rep PurchaseOfferingResponse x -> PurchaseOfferingResponse #
Read PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods readsPrec :: Int -> ReadS PurchaseOfferingResponse # readList :: ReadS [PurchaseOfferingResponse] # readPrec :: ReadPrec PurchaseOfferingResponse # readListPrec :: ReadPrec [PurchaseOfferingResponse] #
Show PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods showsPrec :: Int -> PurchaseOfferingResponse -> ShowS # show :: PurchaseOfferingResponse -> String # showList :: [PurchaseOfferingResponse] -> ShowS #
NFData PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods rnf :: PurchaseOfferingResponse -> () #
Eq PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering Methods (==) :: PurchaseOfferingResponse -> PurchaseOfferingResponse -> Bool # (/=) :: PurchaseOfferingResponse -> PurchaseOfferingResponse -> Bool #
type Rep PurchaseOfferingResponse Source #
Instance details Defined in Amazonka.MediaLive.PurchaseOffering type Rep PurchaseOfferingResponse = D1 ('MetaData "PurchaseOfferingResponse" "Amazonka.MediaLive.PurchaseOffering" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "PurchaseOfferingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Reservation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPurchaseOfferingResponse Source #

Arguments

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

Create a value of PurchaseOfferingResponse 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:reservation:PurchaseOfferingResponse', purchaseOfferingResponse_reservation - Undocumented member.

$sel:httpStatus:PurchaseOfferingResponse', purchaseOfferingResponse_httpStatus - The response's http status code.

Response Lenses

purchaseOfferingResponse_reservation :: Lens' PurchaseOfferingResponse (Maybe Reservation) Source #

Undocumented member.

purchaseOfferingResponse_httpStatus :: Lens' PurchaseOfferingResponse Int Source #

The response's http status code.