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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a running channel

Synopsis

data StopChannel = StopChannel' {
- channelId :: Text
}
newStopChannel :: Text -> StopChannel
stopChannel_channelId :: Lens' StopChannel Text
data StopChannelResponse = StopChannelResponse' {
- 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
}
newStopChannelResponse :: Int -> StopChannelResponse
stopChannelResponse_arn :: Lens' StopChannelResponse (Maybe Text)
stopChannelResponse_cdiInputSpecification :: Lens' StopChannelResponse (Maybe CdiInputSpecification)
stopChannelResponse_channelClass :: Lens' StopChannelResponse (Maybe ChannelClass)
stopChannelResponse_destinations :: Lens' StopChannelResponse (Maybe [OutputDestination])
stopChannelResponse_egressEndpoints :: Lens' StopChannelResponse (Maybe [ChannelEgressEndpoint])
stopChannelResponse_encoderSettings :: Lens' StopChannelResponse (Maybe EncoderSettings)
stopChannelResponse_id :: Lens' StopChannelResponse (Maybe Text)
stopChannelResponse_inputAttachments :: Lens' StopChannelResponse (Maybe [InputAttachment])
stopChannelResponse_inputSpecification :: Lens' StopChannelResponse (Maybe InputSpecification)
stopChannelResponse_logLevel :: Lens' StopChannelResponse (Maybe LogLevel)
stopChannelResponse_maintenance :: Lens' StopChannelResponse (Maybe MaintenanceStatus)
stopChannelResponse_name :: Lens' StopChannelResponse (Maybe Text)
stopChannelResponse_pipelineDetails :: Lens' StopChannelResponse (Maybe [PipelineDetail])
stopChannelResponse_pipelinesRunningCount :: Lens' StopChannelResponse (Maybe Int)
stopChannelResponse_roleArn :: Lens' StopChannelResponse (Maybe Text)
stopChannelResponse_state :: Lens' StopChannelResponse (Maybe ChannelState)
stopChannelResponse_tags :: Lens' StopChannelResponse (Maybe (HashMap Text Text))
stopChannelResponse_vpc :: Lens' StopChannelResponse (Maybe VpcOutputSettingsDescription)
stopChannelResponse_httpStatus :: Lens' StopChannelResponse Int

Creating a Request

data StopChannel Source #

Placeholder documentation for StopChannelRequest

See: newStopChannel smart constructor.

Constructors

StopChannel'
Fields channelId :: Text A request to stop a running channel

Instances

Instances details

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

newStopChannel Source #

Arguments

:: Text	`StopChannel`
-> StopChannel

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

StopChannel, stopChannel_channelId - A request to stop a running channel

Request Lenses

stopChannel_channelId :: Lens' StopChannel Text Source #

A request to stop a running channel

Destructuring the Response

data StopChannelResponse Source #

Placeholder documentation for StopChannelResponse

See: newStopChannelResponse smart constructor.

Constructors

StopChannelResponse'

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 StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel Associated Types type Rep StopChannelResponse :: Type -> Type # Methods from :: StopChannelResponse -> Rep StopChannelResponse x # to :: Rep StopChannelResponse x -> StopChannelResponse #
Read StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel Methods readsPrec :: Int -> ReadS StopChannelResponse # readList :: ReadS [StopChannelResponse] # readPrec :: ReadPrec StopChannelResponse # readListPrec :: ReadPrec [StopChannelResponse] #
Show StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel Methods showsPrec :: Int -> StopChannelResponse -> ShowS # show :: StopChannelResponse -> String # showList :: [StopChannelResponse] -> ShowS #
NFData StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel Methods rnf :: StopChannelResponse -> () #
Eq StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel Methods (==) :: StopChannelResponse -> StopChannelResponse -> Bool # (/=) :: StopChannelResponse -> StopChannelResponse -> Bool #
type Rep StopChannelResponse Source #
Instance details Defined in Amazonka.MediaLive.StopChannel type Rep StopChannelResponse = D1 ('MetaData "StopChannelResponse" "Amazonka.MediaLive.StopChannel" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "StopChannelResponse'" '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)))))))

newStopChannelResponse Source #

Arguments

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

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

StopChannelResponse, stopChannelResponse_arn - The unique arn of the channel.

StopChannelResponse, stopChannelResponse_cdiInputSpecification - Specification of CDI inputs for this channel

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

StopChannelResponse, stopChannelResponse_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.

StopChannelResponse, stopChannelResponse_egressEndpoints - The endpoints where outgoing connections initiate from

StopChannelResponse, stopChannelResponse_encoderSettings - Undocumented member.

StopChannelResponse, stopChannelResponse_id - The unique id of the channel.

StopChannelResponse, stopChannelResponse_inputAttachments - List of input attachments for channel.

StopChannelResponse, stopChannelResponse_inputSpecification - Specification of network and file inputs for this channel

StopChannelResponse, stopChannelResponse_logLevel - The log level being written to CloudWatch Logs.

StopChannelResponse, stopChannelResponse_maintenance - Maintenance settings for this channel.

StopChannelResponse, stopChannelResponse_name - The name of the channel. (user-mutable)

StopChannelResponse, stopChannelResponse_pipelineDetails - Runtime details for the pipelines of a running channel.

StopChannelResponse, stopChannelResponse_pipelinesRunningCount - The number of currently healthy pipelines.

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

StopChannelResponse, stopChannelResponse_state - Undocumented member.

StopChannelResponse, stopChannelResponse_tags - A collection of key-value pairs.

StopChannelResponse, stopChannelResponse_vpc - Settings for VPC output

$sel:httpStatus:StopChannelResponse', stopChannelResponse_httpStatus - The response's http status code.

Response Lenses

stopChannelResponse_arn :: Lens' StopChannelResponse (Maybe Text) Source #

The unique arn of the channel.

stopChannelResponse_cdiInputSpecification :: Lens' StopChannelResponse (Maybe CdiInputSpecification) Source #

Specification of CDI inputs for this channel

stopChannelResponse_channelClass :: Lens' StopChannelResponse (Maybe ChannelClass) Source #

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

stopChannelResponse_destinations :: Lens' StopChannelResponse (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.

stopChannelResponse_egressEndpoints :: Lens' StopChannelResponse (Maybe [ChannelEgressEndpoint]) Source #

The endpoints where outgoing connections initiate from

stopChannelResponse_encoderSettings :: Lens' StopChannelResponse (Maybe EncoderSettings) Source #

Undocumented member.

stopChannelResponse_id :: Lens' StopChannelResponse (Maybe Text) Source #

The unique id of the channel.

stopChannelResponse_inputAttachments :: Lens' StopChannelResponse (Maybe [InputAttachment]) Source #

List of input attachments for channel.

stopChannelResponse_inputSpecification :: Lens' StopChannelResponse (Maybe InputSpecification) Source #

Specification of network and file inputs for this channel

stopChannelResponse_logLevel :: Lens' StopChannelResponse (Maybe LogLevel) Source #

The log level being written to CloudWatch Logs.