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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.

Synopsis

data StartMultiplex = StartMultiplex' {
- multiplexId :: Text
}
newStartMultiplex :: Text -> StartMultiplex
startMultiplex_multiplexId :: Lens' StartMultiplex Text
data StartMultiplexResponse = StartMultiplexResponse' {
- state :: Maybe MultiplexState
- arn :: Maybe Text
- pipelinesRunningCount :: Maybe Int
- availabilityZones :: Maybe [Text]
- programCount :: Maybe Int
- destinations :: Maybe [MultiplexOutputDestination]
- name :: Maybe Text
- id :: Maybe Text
- multiplexSettings :: Maybe MultiplexSettings
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newStartMultiplexResponse :: Int -> StartMultiplexResponse
startMultiplexResponse_state :: Lens' StartMultiplexResponse (Maybe MultiplexState)
startMultiplexResponse_arn :: Lens' StartMultiplexResponse (Maybe Text)
startMultiplexResponse_pipelinesRunningCount :: Lens' StartMultiplexResponse (Maybe Int)
startMultiplexResponse_availabilityZones :: Lens' StartMultiplexResponse (Maybe [Text])
startMultiplexResponse_programCount :: Lens' StartMultiplexResponse (Maybe Int)
startMultiplexResponse_destinations :: Lens' StartMultiplexResponse (Maybe [MultiplexOutputDestination])
startMultiplexResponse_name :: Lens' StartMultiplexResponse (Maybe Text)
startMultiplexResponse_id :: Lens' StartMultiplexResponse (Maybe Text)
startMultiplexResponse_multiplexSettings :: Lens' StartMultiplexResponse (Maybe MultiplexSettings)
startMultiplexResponse_tags :: Lens' StartMultiplexResponse (Maybe (HashMap Text Text))
startMultiplexResponse_httpStatus :: Lens' StartMultiplexResponse Int

Creating a Request

data StartMultiplex Source #

Placeholder documentation for StartMultiplexRequest

See: newStartMultiplex smart constructor.

Constructors

StartMultiplex'
Fields multiplexId :: Text The ID of the multiplex.

Instances

Instances details

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

newStartMultiplex Source #

Arguments

:: Text	`$sel:multiplexId:StartMultiplex'`
-> StartMultiplex

Create a value of StartMultiplex 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:multiplexId:StartMultiplex', startMultiplex_multiplexId - The ID of the multiplex.

Request Lenses

startMultiplex_multiplexId :: Lens' StartMultiplex Text Source #

The ID of the multiplex.

Destructuring the Response

data StartMultiplexResponse Source #

Placeholder documentation for StartMultiplexResponse

See: newStartMultiplexResponse smart constructor.

Constructors

StartMultiplexResponse'

Fields

