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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get details for a reservation.

Synopsis

data DescribeReservation = DescribeReservation' {
- reservationId :: Text
}
newDescribeReservation :: Text -> DescribeReservation
describeReservation_reservationId :: Lens' DescribeReservation Text
data DescribeReservationResponse = DescribeReservationResponse' {
- arn :: Maybe Text
- count :: Maybe Int
- currencyCode :: Maybe Text
- duration :: Maybe Int
- durationUnits :: Maybe OfferingDurationUnits
- end :: Maybe Text
- fixedPrice :: Maybe Double
- name :: Maybe Text
- offeringDescription :: Maybe Text
- offeringId :: Maybe Text
- offeringType :: Maybe OfferingType
- region :: Maybe Text
- renewalSettings :: Maybe RenewalSettings
- reservationId :: Maybe Text
- resourceSpecification :: Maybe ReservationResourceSpecification
- start :: Maybe Text
- state :: Maybe ReservationState
- tags :: Maybe (HashMap Text Text)
- usagePrice :: Maybe Double
- httpStatus :: Int
}
newDescribeReservationResponse :: Int -> DescribeReservationResponse
describeReservationResponse_arn :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_count :: Lens' DescribeReservationResponse (Maybe Int)
describeReservationResponse_currencyCode :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_duration :: Lens' DescribeReservationResponse (Maybe Int)
describeReservationResponse_durationUnits :: Lens' DescribeReservationResponse (Maybe OfferingDurationUnits)
describeReservationResponse_end :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_fixedPrice :: Lens' DescribeReservationResponse (Maybe Double)
describeReservationResponse_name :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_offeringDescription :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_offeringId :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_offeringType :: Lens' DescribeReservationResponse (Maybe OfferingType)
describeReservationResponse_region :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_renewalSettings :: Lens' DescribeReservationResponse (Maybe RenewalSettings)
describeReservationResponse_reservationId :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_resourceSpecification :: Lens' DescribeReservationResponse (Maybe ReservationResourceSpecification)
describeReservationResponse_start :: Lens' DescribeReservationResponse (Maybe Text)
describeReservationResponse_state :: Lens' DescribeReservationResponse (Maybe ReservationState)
describeReservationResponse_tags :: Lens' DescribeReservationResponse (Maybe (HashMap Text Text))
describeReservationResponse_usagePrice :: Lens' DescribeReservationResponse (Maybe Double)
describeReservationResponse_httpStatus :: Lens' DescribeReservationResponse Int

Creating a Request

data DescribeReservation Source #

Placeholder documentation for DescribeReservationRequest

See: newDescribeReservation smart constructor.

Constructors

DescribeReservation'
Fields reservationId :: Text Unique reservation ID, e.g. '1234567'

Instances

Instances details

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

newDescribeReservation Source #

Arguments

:: Text	`DescribeReservation`
-> DescribeReservation

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

DescribeReservation, describeReservation_reservationId - Unique reservation ID, e.g. '1234567'

Request Lenses

describeReservation_reservationId :: Lens' DescribeReservation Text Source #

Unique reservation ID, e.g. '1234567'

Destructuring the Response

data DescribeReservationResponse Source #

Placeholder documentation for DescribeReservationResponse

See: newDescribeReservationResponse smart constructor.

Constructors

DescribeReservationResponse'

Fields

