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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Synopsis

data CreateDevice = CreateDevice' {
- aWSLocation :: Maybe AWSLocation
- description :: Maybe Text
- location :: Maybe (Sensitive Location)
- model :: Maybe Text
- serialNumber :: Maybe Text
- siteId :: Maybe Text
- tags :: Maybe [Tag]
- type' :: Maybe Text
- vendor :: Maybe Text
- globalNetworkId :: Text
}
newCreateDevice :: Text -> CreateDevice
createDevice_aWSLocation :: Lens' CreateDevice (Maybe AWSLocation)
createDevice_description :: Lens' CreateDevice (Maybe Text)
createDevice_location :: Lens' CreateDevice (Maybe Location)
createDevice_model :: Lens' CreateDevice (Maybe Text)
createDevice_serialNumber :: Lens' CreateDevice (Maybe Text)
createDevice_siteId :: Lens' CreateDevice (Maybe Text)
createDevice_tags :: Lens' CreateDevice (Maybe [Tag])
createDevice_type :: Lens' CreateDevice (Maybe Text)
createDevice_vendor :: Lens' CreateDevice (Maybe Text)
createDevice_globalNetworkId :: Lens' CreateDevice Text
data CreateDeviceResponse = CreateDeviceResponse' {
- device :: Maybe Device
- httpStatus :: Int
}
newCreateDeviceResponse :: Int -> CreateDeviceResponse
createDeviceResponse_device :: Lens' CreateDeviceResponse (Maybe Device)
createDeviceResponse_httpStatus :: Lens' CreateDeviceResponse Int

Creating a Request

data CreateDevice Source #

See: newCreateDevice smart constructor.

Constructors

CreateDevice'

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)
The location of the device.
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.
tags :: Maybe [Tag]
The tags to apply to the resource during creation.
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.

Instances

Instances details

ToJSON CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods toJSON :: CreateDevice -> Value # toEncoding :: CreateDevice -> Encoding # toJSONList :: [CreateDevice] -> Value # toEncodingList :: [CreateDevice] -> Encoding #
ToHeaders CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods toHeaders :: CreateDevice -> [Header] #
ToPath CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods toPath :: CreateDevice -> ByteString #
ToQuery CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods toQuery :: CreateDevice -> QueryString #
AWSRequest CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Associated Types type AWSResponse CreateDevice # Methods request :: (Service -> Service) -> CreateDevice -> Request CreateDevice # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDevice))) #
Generic CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Associated Types type Rep CreateDevice :: Type -> Type # Methods from :: CreateDevice -> Rep CreateDevice x # to :: Rep CreateDevice x -> CreateDevice #
Show CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods showsPrec :: Int -> CreateDevice -> ShowS # show :: CreateDevice -> String # showList :: [CreateDevice] -> ShowS #
NFData CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods rnf :: CreateDevice -> () #
Eq CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods (==) :: CreateDevice -> CreateDevice -> Bool # (/=) :: CreateDevice -> CreateDevice -> Bool #
Hashable CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice Methods hashWithSalt :: Int -> CreateDevice -> Int # hash :: CreateDevice -> Int #
type AWSResponse CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice type AWSResponse CreateDevice = CreateDeviceResponse
type Rep CreateDevice Source #
Instance details Defined in Amazonka.NetworkManager.CreateDevice type Rep CreateDevice = D1 ('MetaData "CreateDevice" "Amazonka.NetworkManager.CreateDevice" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "CreateDevice'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (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))))))

newCreateDevice Source #

Arguments

:: Text	`CreateDevice`
-> CreateDevice

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

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

CreateDevice, createDevice_description - A description of the device.

Constraints: Maximum length of 256 characters.

CreateDevice, createDevice_location - The location of the device.

CreateDevice, createDevice_model - The model of the device.

Constraints: Maximum length of 128 characters.

CreateDevice, createDevice_serialNumber - The serial number of the device.

Constraints: Maximum length of 128 characters.

CreateDevice, createDevice_siteId - The ID of the site.

CreateDevice, createDevice_tags - The tags to apply to the resource during creation.

CreateDevice, createDevice_type - The type of the device.

CreateDevice, createDevice_vendor - The vendor of the device.

Constraints: Maximum length of 128 characters.

CreateDevice, createDevice_globalNetworkId - The ID of the global network.

Request Lenses

createDevice_aWSLocation :: Lens' CreateDevice (Maybe AWSLocation) Source #

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

createDevice_description :: Lens' CreateDevice (Maybe Text) Source #

A description of the device.

Constraints: Maximum length of 256 characters.

createDevice_location :: Lens' CreateDevice (Maybe Location) Source #

The location of the device.

createDevice_model :: Lens' CreateDevice (Maybe Text) Source #

The model of the device.

Constraints: Maximum length of 128 characters.

createDevice_serialNumber :: Lens' CreateDevice (Maybe Text) Source #

The serial number of the device.

Constraints: Maximum length of 128 characters.

createDevice_siteId :: Lens' CreateDevice (Maybe Text) Source #

The ID of the site.

createDevice_tags :: Lens' CreateDevice (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

createDevice_type :: Lens' CreateDevice (Maybe Text) Source #

The type of the device.

createDevice_vendor :: Lens' CreateDevice (Maybe Text) Source #

The vendor of the device.

Constraints: Maximum length of 128 characters.

createDevice_globalNetworkId :: Lens' CreateDevice Text Source #

The ID of the global network.

Destructuring the Response

data CreateDeviceResponse Source #

See: newCreateDeviceResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateDeviceResponse Source #

Arguments

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

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

$sel:httpStatus:CreateDeviceResponse', createDeviceResponse_httpStatus - The response's http status code.

Response Lenses

createDeviceResponse_device :: Lens' CreateDeviceResponse (Maybe Device) Source #

Information about the device.

createDeviceResponse_httpStatus :: Lens' CreateDeviceResponse Int Source #

The response's http status code.