Amazonka.IoTAnalytics.CreateChannel

Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

Creating a Request

data CreateChannel

See: newCreateChannel smart constructor.

Constructors

CreateChannel'

Fields

• channelStorage :: Maybe ChannelStorage

  Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

• retentionPeriod :: Maybe RetentionPeriod

  How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

• tags :: Maybe (NonEmpty Tag)

  Metadata which can be used to manage the channel.

• channelName :: Text

  The name of the channel.

Instances

ToJSON CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

toJSON :: CreateChannel -> Value

toEncoding :: CreateChannel -> Encoding

toJSONList :: [CreateChannel] -> Value

toEncodingList :: [CreateChannel] -> Encoding

ToHeaders CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

toHeaders :: CreateChannel -> [Header]

ToPath CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

toPath :: CreateChannel -> ByteString

ToQuery CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

toQuery :: CreateChannel -> QueryString

AWSRequest CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Associated Types

type AWSResponse CreateChannel

Methods

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

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

Generic CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Associated Types

type Rep CreateChannel :: Type -> Type

Methods

from :: CreateChannel -> Rep CreateChannel x

to :: Rep CreateChannel x -> CreateChannel

Read CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

readsPrec :: Int -> ReadS CreateChannel

readList :: ReadS [CreateChannel]

readPrec :: ReadPrec CreateChannel

readListPrec :: ReadPrec [CreateChannel]

Show CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

showsPrec :: Int -> CreateChannel -> ShowS

show :: CreateChannel -> String

showList :: [CreateChannel] -> ShowS

NFData CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

rnf :: CreateChannel -> ()

Eq CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

(==) :: CreateChannel -> CreateChannel -> Bool

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

Hashable CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

hashWithSalt :: Int -> CreateChannel -> Int

hash :: CreateChannel -> Int

type AWSResponse CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

type AWSResponse CreateChannel = CreateChannelResponse

type Rep CreateChannel

Defined in Amazonka.IoTAnalytics.CreateChannel

type Rep CreateChannel = D1 ('MetaData "CreateChannel" "Amazonka.IoTAnalytics.CreateChannel" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "CreateChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStorage)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateChannel

Arguments

:: Text

CreateChannel

-> CreateChannel

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

CreateChannel, createChannel_channelStorage - Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

CreateChannel, createChannel_retentionPeriod - How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

$sel:tags:CreateChannel', createChannel_tags - Metadata which can be used to manage the channel.

CreateChannel, createChannel_channelName - The name of the channel.

Request Lenses

createChannel_channelStorage :: Lens' CreateChannel (Maybe ChannelStorage)

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

createChannel_retentionPeriod :: Lens' CreateChannel (Maybe RetentionPeriod)

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag))

Metadata which can be used to manage the channel.

createChannel_channelName :: Lens' CreateChannel Text

The name of the channel.

Destructuring the Response

data CreateChannelResponse

See: newCreateChannelResponse smart constructor.

Constructors

CreateChannelResponse'

Fields

• channelArn :: Maybe Text

  The ARN of the channel.

• channelName :: Maybe Text

  The name of the channel.

• retentionPeriod :: Maybe RetentionPeriod

  How long, in days, message data is kept for the channel.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

Associated Types

type Rep CreateChannelResponse :: Type -> Type

Methods

from :: CreateChannelResponse -> Rep CreateChannelResponse x

to :: Rep CreateChannelResponse x -> CreateChannelResponse

Read CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

readsPrec :: Int -> ReadS CreateChannelResponse

readList :: ReadS [CreateChannelResponse]

readPrec :: ReadPrec CreateChannelResponse

readListPrec :: ReadPrec [CreateChannelResponse]

Show CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

showsPrec :: Int -> CreateChannelResponse -> ShowS

show :: CreateChannelResponse -> String

showList :: [CreateChannelResponse] -> ShowS

NFData CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

rnf :: CreateChannelResponse -> ()

Eq CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

Methods

(==) :: CreateChannelResponse -> CreateChannelResponse -> Bool

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

type Rep CreateChannelResponse

Defined in Amazonka.IoTAnalytics.CreateChannel

type Rep CreateChannelResponse = D1 ('MetaData "CreateChannelResponse" "Amazonka.IoTAnalytics.CreateChannel" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "CreateChannelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelResponse

Arguments

:: Int

$sel:httpStatus:CreateChannelResponse'

-> CreateChannelResponse

Create a value of CreateChannelResponse 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:channelArn:CreateChannelResponse', createChannelResponse_channelArn - The ARN of the channel.

CreateChannel, createChannelResponse_channelName - The name of the channel.

CreateChannel, createChannelResponse_retentionPeriod - How long, in days, message data is kept for the channel.

$sel:httpStatus:CreateChannelResponse', createChannelResponse_httpStatus - The response's http status code.

Response Lenses

createChannelResponse_channelArn :: Lens' CreateChannelResponse (Maybe Text)

The ARN of the channel.

createChannelResponse_channelName :: Lens' CreateChannelResponse (Maybe Text)

The name of the channel.

createChannelResponse_retentionPeriod :: Lens' CreateChannelResponse (Maybe RetentionPeriod)

How long, in days, message data is kept for the channel.

createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int

The response's http status code.