Amazonka.IoTAnalytics.DescribeChannel

Retrieves information about a channel.

Creating a Request

data DescribeChannel

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

ToHeaders DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toHeaders :: DescribeChannel -> [Header]

ToPath DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toPath :: DescribeChannel -> ByteString

ToQuery DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

toQuery :: DescribeChannel -> QueryString

AWSRequest DescribeChannel

Defined in Amazonka.IoTAnalytics.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.IoTAnalytics.DescribeChannel

Associated Types

type Rep DescribeChannel :: Type -> Type

Methods

from :: DescribeChannel -> Rep DescribeChannel x

to :: Rep DescribeChannel x -> DescribeChannel

Read DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannel

readList :: ReadS [DescribeChannel]

readPrec :: ReadPrec DescribeChannel

readListPrec :: ReadPrec [DescribeChannel]

Show DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannel -> ShowS

show :: DescribeChannel -> String

showList :: [DescribeChannel] -> ShowS

NFData DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

rnf :: DescribeChannel -> ()

Eq DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

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

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

Hashable DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

hashWithSalt :: Int -> DescribeChannel -> Int

hash :: DescribeChannel -> Int

type AWSResponse DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

type AWSResponse DescribeChannel = DescribeChannelResponse

type Rep DescribeChannel

Defined in Amazonka.IoTAnalytics.DescribeChannel

type Rep DescribeChannel = D1 ('MetaData "DescribeChannel" "Amazonka.IoTAnalytics.DescribeChannel" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" '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)))

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:

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

DescribeChannel, describeChannel_channelName - The name of the channel whose information is retrieved.

Request Lenses

describeChannel_includeStatistics :: Lens' DescribeChannel (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.

describeChannel_channelName :: Lens' DescribeChannel Text

The name of the channel whose information is retrieved.

Destructuring the Response

data DescribeChannelResponse

See: newDescribeChannelResponse smart constructor.

Constructors

DescribeChannelResponse'

Fields

• channel :: Maybe Channel

  An object that contains information about the channel.

• statistics :: Maybe ChannelStatistics

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

Associated Types

type Rep DescribeChannelResponse :: Type -> Type

Methods

from :: DescribeChannelResponse -> Rep DescribeChannelResponse x

to :: Rep DescribeChannelResponse x -> DescribeChannelResponse

Read DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

readsPrec :: Int -> ReadS DescribeChannelResponse

readList :: ReadS [DescribeChannelResponse]

readPrec :: ReadPrec DescribeChannelResponse

readListPrec :: ReadPrec [DescribeChannelResponse]

Show DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

showsPrec :: Int -> DescribeChannelResponse -> ShowS

show :: DescribeChannelResponse -> String

showList :: [DescribeChannelResponse] -> ShowS

NFData DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

rnf :: DescribeChannelResponse -> ()

Eq DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

Methods

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

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

type Rep DescribeChannelResponse

Defined in Amazonka.IoTAnalytics.DescribeChannel

type Rep DescribeChannelResponse = D1 ('MetaData "DescribeChannelResponse" "Amazonka.IoTAnalytics.DescribeChannel" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" '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

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

An object that contains information about the channel.

describeChannelResponse_statistics :: Lens' DescribeChannelResponse (Maybe ChannelStatistics)

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

describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int

The response's http status code.