amazonka-iot1click-devices-2.0: Amazon IoT 1-Click Devices Service 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.IoT1ClickDevices.ClaimDevicesByClaimCode

Description

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

Synopsis

Creating a Request

data ClaimDevicesByClaimCode Source #

See: newClaimDevicesByClaimCode smart constructor.

Constructors

ClaimDevicesByClaimCode' 

Fields

  • claimCode :: Text

    The claim code, starting with "C-", as provided by the device manufacturer.

Instances

Instances details
ToJSON ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

ToHeaders ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

ToPath ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

ToQuery ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

AWSRequest ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Generic ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Associated Types

type Rep ClaimDevicesByClaimCode :: Type -> Type #

Read ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Show ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

NFData ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Methods

rnf :: ClaimDevicesByClaimCode -> () #

Eq ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Hashable ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

type AWSResponse ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

type Rep ClaimDevicesByClaimCode Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

type Rep ClaimDevicesByClaimCode = D1 ('MetaData "ClaimDevicesByClaimCode" "Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "ClaimDevicesByClaimCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "claimCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newClaimDevicesByClaimCode Source #

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

ClaimDevicesByClaimCode, claimDevicesByClaimCode_claimCode - The claim code, starting with "C-", as provided by the device manufacturer.

Request Lenses

claimDevicesByClaimCode_claimCode :: Lens' ClaimDevicesByClaimCode Text Source #

The claim code, starting with "C-", as provided by the device manufacturer.

Destructuring the Response

data ClaimDevicesByClaimCodeResponse Source #

See: newClaimDevicesByClaimCodeResponse smart constructor.

Constructors

ClaimDevicesByClaimCodeResponse' 

Fields

  • claimCode :: Maybe Text

    The claim code provided by the device manufacturer.

  • total :: Maybe Int

    The total number of devices associated with the claim code that has been processed in the claim request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Associated Types

type Rep ClaimDevicesByClaimCodeResponse :: Type -> Type #

Read ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Show ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

NFData ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

Eq ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

type Rep ClaimDevicesByClaimCodeResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode

type Rep ClaimDevicesByClaimCodeResponse = D1 ('MetaData "ClaimDevicesByClaimCodeResponse" "Amazonka.IoT1ClickDevices.ClaimDevicesByClaimCode" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "ClaimDevicesByClaimCodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "claimCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newClaimDevicesByClaimCodeResponse Source #

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

ClaimDevicesByClaimCode, claimDevicesByClaimCodeResponse_claimCode - The claim code provided by the device manufacturer.

$sel:total:ClaimDevicesByClaimCodeResponse', claimDevicesByClaimCodeResponse_total - The total number of devices associated with the claim code that has been processed in the claim request.

$sel:httpStatus:ClaimDevicesByClaimCodeResponse', claimDevicesByClaimCodeResponse_httpStatus - The response's http status code.

Response Lenses

claimDevicesByClaimCodeResponse_claimCode :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Text) Source #

The claim code provided by the device manufacturer.

claimDevicesByClaimCodeResponse_total :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Int) Source #

The total number of devices associated with the claim code that has been processed in the claim request.