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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an existing channel

Synopsis

data StartChannel = StartChannel' {
- channelId :: Text
}
newStartChannel :: Text -> StartChannel
startChannel_channelId :: Lens' StartChannel Text
data StartChannelResponse = StartChannelResponse' {
- arn :: Maybe Text
- cdiInputSpecification :: Maybe CdiInputSpecification
- channelClass :: Maybe ChannelClass
- destinations :: Maybe [OutputDestination]
- egressEndpoints :: Maybe [ChannelEgressEndpoint]
- encoderSettings :: Maybe EncoderSettings
- id :: Maybe Text
- inputAttachments :: Maybe [InputAttachment]
- inputSpecification :: Maybe InputSpecification
- logLevel :: Maybe LogLevel
- maintenance :: Maybe MaintenanceStatus
- name :: Maybe Text
- pipelineDetails :: Maybe [PipelineDetail]
- pipelinesRunningCount :: Maybe Int
- roleArn :: Maybe Text
- state :: Maybe ChannelState
- tags :: Maybe (HashMap Text Text)
- vpc :: Maybe VpcOutputSettingsDescription
- httpStatus :: Int
}
newStartChannelResponse :: Int -> StartChannelResponse
startChannelResponse_arn :: Lens' StartChannelResponse (Maybe Text)
startChannelResponse_cdiInputSpecification :: Lens' StartChannelResponse (Maybe CdiInputSpecification)
startChannelResponse_channelClass :: Lens' StartChannelResponse (Maybe ChannelClass)
startChannelResponse_destinations :: Lens' StartChannelResponse (Maybe [OutputDestination])
startChannelResponse_egressEndpoints :: Lens' StartChannelResponse (Maybe [ChannelEgressEndpoint])
startChannelResponse_encoderSettings :: Lens' StartChannelResponse (Maybe EncoderSettings)
startChannelResponse_id :: Lens' StartChannelResponse (Maybe Text)
startChannelResponse_inputAttachments :: Lens' StartChannelResponse (Maybe [InputAttachment])
startChannelResponse_inputSpecification :: Lens' StartChannelResponse (Maybe InputSpecification)
startChannelResponse_logLevel :: Lens' StartChannelResponse (Maybe LogLevel)
startChannelResponse_maintenance :: Lens' StartChannelResponse (Maybe MaintenanceStatus)
startChannelResponse_name :: Lens' StartChannelResponse (Maybe Text)
startChannelResponse_pipelineDetails :: Lens' StartChannelResponse (Maybe [PipelineDetail])
startChannelResponse_pipelinesRunningCount :: Lens' StartChannelResponse (Maybe Int)
startChannelResponse_roleArn :: Lens' StartChannelResponse (Maybe Text)
startChannelResponse_state :: Lens' StartChannelResponse (Maybe ChannelState)
startChannelResponse_tags :: Lens' StartChannelResponse (Maybe (HashMap Text Text))
startChannelResponse_vpc :: Lens' StartChannelResponse (Maybe VpcOutputSettingsDescription)
startChannelResponse_httpStatus :: Lens' StartChannelResponse Int

Creating a Request

data StartChannel Source #

Placeholder documentation for StartChannelRequest

See: newStartChannel smart constructor.

Constructors

StartChannel'
Fields channelId :: Text A request to start a channel

Instances

Instances details

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

newStartChannel Source #

Arguments

:: Text	`StartChannel`
-> StartChannel

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

StartChannel, startChannel_channelId - A request to start a channel

Request Lenses

startChannel_channelId :: Lens' StartChannel Text Source #

A request to start a channel

Destructuring the Response

data StartChannelResponse Source #

Placeholder documentation for StartChannelResponse

See: newStartChannelResponse smart constructor.

Constructors

StartChannelResponse'

Fields

