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.Panorama.ProvisionDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Synopsis

data ProvisionDevice = ProvisionDevice' {
- description :: Maybe Text
- networkingConfiguration :: Maybe NetworkPayload
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newProvisionDevice :: Text -> ProvisionDevice
provisionDevice_description :: Lens' ProvisionDevice (Maybe Text)
provisionDevice_networkingConfiguration :: Lens' ProvisionDevice (Maybe NetworkPayload)
provisionDevice_tags :: Lens' ProvisionDevice (Maybe (HashMap Text Text))
provisionDevice_name :: Lens' ProvisionDevice Text
data ProvisionDeviceResponse = ProvisionDeviceResponse' {
- certificates :: Maybe Base64
- deviceId :: Maybe Text
- iotThingName :: Maybe Text
- httpStatus :: Int
- arn :: Text
- status :: DeviceStatus
}
newProvisionDeviceResponse :: Int -> Text -> DeviceStatus -> ProvisionDeviceResponse
provisionDeviceResponse_certificates :: Lens' ProvisionDeviceResponse (Maybe ByteString)
provisionDeviceResponse_deviceId :: Lens' ProvisionDeviceResponse (Maybe Text)
provisionDeviceResponse_iotThingName :: Lens' ProvisionDeviceResponse (Maybe Text)
provisionDeviceResponse_httpStatus :: Lens' ProvisionDeviceResponse Int
provisionDeviceResponse_arn :: Lens' ProvisionDeviceResponse Text
provisionDeviceResponse_status :: Lens' ProvisionDeviceResponse DeviceStatus

Creating a Request

data ProvisionDevice Source #

See: newProvisionDevice smart constructor.

Constructors

ProvisionDevice'
Fields description :: Maybe Text A description for the device. networkingConfiguration :: Maybe NetworkPayload A networking configuration for the device. tags :: Maybe (HashMap Text Text) Tags for the device. name :: Text A name for the device.

Instances

Instances details

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

newProvisionDevice Source #

Arguments

:: Text	`ProvisionDevice`
-> ProvisionDevice

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

ProvisionDevice, provisionDevice_description - A description for the device.

$sel:networkingConfiguration:ProvisionDevice', provisionDevice_networkingConfiguration - A networking configuration for the device.

ProvisionDevice, provisionDevice_tags - Tags for the device.

ProvisionDevice, provisionDevice_name - A name for the device.

Request Lenses

provisionDevice_description :: Lens' ProvisionDevice (Maybe Text) Source #

A description for the device.

provisionDevice_networkingConfiguration :: Lens' ProvisionDevice (Maybe NetworkPayload) Source #

A networking configuration for the device.

provisionDevice_tags :: Lens' ProvisionDevice (Maybe (HashMap Text Text)) Source #

Tags for the device.

provisionDevice_name :: Lens' ProvisionDevice Text Source #

A name for the device.

Destructuring the Response

data ProvisionDeviceResponse Source #

See: newProvisionDeviceResponse smart constructor.

Constructors

ProvisionDeviceResponse'
Fields certificates :: Maybe Base64 The device's configuration bundle. deviceId :: Maybe Text The device's ID. iotThingName :: Maybe Text The device's IoT thing name. httpStatus :: Int The response's http status code. arn :: Text The device's ARN. status :: DeviceStatus The device's status.

Instances

Instances details

Generic ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice Associated Types type Rep ProvisionDeviceResponse :: Type -> Type # Methods from :: ProvisionDeviceResponse -> Rep ProvisionDeviceResponse x # to :: Rep ProvisionDeviceResponse x -> ProvisionDeviceResponse #
Read ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice Methods readsPrec :: Int -> ReadS ProvisionDeviceResponse # readList :: ReadS [ProvisionDeviceResponse] # readPrec :: ReadPrec ProvisionDeviceResponse # readListPrec :: ReadPrec [ProvisionDeviceResponse] #
Show ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice Methods showsPrec :: Int -> ProvisionDeviceResponse -> ShowS # show :: ProvisionDeviceResponse -> String # showList :: [ProvisionDeviceResponse] -> ShowS #
NFData ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice Methods rnf :: ProvisionDeviceResponse -> () #
Eq ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice Methods (==) :: ProvisionDeviceResponse -> ProvisionDeviceResponse -> Bool # (/=) :: ProvisionDeviceResponse -> ProvisionDeviceResponse -> Bool #
type Rep ProvisionDeviceResponse Source #
Instance details Defined in Amazonka.Panorama.ProvisionDevice type Rep ProvisionDeviceResponse = D1 ('MetaData "ProvisionDeviceResponse" "Amazonka.Panorama.ProvisionDevice" "amazonka-panorama-2.0-9Y2Sxd8ToqsBjPczgPI6n1" 'False) (C1 ('MetaCons "ProvisionDeviceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :: (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iotThingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceStatus)))))

newProvisionDeviceResponse Source #

Arguments

:: Int	`$sel:httpStatus:ProvisionDeviceResponse'`
-> Text	`ProvisionDeviceResponse`
-> DeviceStatus	`ProvisionDeviceResponse`
-> ProvisionDeviceResponse

Create a value of ProvisionDeviceResponse 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:certificates:ProvisionDeviceResponse', provisionDeviceResponse_certificates - The device's configuration bundle.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

ProvisionDeviceResponse, provisionDeviceResponse_deviceId - The device's ID.

$sel:iotThingName:ProvisionDeviceResponse', provisionDeviceResponse_iotThingName - The device's IoT thing name.

$sel:httpStatus:ProvisionDeviceResponse', provisionDeviceResponse_httpStatus - The response's http status code.

ProvisionDeviceResponse, provisionDeviceResponse_arn - The device's ARN.

ProvisionDeviceResponse, provisionDeviceResponse_status - The device's status.

Response Lenses

provisionDeviceResponse_certificates :: Lens' ProvisionDeviceResponse (Maybe ByteString) Source #

The device's configuration bundle.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

provisionDeviceResponse_deviceId :: Lens' ProvisionDeviceResponse (Maybe Text) Source #

The device's ID.

provisionDeviceResponse_iotThingName :: Lens' ProvisionDeviceResponse (Maybe Text) Source #

The device's IoT thing name.

provisionDeviceResponse_httpStatus :: Lens' ProvisionDeviceResponse Int Source #

The response's http status code.

provisionDeviceResponse_arn :: Lens' ProvisionDeviceResponse Text Source #

The device's ARN.

provisionDeviceResponse_status :: Lens' ProvisionDeviceResponse DeviceStatus Source #

The device's status.