state :: Maybe MultiplexState
The current state of the multiplex.
arn :: Maybe Text
The unique arn of the multiplex.
pipelinesRunningCount :: Maybe Int
The number of currently healthy pipelines.
availabilityZones :: Maybe [Text]
A list of availability zones for the multiplex.
programCount :: Maybe Int
The number of programs in the multiplex.
destinations :: Maybe [MultiplexOutputDestination]
A list of the multiplex output destinations.
name :: Maybe Text
The name of the multiplex.
id :: Maybe Text
The unique id of the multiplex.
multiplexSettings :: Maybe MultiplexSettings
Configuration for a multiplex event.
tags :: Maybe (HashMap Text Text)
A collection of key-value pairs.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex Methods (==) :: StartMultiplexResponse -> StartMultiplexResponse -> Bool # (/=) :: StartMultiplexResponse -> StartMultiplexResponse -> Bool #
Read StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex Methods readsPrec :: Int -> ReadS StartMultiplexResponse # readList :: ReadS [StartMultiplexResponse] # readPrec :: ReadPrec StartMultiplexResponse # readListPrec :: ReadPrec [StartMultiplexResponse] #
Show StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex Methods showsPrec :: Int -> StartMultiplexResponse -> ShowS # show :: StartMultiplexResponse -> String # showList :: [StartMultiplexResponse] -> ShowS #
Generic StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex Associated Types type Rep StartMultiplexResponse :: Type -> Type # Methods from :: StartMultiplexResponse -> Rep StartMultiplexResponse x # to :: Rep StartMultiplexResponse x -> StartMultiplexResponse #
NFData StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex Methods rnf :: StartMultiplexResponse -> () #
type Rep StartMultiplexResponse Source #
Instance details Defined in Amazonka.MediaLive.StartMultiplex type Rep StartMultiplexResponse = D1 ('MetaData "StartMultiplexResponse" "Amazonka.MediaLive.StartMultiplex" "libZSservicesZSamazonka-medialiveZSamazonka-medialive" 'False) (C1 ('MetaCons "StartMultiplexResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiplexState)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pipelinesRunningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "programCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MultiplexOutputDestination])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "multiplexSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiplexSettings)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newStartMultiplexResponse Source #

Arguments

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

Create a value of StartMultiplexResponse 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:state:StartMultiplexResponse', startMultiplexResponse_state - The current state of the multiplex.

$sel:arn:StartMultiplexResponse', startMultiplexResponse_arn - The unique arn of the multiplex.

$sel:pipelinesRunningCount:StartMultiplexResponse', startMultiplexResponse_pipelinesRunningCount - The number of currently healthy pipelines.

$sel:availabilityZones:StartMultiplexResponse', startMultiplexResponse_availabilityZones - A list of availability zones for the multiplex.

$sel:programCount:StartMultiplexResponse', startMultiplexResponse_programCount - The number of programs in the multiplex.

$sel:destinations:StartMultiplexResponse', startMultiplexResponse_destinations - A list of the multiplex output destinations.

$sel:name:StartMultiplexResponse', startMultiplexResponse_name - The name of the multiplex.

$sel:id:StartMultiplexResponse', startMultiplexResponse_id - The unique id of the multiplex.

$sel:multiplexSettings:StartMultiplexResponse', startMultiplexResponse_multiplexSettings - Configuration for a multiplex event.

$sel:tags:StartMultiplexResponse', startMultiplexResponse_tags - A collection of key-value pairs.

$sel:httpStatus:StartMultiplexResponse', startMultiplexResponse_httpStatus - The response's http status code.

Response Lenses

startMultiplexResponse_state :: Lens' StartMultiplexResponse (Maybe MultiplexState) Source #

The current state of the multiplex.

startMultiplexResponse_arn :: Lens' StartMultiplexResponse (Maybe Text) Source #

The unique arn of the multiplex.

startMultiplexResponse_pipelinesRunningCount :: Lens' StartMultiplexResponse (Maybe Int) Source #

The number of currently healthy pipelines.

startMultiplexResponse_availabilityZones :: Lens' StartMultiplexResponse (Maybe [Text]) Source #

A list of availability zones for the multiplex.

startMultiplexResponse_programCount :: Lens' StartMultiplexResponse (Maybe Int) Source #

The number of programs in the multiplex.

startMultiplexResponse_destinations :: Lens' StartMultiplexResponse (Maybe [MultiplexOutputDestination]) Source #

A list of the multiplex output destinations.

startMultiplexResponse_name :: Lens' StartMultiplexResponse (Maybe Text) Source #

The name of the multiplex.

startMultiplexResponse_id :: Lens' StartMultiplexResponse (Maybe Text) Source #

The unique id of the multiplex.

startMultiplexResponse_multiplexSettings :: Lens' StartMultiplexResponse (Maybe MultiplexSettings) Source #

Configuration for a multiplex event.

startMultiplexResponse_tags :: Lens' StartMultiplexResponse (Maybe (HashMap Text Text)) Source #

A collection of key-value pairs.

startMultiplexResponse_httpStatus :: Lens' StartMultiplexResponse Int Source #

The response's http status code.