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.NetworkManager.UpdateDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

Synopsis

data UpdateDevice = UpdateDevice' {
- aWSLocation :: Maybe AWSLocation
- description :: Maybe Text
- location :: Maybe (Sensitive Location)
- model :: Maybe Text
- serialNumber :: Maybe Text
- siteId :: Maybe Text
- type' :: Maybe Text
- vendor :: Maybe Text
- globalNetworkId :: Text
- deviceId :: Text
}
newUpdateDevice :: Text -> Text -> UpdateDevice
updateDevice_aWSLocation :: Lens' UpdateDevice (Maybe AWSLocation)
updateDevice_description :: Lens' UpdateDevice (Maybe Text)
updateDevice_location :: Lens' UpdateDevice (Maybe Location)
updateDevice_model :: Lens' UpdateDevice (Maybe Text)
updateDevice_serialNumber :: Lens' UpdateDevice (Maybe Text)
updateDevice_siteId :: Lens' UpdateDevice (Maybe Text)
updateDevice_type :: Lens' UpdateDevice (Maybe Text)
updateDevice_vendor :: Lens' UpdateDevice (Maybe Text)
updateDevice_globalNetworkId :: Lens' UpdateDevice Text
updateDevice_deviceId :: Lens' UpdateDevice Text
data UpdateDeviceResponse = UpdateDeviceResponse' {
- device :: Maybe Device
- httpStatus :: Int
}
newUpdateDeviceResponse :: Int -> UpdateDeviceResponse
updateDeviceResponse_device :: Lens' UpdateDeviceResponse (Maybe Device)
updateDeviceResponse_httpStatus :: Lens' UpdateDeviceResponse Int

Creating a Request

data UpdateDevice Source #

See: newUpdateDevice smart constructor.

Constructors

UpdateDevice'

Fields

aWSLocation :: Maybe AWSLocation
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
description :: Maybe Text
A description of the device.
Constraints: Maximum length of 256 characters.
location :: Maybe (Sensitive Location)
model :: Maybe Text
The model of the device.
Constraints: Maximum length of 128 characters.
serialNumber :: Maybe Text
The serial number of the device.
Constraints: Maximum length of 128 characters.
siteId :: Maybe Text
The ID of the site.
type' :: Maybe Text
The type of the device.
vendor :: Maybe Text
The vendor of the device.
Constraints: Maximum length of 128 characters.
globalNetworkId :: Text
The ID of the global network.
deviceId :: Text
The ID of the device.

Instances

Instances details

ToJSON UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods toJSON :: UpdateDevice -> Value # toEncoding :: UpdateDevice -> Encoding # toJSONList :: [UpdateDevice] -> Value # toEncodingList :: [UpdateDevice] -> Encoding #
ToHeaders UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods toHeaders :: UpdateDevice -> [Header] #
ToPath UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods toPath :: UpdateDevice -> ByteString #
ToQuery UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods toQuery :: UpdateDevice -> QueryString #
AWSRequest UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Associated Types type AWSResponse UpdateDevice # Methods request :: (Service -> Service) -> UpdateDevice -> Request UpdateDevice # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDevice))) #
Generic UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Associated Types type Rep UpdateDevice :: Type -> Type # Methods from :: UpdateDevice -> Rep UpdateDevice x # to :: Rep UpdateDevice x -> UpdateDevice #
Show UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods showsPrec :: Int -> UpdateDevice -> ShowS # show :: UpdateDevice -> String # showList :: [UpdateDevice] -> ShowS #
NFData UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods rnf :: UpdateDevice -> () #
Eq UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods (==) :: UpdateDevice -> UpdateDevice -> Bool # (/=) :: UpdateDevice -> UpdateDevice -> Bool #
Hashable UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods hashWithSalt :: Int -> UpdateDevice -> Int # hash :: UpdateDevice -> Int #
type AWSResponse UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice type AWSResponse UpdateDevice = UpdateDeviceResponse
type Rep UpdateDevice Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice type Rep UpdateDevice = D1 ('MetaData "UpdateDevice" "Amazonka.NetworkManager.UpdateDevice" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "UpdateDevice'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aWSLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AWSLocation)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Location))) :: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "siteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vendor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateDevice Source #