arn :: Maybe Text
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
count :: Maybe Int
Number of reserved resources
currencyCode :: Maybe Text
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
duration :: Maybe Int
Lease duration, e.g. '12'
durationUnits :: Maybe OfferingDurationUnits
Units for duration, e.g. 'MONTHS'
end :: Maybe Text
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
fixedPrice :: Maybe Double
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
name :: Maybe Text
User specified reservation name
offeringDescription :: Maybe Text
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
offeringId :: Maybe Text
Unique offering ID, e.g. '87654321'
offeringType :: Maybe OfferingType
Offering type, e.g. 'NO_UPFRONT'
region :: Maybe Text
AWS region, e.g. 'us-west-2'
renewalSettings :: Maybe RenewalSettings
Renewal settings for the reservation
reservationId :: Maybe Text
Unique reservation ID, e.g. '1234567'
resourceSpecification :: Maybe ReservationResourceSpecification
Resource configuration details
start :: Maybe Text
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
state :: Maybe ReservationState
Current state of reservation, e.g. 'ACTIVE'
tags :: Maybe (HashMap Text Text)
A collection of key-value pairs
usagePrice :: Maybe Double
Recurring usage charge for each reserved resource, e.g. '157.0'
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation Associated Types type Rep DescribeReservationResponse :: Type -> Type # Methods from :: DescribeReservationResponse -> Rep DescribeReservationResponse x # to :: Rep DescribeReservationResponse x -> DescribeReservationResponse #
Read DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation Methods readsPrec :: Int -> ReadS DescribeReservationResponse # readList :: ReadS [DescribeReservationResponse] # readPrec :: ReadPrec DescribeReservationResponse # readListPrec :: ReadPrec [DescribeReservationResponse] #
Show DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation Methods showsPrec :: Int -> DescribeReservationResponse -> ShowS # show :: DescribeReservationResponse -> String # showList :: [DescribeReservationResponse] -> ShowS #
NFData DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation Methods rnf :: DescribeReservationResponse -> () #
Eq DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation Methods (==) :: DescribeReservationResponse -> DescribeReservationResponse -> Bool # (/=) :: DescribeReservationResponse -> DescribeReservationResponse -> Bool #
type Rep DescribeReservationResponse Source #
Instance details Defined in Amazonka.MediaLive.DescribeReservation type Rep DescribeReservationResponse = D1 ('MetaData "DescribeReservationResponse" "Amazonka.MediaLive.DescribeReservation" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "DescribeReservationResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "currencyCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "durationUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingDurationUnits))))) :: ((S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fixedPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "offeringDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "offeringId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingType)) :: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "renewalSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenewalSettings)) :: (S1 ('MetaSel ('Just "reservationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReservationResourceSpecification))))) :: ((S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReservationState))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "usagePrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeReservationResponse Source #

Arguments

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

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

DescribeReservationResponse, describeReservationResponse_arn - Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

DescribeReservationResponse, describeReservationResponse_count - Number of reserved resources

DescribeReservationResponse, describeReservationResponse_currencyCode - Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

DescribeReservationResponse, describeReservationResponse_duration - Lease duration, e.g. '12'

DescribeReservationResponse, describeReservationResponse_durationUnits - Units for duration, e.g. 'MONTHS'

DescribeReservationResponse, describeReservationResponse_end - Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

DescribeReservationResponse, describeReservationResponse_fixedPrice - One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

DescribeReservationResponse, describeReservationResponse_name - User specified reservation name

DescribeReservationResponse, describeReservationResponse_offeringDescription - Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

DescribeReservationResponse, describeReservationResponse_offeringId - Unique offering ID, e.g. '87654321'

DescribeReservationResponse, describeReservationResponse_offeringType - Offering type, e.g. 'NO_UPFRONT'

DescribeReservationResponse, describeReservationResponse_region - AWS region, e.g. 'us-west-2'

DescribeReservationResponse, describeReservationResponse_renewalSettings - Renewal settings for the reservation

DescribeReservation, describeReservationResponse_reservationId - Unique reservation ID, e.g. '1234567'

DescribeReservationResponse, describeReservationResponse_resourceSpecification - Resource configuration details

DescribeReservationResponse, describeReservationResponse_start - Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

DescribeReservationResponse, describeReservationResponse_state - Current state of reservation, e.g. 'ACTIVE'

DescribeReservationResponse, describeReservationResponse_tags - A collection of key-value pairs

DescribeReservationResponse, describeReservationResponse_usagePrice - Recurring usage charge for each reserved resource, e.g. '157.0'

$sel:httpStatus:DescribeReservationResponse', describeReservationResponse_httpStatus - The response's http status code.

Response Lenses

describeReservationResponse_arn :: Lens' DescribeReservationResponse (Maybe Text) Source #

Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

describeReservationResponse_count :: Lens' DescribeReservationResponse (Maybe Int) Source #

Number of reserved resources

describeReservationResponse_currencyCode :: Lens' DescribeReservationResponse (Maybe Text) Source #

Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

describeReservationResponse_duration :: Lens' DescribeReservationResponse (Maybe Int) Source #

Lease duration, e.g. '12'

describeReservationResponse_durationUnits :: Lens' DescribeReservationResponse (Maybe OfferingDurationUnits) Source #

Units for duration, e.g. 'MONTHS'

describeReservationResponse_end :: Lens' DescribeReservationResponse (Maybe Text) Source #

Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

describeReservationResponse_fixedPrice :: Lens' DescribeReservationResponse (Maybe Double) Source #

One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

describeReservationResponse_name :: Lens' DescribeReservationResponse (Maybe Text) Source #

User specified reservation name

describeReservationResponse_offeringDescription :: Lens' DescribeReservationResponse (Maybe Text) Source #

Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

describeReservationResponse_offeringId :: Lens' DescribeReservationResponse (Maybe Text) Source #

Unique offering ID, e.g. '87654321'

describeReservationResponse_offeringType :: Lens' DescribeReservationResponse (Maybe OfferingType) Source #

Offering type, e.g. 'NO_UPFRONT'

describeReservationResponse_region :: Lens' DescribeReservationResponse (Maybe Text) Source #

AWS region, e.g. 'us-west-2'

describeReservationResponse_renewalSettings :: Lens' DescribeReservationResponse (Maybe RenewalSettings) Source #

Renewal settings for the reservation

describeReservationResponse_reservationId :: Lens' DescribeReservationResponse (Maybe Text) Source #

Unique reservation ID, e.g. '1234567'

describeReservationResponse_resourceSpecification :: Lens' DescribeReservationResponse (Maybe ReservationResourceSpecification) Source #

Resource configuration details

describeReservationResponse_start :: Lens' DescribeReservationResponse (Maybe Text) Source #

Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

describeReservationResponse_state :: Lens' DescribeReservationResponse (Maybe ReservationState) Source #

Current state of reservation, e.g. 'ACTIVE'

describeReservationResponse_tags :: Lens' DescribeReservationResponse (Maybe (HashMap Text Text)) Source #

A collection of key-value pairs

describeReservationResponse_usagePrice :: Lens' DescribeReservationResponse (Maybe Double) Source #

Recurring usage charge for each reserved resource, e.g. '157.0'

describeReservationResponse_httpStatus :: Lens' DescribeReservationResponse Int Source #

The response's http status code.