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

Amazonka.IoT.CreateTopicRule

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Requires permission to access the CreateTopicRule action.

Creating a Request

data CreateTopicRule Source #

The input for the CreateTopicRule operation.

See: newCreateTopicRule smart constructor.

Constructors

CreateTopicRule'

Fields

tags :: Maybe Text
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
ruleName :: Text
The name of the rule.
topicRulePayload :: TopicRulePayload
The rule payload.

Instances

Instances details

ToJSON CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods toJSON :: CreateTopicRule -> Value # toEncoding :: CreateTopicRule -> Encoding # toJSONList :: [CreateTopicRule] -> Value # toEncodingList :: [CreateTopicRule] -> Encoding #
ToHeaders CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods toHeaders :: CreateTopicRule -> [Header] #
ToPath CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods toPath :: CreateTopicRule -> ByteString #
ToQuery CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods toQuery :: CreateTopicRule -> QueryString #
AWSRequest CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Associated Types type AWSResponse CreateTopicRule # Methods request :: (Service -> Service) -> CreateTopicRule -> Request CreateTopicRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTopicRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTopicRule))) #
Generic CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Associated Types type Rep CreateTopicRule :: Type -> Type # Methods from :: CreateTopicRule -> Rep CreateTopicRule x # to :: Rep CreateTopicRule x -> CreateTopicRule #
Read CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods readsPrec :: Int -> ReadS CreateTopicRule # readList :: ReadS [CreateTopicRule] # readPrec :: ReadPrec CreateTopicRule # readListPrec :: ReadPrec [CreateTopicRule] #
Show CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods showsPrec :: Int -> CreateTopicRule -> ShowS # show :: CreateTopicRule -> String # showList :: [CreateTopicRule] -> ShowS #
NFData CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods rnf :: CreateTopicRule -> () #
Eq CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods (==) :: CreateTopicRule -> CreateTopicRule -> Bool # (/=) :: CreateTopicRule -> CreateTopicRule -> Bool #
Hashable CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods hashWithSalt :: Int -> CreateTopicRule -> Int # hash :: CreateTopicRule -> Int #
type AWSResponse CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule type AWSResponse CreateTopicRule = CreateTopicRuleResponse
type Rep CreateTopicRule Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule type Rep CreateTopicRule = D1 ('MetaData "CreateTopicRule" "Amazonka.IoT.CreateTopicRule" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateTopicRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "topicRulePayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TopicRulePayload))))

newCreateTopicRule Source #

Arguments

:: Text	`CreateTopicRule`
-> TopicRulePayload	`$sel:topicRulePayload:CreateTopicRule'`
-> CreateTopicRule

Create a value of CreateTopicRule 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:tags:CreateTopicRule', createTopicRule_tags - Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

CreateTopicRule, createTopicRule_ruleName - The name of the rule.

$sel:topicRulePayload:CreateTopicRule', createTopicRule_topicRulePayload - The rule payload.

Request Lenses

createTopicRule_tags :: Lens' CreateTopicRule (Maybe Text) Source #

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

createTopicRule_ruleName :: Lens' CreateTopicRule Text Source #

The name of the rule.

createTopicRule_topicRulePayload :: Lens' CreateTopicRule TopicRulePayload Source #

The rule payload.

Destructuring the Response

data CreateTopicRuleResponse Source #

See: newCreateTopicRuleResponse smart constructor.

Constructors

CreateTopicRuleResponse'

Instances

Instances details

Generic CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Associated Types type Rep CreateTopicRuleResponse :: Type -> Type # Methods from :: CreateTopicRuleResponse -> Rep CreateTopicRuleResponse x # to :: Rep CreateTopicRuleResponse x -> CreateTopicRuleResponse #
Read CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods readsPrec :: Int -> ReadS CreateTopicRuleResponse # readList :: ReadS [CreateTopicRuleResponse] # readPrec :: ReadPrec CreateTopicRuleResponse # readListPrec :: ReadPrec [CreateTopicRuleResponse] #
Show CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods showsPrec :: Int -> CreateTopicRuleResponse -> ShowS # show :: CreateTopicRuleResponse -> String # showList :: [CreateTopicRuleResponse] -> ShowS #
NFData CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods rnf :: CreateTopicRuleResponse -> () #
Eq CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule Methods (==) :: CreateTopicRuleResponse -> CreateTopicRuleResponse -> Bool # (/=) :: CreateTopicRuleResponse -> CreateTopicRuleResponse -> Bool #
type Rep CreateTopicRuleResponse Source #
Instance details Defined in Amazonka.IoT.CreateTopicRule type Rep CreateTopicRuleResponse = D1 ('MetaData "CreateTopicRuleResponse" "Amazonka.IoT.CreateTopicRule" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateTopicRuleResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateTopicRuleResponse :: CreateTopicRuleResponse Source #

Create a value of CreateTopicRuleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.