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.MediaTailor.DescribeProgram

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Synopsis

data DescribeProgram = DescribeProgram' {
- channelName :: Text
- programName :: Text
}
newDescribeProgram :: Text -> Text -> DescribeProgram
describeProgram_channelName :: Lens' DescribeProgram Text
describeProgram_programName :: Lens' DescribeProgram Text
data DescribeProgramResponse = DescribeProgramResponse' {
- adBreaks :: Maybe [AdBreak]
- arn :: Maybe Text
- channelName :: Maybe Text
- creationTime :: Maybe POSIX
- liveSourceName :: Maybe Text
- programName :: Maybe Text
- scheduledStartTime :: Maybe POSIX
- sourceLocationName :: Maybe Text
- vodSourceName :: Maybe Text
- httpStatus :: Int
}
newDescribeProgramResponse :: Int -> DescribeProgramResponse
describeProgramResponse_adBreaks :: Lens' DescribeProgramResponse (Maybe [AdBreak])
describeProgramResponse_arn :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_channelName :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_creationTime :: Lens' DescribeProgramResponse (Maybe UTCTime)
describeProgramResponse_liveSourceName :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_programName :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_scheduledStartTime :: Lens' DescribeProgramResponse (Maybe UTCTime)
describeProgramResponse_sourceLocationName :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_vodSourceName :: Lens' DescribeProgramResponse (Maybe Text)
describeProgramResponse_httpStatus :: Lens' DescribeProgramResponse Int

Creating a Request

data DescribeProgram Source #

See: newDescribeProgram smart constructor.

Constructors

DescribeProgram'
Fields channelName :: Text The name of the channel associated with this Program. programName :: Text The name of the program.

Instances

Instances details

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

newDescribeProgram Source #

Arguments

:: Text	`DescribeProgram`
-> Text	`DescribeProgram`
-> DescribeProgram

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

DescribeProgram, describeProgram_channelName - The name of the channel associated with this Program.

DescribeProgram, describeProgram_programName - The name of the program.

Request Lenses

describeProgram_channelName :: Lens' DescribeProgram Text Source #

The name of the channel associated with this Program.

describeProgram_programName :: Lens' DescribeProgram Text Source #

The name of the program.

Destructuring the Response

data DescribeProgramResponse Source #

See: newDescribeProgramResponse smart constructor.

Constructors

DescribeProgramResponse'

Fields

adBreaks :: Maybe [AdBreak]
The ad break configuration settings.
arn :: Maybe Text
The ARN of the program.
channelName :: Maybe Text
The name of the channel that the program belongs to.
creationTime :: Maybe POSIX
The timestamp of when the program was created.
liveSourceName :: Maybe Text
The name of the LiveSource for this Program.
programName :: Maybe Text
The name of the program.
scheduledStartTime :: Maybe POSIX
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
sourceLocationName :: Maybe Text
The source location name.
vodSourceName :: Maybe Text
The name that's used to refer to a VOD source.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram Associated Types type Rep DescribeProgramResponse :: Type -> Type # Methods from :: DescribeProgramResponse -> Rep DescribeProgramResponse x # to :: Rep DescribeProgramResponse x -> DescribeProgramResponse #
Read DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram Methods readsPrec :: Int -> ReadS DescribeProgramResponse # readList :: ReadS [DescribeProgramResponse] # readPrec :: ReadPrec DescribeProgramResponse # readListPrec :: ReadPrec [DescribeProgramResponse] #
Show DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram Methods showsPrec :: Int -> DescribeProgramResponse -> ShowS # show :: DescribeProgramResponse -> String # showList :: [DescribeProgramResponse] -> ShowS #
NFData DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram Methods rnf :: DescribeProgramResponse -> () #
Eq DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram Methods (==) :: DescribeProgramResponse -> DescribeProgramResponse -> Bool # (/=) :: DescribeProgramResponse -> DescribeProgramResponse -> Bool #
type Rep DescribeProgramResponse Source #
Instance details Defined in Amazonka.MediaTailor.DescribeProgram type Rep DescribeProgramResponse = D1 ('MetaData "DescribeProgramResponse" "Amazonka.MediaTailor.DescribeProgram" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "DescribeProgramResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "adBreaks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdBreak])) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "liveSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "programName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scheduledStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "sourceLocationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vodSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeProgramResponse Source #

Arguments

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

Create a value of DescribeProgramResponse 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:adBreaks:DescribeProgramResponse', describeProgramResponse_adBreaks - The ad break configuration settings.

DescribeProgramResponse, describeProgramResponse_arn - The ARN of the program.

DescribeProgram, describeProgramResponse_channelName - The name of the channel that the program belongs to.

DescribeProgramResponse, describeProgramResponse_creationTime - The timestamp of when the program was created.

DescribeProgramResponse, describeProgramResponse_liveSourceName - The name of the LiveSource for this Program.

DescribeProgram, describeProgramResponse_programName - The name of the program.

$sel:scheduledStartTime:DescribeProgramResponse', describeProgramResponse_scheduledStartTime - The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

DescribeProgramResponse, describeProgramResponse_sourceLocationName - The source location name.

DescribeProgramResponse, describeProgramResponse_vodSourceName - The name that's used to refer to a VOD source.

$sel:httpStatus:DescribeProgramResponse', describeProgramResponse_httpStatus - The response's http status code.

Response Lenses

describeProgramResponse_adBreaks :: Lens' DescribeProgramResponse (Maybe [AdBreak]) Source #

The ad break configuration settings.

describeProgramResponse_arn :: Lens' DescribeProgramResponse (Maybe Text) Source #

The ARN of the program.

describeProgramResponse_channelName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name of the channel that the program belongs to.

describeProgramResponse_creationTime :: Lens' DescribeProgramResponse (Maybe UTCTime) Source #

The timestamp of when the program was created.

describeProgramResponse_liveSourceName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name of the LiveSource for this Program.

describeProgramResponse_programName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name of the program.

describeProgramResponse_scheduledStartTime :: Lens' DescribeProgramResponse (Maybe UTCTime) Source #

The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

describeProgramResponse_sourceLocationName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The source location name.

describeProgramResponse_vodSourceName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name that's used to refer to a VOD source.

describeProgramResponse_httpStatus :: Lens' DescribeProgramResponse Int Source #

The response's http status code.