Amazonka.MediaLive.DescribeChannel

Gets details about a channel

Creating a Request

data DescribeChannel

Placeholder documentation for DescribeChannelRequest

See: newDescribeChannel smart constructor.

Constructors

DescribeChannel'

Fields

• channelId :: Text

  channel ID

Instances

ToHeaders DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

toHeaders :: DescribeChannel -> [Header]

ToPath DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

toPath :: DescribeChannel -> ByteString

ToQuery DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

toQuery :: DescribeChannel -> QueryString

AWSRequest DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Associated Types

type AWSResponse DescribeChannel

Methods

request :: (Service -> Service) -> DescribeChannel -> Request DescribeChannel

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeChannel)))

Generic DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Associated Types

type Rep DescribeChannel :: Type -> Type

Methods

from :: DescribeChannel -> Rep DescribeChannel x

to :: Rep DescribeChannel x -> DescribeChannel

Read DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannel

readList :: ReadS [DescribeChannel]

readPrec :: ReadPrec DescribeChannel

readListPrec :: ReadPrec [DescribeChannel]

Show DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannel -> ShowS

show :: DescribeChannel -> String

showList :: [DescribeChannel] -> ShowS

NFData DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

rnf :: DescribeChannel -> ()

Eq DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

(==) :: DescribeChannel -> DescribeChannel -> Bool

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

Hashable DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

Methods

hashWithSalt :: Int -> DescribeChannel -> Int

hash :: DescribeChannel -> Int

type AWSResponse DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

type AWSResponse DescribeChannel = DescribeChannelResponse

type Rep DescribeChannel

Defined in Amazonka.MediaLive.DescribeChannel

type Rep DescribeChannel = D1 ('MetaData "DescribeChannel" "Amazonka.MediaLive.DescribeChannel" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "DescribeChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeChannel

Arguments

:: Text

DescribeChannel

-> DescribeChannel

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

DescribeChannel, describeChannel_channelId - channel ID

Request Lenses

describeChannel_channelId :: Lens' DescribeChannel Text

channel ID

Destructuring the Response

data DescribeChannelResponse

Placeholder documentation for DescribeChannelResponse

See: newDescribeChannelResponse smart constructor.

Constructors

DescribeChannelResponse'

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 DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

Associated Types

type Rep DescribeChannelResponse :: Type -> Type

Methods

from :: DescribeChannelResponse -> Rep DescribeChannelResponse x

to :: Rep DescribeChannelResponse x -> DescribeChannelResponse

Read DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannelResponse

readList :: ReadS [DescribeChannelResponse]

readPrec :: ReadPrec DescribeChannelResponse

readListPrec :: ReadPrec [DescribeChannelResponse]

Show DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannelResponse -> ShowS

show :: DescribeChannelResponse -> String

showList :: [DescribeChannelResponse] -> ShowS

NFData DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

Methods

rnf :: DescribeChannelResponse -> ()

Eq DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

Methods

(==) :: DescribeChannelResponse -> DescribeChannelResponse -> Bool

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

type Rep DescribeChannelResponse

Defined in Amazonka.MediaLive.DescribeChannel

type Rep DescribeChannelResponse = D1 ('MetaData "DescribeChannelResponse" "Amazonka.MediaLive.DescribeChannel" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "DescribeChannelResponse'" '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)))))))

newDescribeChannelResponse

Arguments

:: Int

$sel:httpStatus:DescribeChannelResponse'

-> DescribeChannelResponse

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

DescribeChannelResponse, describeChannelResponse_arn - The unique arn of the channel.

DescribeChannelResponse, describeChannelResponse_cdiInputSpecification - Specification of CDI inputs for this channel

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

DescribeChannelResponse, describeChannelResponse_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.

DescribeChannelResponse, describeChannelResponse_egressEndpoints - The endpoints where outgoing connections initiate from

DescribeChannelResponse, describeChannelResponse_encoderSettings - Undocumented member.

DescribeChannelResponse, describeChannelResponse_id - The unique id of the channel.

DescribeChannelResponse, describeChannelResponse_inputAttachments - List of input attachments for channel.

DescribeChannelResponse, describeChannelResponse_inputSpecification - Specification of network and file inputs for this channel

DescribeChannelResponse, describeChannelResponse_logLevel - The log level being written to CloudWatch Logs.

DescribeChannelResponse, describeChannelResponse_maintenance - Maintenance settings for this channel.

DescribeChannelResponse, describeChannelResponse_name - The name of the channel. (user-mutable)

DescribeChannelResponse, describeChannelResponse_pipelineDetails - Runtime details for the pipelines of a running channel.

DescribeChannelResponse, describeChannelResponse_pipelinesRunningCount - The number of currently healthy pipelines.

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

DescribeChannelResponse, describeChannelResponse_state - Undocumented member.

DescribeChannelResponse, describeChannelResponse_tags - A collection of key-value pairs.

DescribeChannelResponse, describeChannelResponse_vpc - Settings for VPC output

$sel:httpStatus:DescribeChannelResponse', describeChannelResponse_httpStatus - The response's http status code.

Response Lenses

describeChannelResponse_arn :: Lens' DescribeChannelResponse (Maybe Text)

The unique arn of the channel.

describeChannelResponse_cdiInputSpecification :: Lens' DescribeChannelResponse (Maybe CdiInputSpecification)

Specification of CDI inputs for this channel

describeChannelResponse_channelClass :: Lens' DescribeChannelResponse (Maybe ChannelClass)

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

describeChannelResponse_destinations :: Lens' DescribeChannelResponse (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.

describeChannelResponse_egressEndpoints :: Lens' DescribeChannelResponse (Maybe [ChannelEgressEndpoint])

The endpoints where outgoing connections initiate from

describeChannelResponse_encoderSettings :: Lens' DescribeChannelResponse (Maybe EncoderSettings)

Undocumented member.

describeChannelResponse_id :: Lens' DescribeChannelResponse (Maybe Text)

The unique id of the channel.

describeChannelResponse_inputAttachments :: Lens' DescribeChannelResponse (Maybe [InputAttachment])

List of input attachments for channel.

describeChannelResponse_inputSpecification :: Lens' DescribeChannelResponse (Maybe InputSpecification)

Specification of network and file inputs for this channel

describeChannelResponse_logLevel :: Lens' DescribeChannelResponse (Maybe LogLevel)

The log level being written to CloudWatch Logs.

describeChannelResponse_maintenance :: Lens' DescribeChannelResponse (Maybe MaintenanceStatus)

Maintenance settings for this channel.

describeChannelResponse_name :: Lens' DescribeChannelResponse (Maybe Text)

The name of the channel. (user-mutable)

describeChannelResponse_pipelineDetails :: Lens' DescribeChannelResponse (Maybe [PipelineDetail])

Runtime details for the pipelines of a running channel.

describeChannelResponse_pipelinesRunningCount :: Lens' DescribeChannelResponse (Maybe Int)

The number of currently healthy pipelines.

describeChannelResponse_roleArn :: Lens' DescribeChannelResponse (Maybe Text)

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

describeChannelResponse_state :: Lens' DescribeChannelResponse (Maybe ChannelState)

Undocumented member.

describeChannelResponse_tags :: Lens' DescribeChannelResponse (Maybe (HashMap Text Text))

A collection of key-value pairs.

describeChannelResponse_vpc :: Lens' DescribeChannelResponse (Maybe VpcOutputSettingsDescription)

Settings for VPC output

describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int

The response's http status code.