Amazonka.MediaLive.StartChannel

Starts an existing channel

Creating a Request

data StartChannel

Placeholder documentation for StartChannelRequest

See: newStartChannel smart constructor.

Constructors

StartChannel'

Fields

• channelId :: Text

  A request to start a channel

Instances

ToJSON StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

toJSON :: StartChannel -> Value

toEncoding :: StartChannel -> Encoding

toJSONList :: [StartChannel] -> Value

toEncodingList :: [StartChannel] -> Encoding

ToHeaders StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

toHeaders :: StartChannel -> [Header]

ToPath StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

toPath :: StartChannel -> ByteString

ToQuery StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

toQuery :: StartChannel -> QueryString

AWSRequest StartChannel

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

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

Defined in Amazonka.MediaLive.StartChannel

Methods

readsPrec :: Int -> ReadS StartChannel

readList :: ReadS [StartChannel]

readPrec :: ReadPrec StartChannel

readListPrec :: ReadPrec [StartChannel]

Show StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

showsPrec :: Int -> StartChannel -> ShowS

show :: StartChannel -> String

showList :: [StartChannel] -> ShowS

NFData StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

rnf :: StartChannel -> ()

Eq StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

(==) :: StartChannel -> StartChannel -> Bool

(/=) :: StartChannel -> StartChannel -> Bool

Hashable StartChannel

Defined in Amazonka.MediaLive.StartChannel

Methods

hashWithSalt :: Int -> StartChannel -> Int

hash :: StartChannel -> Int

type AWSResponse StartChannel

Defined in Amazonka.MediaLive.StartChannel

type AWSResponse StartChannel = StartChannelResponse

type Rep StartChannel

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

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

A request to start a channel

Destructuring the Response

data StartChannelResponse

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

Generic StartChannelResponse

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

Defined in Amazonka.MediaLive.StartChannel

Methods

readsPrec :: Int -> ReadS StartChannelResponse

readList :: ReadS [StartChannelResponse]

readPrec :: ReadPrec StartChannelResponse

readListPrec :: ReadPrec [StartChannelResponse]

Show StartChannelResponse

Defined in Amazonka.MediaLive.StartChannel

Methods

showsPrec :: Int -> StartChannelResponse -> ShowS

show :: StartChannelResponse -> String

showList :: [StartChannelResponse] -> ShowS

NFData StartChannelResponse

Defined in Amazonka.MediaLive.StartChannel

Methods

rnf :: StartChannelResponse -> ()

Eq StartChannelResponse

Defined in Amazonka.MediaLive.StartChannel

Methods

(==) :: StartChannelResponse -> StartChannelResponse -> Bool

(/=) :: StartChannelResponse -> StartChannelResponse -> Bool

type Rep StartChannelResponse

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

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)

The unique arn of the channel.

startChannelResponse_cdiInputSpecification :: Lens' StartChannelResponse (Maybe CdiInputSpecification)

Specification of CDI inputs for this channel

startChannelResponse_channelClass :: Lens' StartChannelResponse (Maybe ChannelClass)

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])

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])

The endpoints where outgoing connections initiate from

startChannelResponse_encoderSettings :: Lens' StartChannelResponse (Maybe EncoderSettings)

Undocumented member.

startChannelResponse_id :: Lens' StartChannelResponse (Maybe Text)

The unique id of the channel.

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

List of input attachments for channel.

startChannelResponse_inputSpecification :: Lens' StartChannelResponse (Maybe InputSpecification)

Specification of network and file inputs for this channel

startChannelResponse_logLevel :: Lens' StartChannelResponse (Maybe LogLevel)

The log level being written to CloudWatch Logs.

startChannelResponse_maintenance :: Lens' StartChannelResponse (Maybe MaintenanceStatus)

Maintenance settings for this channel.

startChannelResponse_name :: Lens' StartChannelResponse (Maybe Text)

The name of the channel. (user-mutable)

startChannelResponse_pipelineDetails :: Lens' StartChannelResponse (Maybe [PipelineDetail])

Runtime details for the pipelines of a running channel.

startChannelResponse_pipelinesRunningCount :: Lens' StartChannelResponse (Maybe Int)

The number of currently healthy pipelines.

startChannelResponse_roleArn :: Lens' StartChannelResponse (Maybe Text)

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

startChannelResponse_state :: Lens' StartChannelResponse (Maybe ChannelState)

Undocumented member.

startChannelResponse_tags :: Lens' StartChannelResponse (Maybe (HashMap Text Text))

A collection of key-value pairs.

startChannelResponse_vpc :: Lens' StartChannelResponse (Maybe VpcOutputSettingsDescription)

Settings for VPC output

startChannelResponse_httpStatus :: Lens' StartChannelResponse Int

The response's http status code.