libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTAnalytics.DescribeChannel

Description

Retrieves information about a channel.

Synopsis

Creating a Request

data DescribeChannel Source #

See: newDescribeChannel smart constructor.

Constructors

DescribeChannel' 

Fields

  • includeStatistics :: Maybe Bool

    If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

  • channelName :: Text

    The name of the channel whose information is retrieved.

Instances

Instances details
Eq DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

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

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

Read DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannel #

readList :: ReadS [DescribeChannel] #

readPrec :: ReadPrec DescribeChannel #

readListPrec :: ReadPrec [DescribeChannel] #

Show DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannel -> ShowS #

show :: DescribeChannel -> String #

showList :: [DescribeChannel] -> ShowS #

Generic DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Associated Types

type Rep DescribeChannel :: Type -> Type #

Methods

from :: DescribeChannel -> Rep DescribeChannel x #

to :: Rep DescribeChannel x -> DescribeChannel #

NFData DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

rnf :: DescribeChannel -> () #

Hashable DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

hashWithSalt :: Int -> DescribeChannel -> Int #

hash :: DescribeChannel -> Int #

AWSRequest DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Associated Types

type AWSResponse DescribeChannel #

Methods

request :: DescribeChannel -> Request DescribeChannel #

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

ToHeaders DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toHeaders :: DescribeChannel -> [Header] #

ToPath DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toPath :: DescribeChannel -> ByteString #

ToQuery DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toQuery :: DescribeChannel -> QueryString #

type Rep DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

type Rep DescribeChannel = D1 ('MetaData "DescribeChannel" "Amazonka.IoTAnalytics.DescribeChannel" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "DescribeChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeChannel Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

type AWSResponse DescribeChannel = DescribeChannelResponse

newDescribeChannel Source #

Arguments

:: Text

$sel:channelName: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:

$sel:includeStatistics:DescribeChannel', describeChannel_includeStatistics - If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

$sel:channelName:DescribeChannel', describeChannel_channelName - The name of the channel whose information is retrieved.

Request Lenses

describeChannel_includeStatistics :: Lens' DescribeChannel (Maybe Bool) Source #

If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

describeChannel_channelName :: Lens' DescribeChannel Text Source #

The name of the channel whose information is retrieved.

Destructuring the Response

data DescribeChannelResponse Source #

See: newDescribeChannelResponse smart constructor.

Constructors

DescribeChannelResponse' 

Fields

Instances

Instances details
Eq DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

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

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

Read DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannelResponse #

readList :: ReadS [DescribeChannelResponse] #

readPrec :: ReadPrec DescribeChannelResponse #

readListPrec :: ReadPrec [DescribeChannelResponse] #

Show DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannelResponse -> ShowS #

show :: DescribeChannelResponse -> String #

showList :: [DescribeChannelResponse] -> ShowS #

Generic DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Associated Types

type Rep DescribeChannelResponse :: Type -> Type #

Methods

from :: DescribeChannelResponse -> Rep DescribeChannelResponse x #

to :: Rep DescribeChannelResponse x -> DescribeChannelResponse #

NFData DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

rnf :: DescribeChannelResponse -> () #

type Rep DescribeChannelResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.DescribeChannel

type Rep DescribeChannelResponse = D1 ('MetaData "DescribeChannelResponse" "Amazonka.IoTAnalytics.DescribeChannel" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "DescribeChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Channel)) :*: (S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStatistics)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeChannelResponse Source #

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:

$sel:channel:DescribeChannelResponse', describeChannelResponse_channel - An object that contains information about the channel.

$sel:statistics:DescribeChannelResponse', describeChannelResponse_statistics - Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

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

Response Lenses

describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #

An object that contains information about the channel.

describeChannelResponse_statistics :: Lens' DescribeChannelResponse (Maybe ChannelStatistics) Source #

Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int Source #

The response's http status code.