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 |
Stops a running channel
Synopsis
- data StopChannel = StopChannel' {}
- 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.
Instances
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.
StopChannelResponse' | |
|
Instances
newStopChannelResponse Source #
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.
stopChannelResponse_maintenance :: Lens' StopChannelResponse (Maybe MaintenanceStatus) Source #
Maintenance settings for this channel.
stopChannelResponse_name :: Lens' StopChannelResponse (Maybe Text) Source #
The name of the channel. (user-mutable)
stopChannelResponse_pipelineDetails :: Lens' StopChannelResponse (Maybe [PipelineDetail]) Source #
Runtime details for the pipelines of a running channel.
stopChannelResponse_pipelinesRunningCount :: Lens' StopChannelResponse (Maybe Int) Source #
The number of currently healthy pipelines.
stopChannelResponse_roleArn :: Lens' StopChannelResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role assumed when running the Channel.
stopChannelResponse_state :: Lens' StopChannelResponse (Maybe ChannelState) Source #
Undocumented member.
stopChannelResponse_tags :: Lens' StopChannelResponse (Maybe (HashMap Text Text)) Source #
A collection of key-value pairs.
stopChannelResponse_vpc :: Lens' StopChannelResponse (Maybe VpcOutputSettingsDescription) Source #
Settings for VPC output
stopChannelResponse_httpStatus :: Lens' StopChannelResponse Int Source #
The response's http status code.