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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

Requires permission to access the CreateThing action.

Synopsis

data CreateThing = CreateThing' {
- attributePayload :: Maybe AttributePayload
- billingGroupName :: Maybe Text
- thingTypeName :: Maybe Text
- thingName :: Text
}
newCreateThing :: Text -> CreateThing
createThing_attributePayload :: Lens' CreateThing (Maybe AttributePayload)
createThing_billingGroupName :: Lens' CreateThing (Maybe Text)
createThing_thingTypeName :: Lens' CreateThing (Maybe Text)
createThing_thingName :: Lens' CreateThing Text
data CreateThingResponse = CreateThingResponse' {
- thingArn :: Maybe Text
- thingId :: Maybe Text
- thingName :: Maybe Text
- httpStatus :: Int
}
newCreateThingResponse :: Int -> CreateThingResponse
createThingResponse_thingArn :: Lens' CreateThingResponse (Maybe Text)
createThingResponse_thingId :: Lens' CreateThingResponse (Maybe Text)
createThingResponse_thingName :: Lens' CreateThingResponse (Maybe Text)
createThingResponse_httpStatus :: Lens' CreateThingResponse Int

Creating a Request

data CreateThing Source #

The input for the CreateThing operation.

See: newCreateThing smart constructor.

Constructors

CreateThing'

Fields

attributePayload :: Maybe AttributePayload
The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
```
{\"attributes\":{\"string1\":\"string2\"}}
```
billingGroupName :: Maybe Text
The name of the billing group the thing will be added to.
thingTypeName :: Maybe Text
The name of the thing type associated with the new thing.
thingName :: Text
The name of the thing to create.
You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Instances

Instances details

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

newCreateThing Source #

Arguments

:: Text	`CreateThing`
-> CreateThing

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

CreateThing, createThing_attributePayload - The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\"attributes\":{\"string1\":\"string2\"}}

$sel:billingGroupName:CreateThing', createThing_billingGroupName - The name of the billing group the thing will be added to.

CreateThing, createThing_thingTypeName - The name of the thing type associated with the new thing.

CreateThing, createThing_thingName - The name of the thing to create.

You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Request Lenses

createThing_attributePayload :: Lens' CreateThing (Maybe AttributePayload) Source #

The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\"attributes\":{\"string1\":\"string2\"}}

createThing_billingGroupName :: Lens' CreateThing (Maybe Text) Source #

The name of the billing group the thing will be added to.

createThing_thingTypeName :: Lens' CreateThing (Maybe Text) Source #

The name of the thing type associated with the new thing.

createThing_thingName :: Lens' CreateThing Text Source #

The name of the thing to create.

You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Destructuring the Response

data CreateThingResponse Source #

The output of the CreateThing operation.

See: newCreateThingResponse smart constructor.

Constructors

CreateThingResponse'
Fields thingArn :: Maybe Text The ARN of the new thing. thingId :: Maybe Text The thing ID. thingName :: Maybe Text The name of the new thing. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing Associated Types type Rep CreateThingResponse :: Type -> Type # Methods from :: CreateThingResponse -> Rep CreateThingResponse x # to :: Rep CreateThingResponse x -> CreateThingResponse #
Read CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing Methods readsPrec :: Int -> ReadS CreateThingResponse # readList :: ReadS [CreateThingResponse] # readPrec :: ReadPrec CreateThingResponse # readListPrec :: ReadPrec [CreateThingResponse] #
Show CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing Methods showsPrec :: Int -> CreateThingResponse -> ShowS # show :: CreateThingResponse -> String # showList :: [CreateThingResponse] -> ShowS #
NFData CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing Methods rnf :: CreateThingResponse -> () #
Eq CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing Methods (==) :: CreateThingResponse -> CreateThingResponse -> Bool # (/=) :: CreateThingResponse -> CreateThingResponse -> Bool #
type Rep CreateThingResponse Source #
Instance details Defined in Amazonka.IoT.CreateThing type Rep CreateThingResponse = D1 ('MetaData "CreateThingResponse" "Amazonka.IoT.CreateThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateThingResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "thingArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))