arn :: Maybe Text
The unique arn of the channel.
cdiInputSpecification :: Maybe CdiInputSpecification
Specification of CDI inputs for this channel
channelClass :: Maybe ChannelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
destinations :: Maybe [OutputDestination]
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
egressEndpoints :: Maybe [ChannelEgressEndpoint]
The endpoints where outgoing connections initiate from
encoderSettings :: Maybe EncoderSettings
id :: Maybe Text
The unique id of the channel.
inputAttachments :: Maybe [InputAttachment]
List of input attachments for channel.
inputSpecification :: Maybe InputSpecification
Specification of network and file inputs for this channel
logLevel :: Maybe LogLevel
The log level being written to CloudWatch Logs.
maintenance :: Maybe MaintenanceStatus
Maintenance settings for this channel.
name :: Maybe Text
The name of the channel. (user-mutable)
pipelineDetails :: Maybe [PipelineDetail]
Runtime details for the pipelines of a running channel.
pipelinesRunningCount :: Maybe Int
The number of currently healthy pipelines.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the role assumed when running the Channel.
state :: Maybe ChannelState
tags :: Maybe (HashMap Text Text)
A collection of key-value pairs.
vpc :: Maybe VpcOutputSettingsDescription
Settings for VPC output
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel Associated Types type Rep StartChannelResponse :: Type -> Type # Methods from :: StartChannelResponse -> Rep StartChannelResponse x # to :: Rep StartChannelResponse x -> StartChannelResponse #
Read StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel Methods readsPrec :: Int -> ReadS StartChannelResponse # readList :: ReadS [StartChannelResponse] # readPrec :: ReadPrec StartChannelResponse # readListPrec :: ReadPrec [StartChannelResponse] #
Show StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel Methods showsPrec :: Int -> StartChannelResponse -> ShowS # show :: StartChannelResponse -> String # showList :: [StartChannelResponse] -> ShowS #
NFData StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel Methods rnf :: StartChannelResponse -> () #
Eq StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel Methods (==) :: StartChannelResponse -> StartChannelResponse -> Bool # (/=) :: StartChannelResponse -> StartChannelResponse -> Bool #
type Rep StartChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StartChannel type Rep StartChannelResponse = D1 ('MetaData "StartChannelResponse" "Amazonka.MediaLive.StartChannel" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "StartChannelResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cdiInputSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CdiInputSpecification))) :: (S1 ('MetaSel ('Just "channelClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelClass)) :: S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputDestination])))) :: ((S1 ('MetaSel ('Just "egressEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelEgressEndpoint])) :: S1 ('MetaSel ('Just "encoderSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncoderSettings))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "inputAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputAttachment])) :: S1 ('MetaSel ('Just "inputSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputSpecification)))))) :: (((S1 ('MetaSel ('Just "logLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogLevel)) :: S1 ('MetaSel ('Just "maintenance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceStatus))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pipelineDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PipelineDetail])) :: S1 ('MetaSel ('Just "pipelinesRunningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelState))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcOutputSettingsDescription)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newStartChannelResponse Source #

Arguments

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

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

StartChannelResponse, startChannelResponse_arn - The unique arn of the channel.

StartChannelResponse, startChannelResponse_cdiInputSpecification - Specification of CDI inputs for this channel

StartChannelResponse, startChannelResponse_channelClass - The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

StartChannelResponse, startChannelResponse_destinations - A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.

StartChannelResponse, startChannelResponse_egressEndpoints - The endpoints where outgoing connections initiate from

StartChannelResponse, startChannelResponse_encoderSettings - Undocumented member.

StartChannelResponse, startChannelResponse_id - The unique id of the channel.

StartChannelResponse, startChannelResponse_inputAttachments - List of input attachments for channel.

StartChannelResponse, startChannelResponse_inputSpecification - Specification of network and file inputs for this channel

StartChannelResponse, startChannelResponse_logLevel - The log level being written to CloudWatch Logs.

StartChannelResponse, startChannelResponse_maintenance - Maintenance settings for this channel.

StartChannelResponse, startChannelResponse_name - The name of the channel. (user-mutable)

StartChannelResponse, startChannelResponse_pipelineDetails - Runtime details for the pipelines of a running channel.

StartChannelResponse, startChannelResponse_pipelinesRunningCount - The number of currently healthy pipelines.

StartChannelResponse, startChannelResponse_roleArn - The Amazon Resource Name (ARN) of the role assumed when running the Channel.

StartChannelResponse, startChannelResponse_state - Undocumented member.

StartChannelResponse, startChannelResponse_tags - A collection of key-value pairs.

StartChannelResponse, startChannelResponse_vpc - Settings for VPC output

$sel:httpStatus:StartChannelResponse', startChannelResponse_httpStatus - The response's http status code.

Response Lenses

startChannelResponse_arn :: Lens' StartChannelResponse (Maybe Text) Source #

The unique arn of the channel.

startChannelResponse_cdiInputSpecification :: Lens' StartChannelResponse (Maybe CdiInputSpecification) Source #

Specification of CDI inputs for this channel

startChannelResponse_channelClass :: Lens' StartChannelResponse (Maybe ChannelClass) Source #

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

startChannelResponse_destinations :: Lens' StartChannelResponse (Maybe [OutputDestination]) Source #

A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.

startChannelResponse_egressEndpoints :: Lens' StartChannelResponse (Maybe [ChannelEgressEndpoint]) Source #

The endpoints where outgoing connections initiate from

startChannelResponse_encoderSettings :: Lens' StartChannelResponse (Maybe EncoderSettings) Source #

Undocumented member.

startChannelResponse_id :: Lens' StartChannelResponse (Maybe Text) Source #

The unique id of the channel.

startChannelResponse_inputAttachments :: Lens' StartChannelResponse (Maybe [InputAttachment]) Source #

List of input attachments for channel.

startChannelResponse_inputSpecification :: Lens' StartChannelResponse (Maybe InputSpecification) Source #

Specification of network and file inputs for this channel

startChannelResponse_logLevel :: Lens' StartChannelResponse (Maybe LogLevel) Source #

The log level being written to CloudWatch Logs.