amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.RegisterThing

Description

Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

Requires permission to access the RegisterThing action.

Synopsis

Creating a Request

data RegisterThing Source #

See: newRegisterThing smart constructor.

Constructors

RegisterThing' 

Fields

Instances

Instances details
ToJSON RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

ToHeaders RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

ToPath RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

ToQuery RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

AWSRequest RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Associated Types

type AWSResponse RegisterThing #

Generic RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Associated Types

type Rep RegisterThing :: Type -> Type #

Read RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Show RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

NFData RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Methods

rnf :: RegisterThing -> () #

Eq RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Hashable RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

type AWSResponse RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

type Rep RegisterThing Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

type Rep RegisterThing = D1 ('MetaData "RegisterThing" "Amazonka.IoT.RegisterThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "RegisterThing'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRegisterThing Source #

Create a value of RegisterThing 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:parameters:RegisterThing', registerThing_parameters - The parameters for provisioning a thing. See Provisioning Templates for more information.

RegisterThing, registerThing_templateBody - The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

Request Lenses

registerThing_parameters :: Lens' RegisterThing (Maybe (HashMap Text Text)) Source #

The parameters for provisioning a thing. See Provisioning Templates for more information.

Destructuring the Response

data RegisterThingResponse Source #

See: newRegisterThingResponse smart constructor.

Constructors

RegisterThingResponse' 

Fields

Instances

Instances details
Generic RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Associated Types

type Rep RegisterThingResponse :: Type -> Type #

Read RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Show RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

NFData RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

Methods

rnf :: RegisterThingResponse -> () #

Eq RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

type Rep RegisterThingResponse Source # 
Instance details

Defined in Amazonka.IoT.RegisterThing

type Rep RegisterThingResponse = D1 ('MetaData "RegisterThingResponse" "Amazonka.IoT.RegisterThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "RegisterThingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificatePem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterThingResponse Source #

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

RegisterThingResponse, registerThingResponse_certificatePem - The certificate data, in PEM format.

$sel:resourceArns:RegisterThingResponse', registerThingResponse_resourceArns - ARNs for the generated resources.

$sel:httpStatus:RegisterThingResponse', registerThingResponse_httpStatus - The response's http status code.

Response Lenses