Arguments

:: Text	`UpdateDevice`
-> Text	`UpdateDevice`
-> UpdateDevice

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

UpdateDevice, updateDevice_aWSLocation - The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

UpdateDevice, updateDevice_description - A description of the device.

Constraints: Maximum length of 256 characters.

UpdateDevice, updateDevice_location - Undocumented member.

UpdateDevice, updateDevice_model - The model of the device.

Constraints: Maximum length of 128 characters.

UpdateDevice, updateDevice_serialNumber - The serial number of the device.

Constraints: Maximum length of 128 characters.

UpdateDevice, updateDevice_siteId - The ID of the site.

UpdateDevice, updateDevice_type - The type of the device.

UpdateDevice, updateDevice_vendor - The vendor of the device.

Constraints: Maximum length of 128 characters.

UpdateDevice, updateDevice_globalNetworkId - The ID of the global network.

UpdateDevice, updateDevice_deviceId - The ID of the device.

Request Lenses

updateDevice_aWSLocation :: Lens' UpdateDevice (Maybe AWSLocation) Source #

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

updateDevice_description :: Lens' UpdateDevice (Maybe Text) Source #

A description of the device.

Constraints: Maximum length of 256 characters.

updateDevice_location :: Lens' UpdateDevice (Maybe Location) Source #

Undocumented member.

updateDevice_model :: Lens' UpdateDevice (Maybe Text) Source #

The model of the device.

Constraints: Maximum length of 128 characters.

updateDevice_serialNumber :: Lens' UpdateDevice (Maybe Text) Source #

The serial number of the device.

Constraints: Maximum length of 128 characters.

updateDevice_siteId :: Lens' UpdateDevice (Maybe Text) Source #

The ID of the site.

updateDevice_type :: Lens' UpdateDevice (Maybe Text) Source #

The type of the device.

updateDevice_vendor :: Lens' UpdateDevice (Maybe Text) Source #

The vendor of the device.

Constraints: Maximum length of 128 characters.

updateDevice_globalNetworkId :: Lens' UpdateDevice Text Source #

The ID of the global network.

updateDevice_deviceId :: Lens' UpdateDevice Text Source #

The ID of the device.

Destructuring the Response

data UpdateDeviceResponse Source #

See: newUpdateDeviceResponse smart constructor.

Constructors

UpdateDeviceResponse'
Fields device :: Maybe Device Information about the device. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDeviceResponse Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Associated Types type Rep UpdateDeviceResponse :: Type -> Type # Methods from :: UpdateDeviceResponse -> Rep UpdateDeviceResponse x # to :: Rep UpdateDeviceResponse x -> UpdateDeviceResponse #
Show UpdateDeviceResponse Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods showsPrec :: Int -> UpdateDeviceResponse -> ShowS # show :: UpdateDeviceResponse -> String # showList :: [UpdateDeviceResponse] -> ShowS #
NFData UpdateDeviceResponse Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods rnf :: UpdateDeviceResponse -> () #
Eq UpdateDeviceResponse Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice Methods (==) :: UpdateDeviceResponse -> UpdateDeviceResponse -> Bool # (/=) :: UpdateDeviceResponse -> UpdateDeviceResponse -> Bool #
type Rep UpdateDeviceResponse Source #
Instance details Defined in Amazonka.NetworkManager.UpdateDevice type Rep UpdateDeviceResponse = D1 ('MetaData "UpdateDeviceResponse" "Amazonka.NetworkManager.UpdateDevice" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "UpdateDeviceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Device)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDeviceResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDeviceResponse'`
-> UpdateDeviceResponse

Create a value of UpdateDeviceResponse 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:device:UpdateDeviceResponse', updateDeviceResponse_device - Information about the device.

$sel:httpStatus:UpdateDeviceResponse', updateDeviceResponse_httpStatus - The response's http status code.

Response Lenses

updateDeviceResponse_device :: Lens' UpdateDeviceResponse (Maybe Device) Source #

Information about the device.

updateDeviceResponse_httpStatus :: Lens' UpdateDeviceResponse Int Source #

The response's http status code.