Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AlexaBusiness.CreateNetworkProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a network profile with the specified details.

Synopsis

data CreateNetworkProfile = CreateNetworkProfile' {
- currentPassword :: Maybe (Sensitive Text)
- nextPassword :: Maybe (Sensitive Text)
- eapMethod :: Maybe NetworkEapMethod
- description :: Maybe Text
- trustAnchors :: Maybe (NonEmpty Text)
- certificateAuthorityArn :: Maybe Text
- tags :: Maybe [Tag]
- networkProfileName :: Text
- ssid :: Text
- securityType :: NetworkSecurityType
- clientRequestToken :: Text
}
newCreateNetworkProfile :: Text -> Text -> NetworkSecurityType -> Text -> CreateNetworkProfile
createNetworkProfile_currentPassword :: Lens' CreateNetworkProfile (Maybe Text)
createNetworkProfile_nextPassword :: Lens' CreateNetworkProfile (Maybe Text)
createNetworkProfile_eapMethod :: Lens' CreateNetworkProfile (Maybe NetworkEapMethod)
createNetworkProfile_description :: Lens' CreateNetworkProfile (Maybe Text)
createNetworkProfile_trustAnchors :: Lens' CreateNetworkProfile (Maybe (NonEmpty Text))
createNetworkProfile_certificateAuthorityArn :: Lens' CreateNetworkProfile (Maybe Text)
createNetworkProfile_tags :: Lens' CreateNetworkProfile (Maybe [Tag])
createNetworkProfile_networkProfileName :: Lens' CreateNetworkProfile Text
createNetworkProfile_ssid :: Lens' CreateNetworkProfile Text
createNetworkProfile_securityType :: Lens' CreateNetworkProfile NetworkSecurityType
createNetworkProfile_clientRequestToken :: Lens' CreateNetworkProfile Text
data CreateNetworkProfileResponse = CreateNetworkProfileResponse' {
- networkProfileArn :: Maybe Text
- httpStatus :: Int
}
newCreateNetworkProfileResponse :: Int -> CreateNetworkProfileResponse
createNetworkProfileResponse_networkProfileArn :: Lens' CreateNetworkProfileResponse (Maybe Text)
createNetworkProfileResponse_httpStatus :: Lens' CreateNetworkProfileResponse Int

Creating a Request

data CreateNetworkProfile Source #

See: newCreateNetworkProfile smart constructor.

Constructors

CreateNetworkProfile'

Fields

currentPassword :: Maybe (Sensitive Text)
The current password of the Wi-Fi network.
nextPassword :: Maybe (Sensitive Text)
The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
eapMethod :: Maybe NetworkEapMethod
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
description :: Maybe Text
Detailed information about a device's network profile.
trustAnchors :: Maybe (NonEmpty Text)
The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
certificateAuthorityArn :: Maybe Text
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
tags :: Maybe [Tag]
The tags to be added to the specified resource. Do not provide system tags.
networkProfileName :: Text
The name of the network profile associated with a device.
ssid :: Text
The SSID of the Wi-Fi network.
securityType :: NetworkSecurityType
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
clientRequestToken :: Text

Instances

Instances details

Eq CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods (==) :: CreateNetworkProfile -> CreateNetworkProfile -> Bool # (/=) :: CreateNetworkProfile -> CreateNetworkProfile -> Bool #
Show CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods showsPrec :: Int -> CreateNetworkProfile -> ShowS # show :: CreateNetworkProfile -> String # showList :: [CreateNetworkProfile] -> ShowS #
Generic CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Associated Types type Rep CreateNetworkProfile :: Type -> Type # Methods from :: CreateNetworkProfile -> Rep CreateNetworkProfile x # to :: Rep CreateNetworkProfile x -> CreateNetworkProfile #
NFData CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods rnf :: CreateNetworkProfile -> () #
Hashable CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods hashWithSalt :: Int -> CreateNetworkProfile -> Int # hash :: CreateNetworkProfile -> Int #
ToJSON CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods toJSON :: CreateNetworkProfile -> Value # toEncoding :: CreateNetworkProfile -> Encoding # toJSONList :: [CreateNetworkProfile] -> Value # toEncodingList :: [CreateNetworkProfile] -> Encoding #
AWSRequest CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Associated Types type AWSResponse CreateNetworkProfile # Methods request :: CreateNetworkProfile -> Request CreateNetworkProfile # response :: MonadResource m => Logger -> Service -> Proxy CreateNetworkProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateNetworkProfile))) #
ToHeaders CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods toHeaders :: CreateNetworkProfile -> [Header] #
ToPath CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods toPath :: CreateNetworkProfile -> ByteString #
ToQuery CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods toQuery :: CreateNetworkProfile -> QueryString #
type Rep CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile type Rep CreateNetworkProfile = D1 ('MetaData "CreateNetworkProfile" "Amazonka.AlexaBusiness.CreateNetworkProfile" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "CreateNetworkProfile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "currentPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "nextPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "eapMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkEapMethod)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "trustAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))) :: ((S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "networkProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "ssid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "securityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NetworkSecurityType) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateNetworkProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile type AWSResponse CreateNetworkProfile = CreateNetworkProfileResponse

newCreateNetworkProfile Source #

Arguments

:: Text	`$sel:networkProfileName:CreateNetworkProfile'`
-> Text	`$sel:ssid:CreateNetworkProfile'`
-> NetworkSecurityType	`$sel:securityType:CreateNetworkProfile'`
-> Text	`$sel:clientRequestToken:CreateNetworkProfile'`
-> CreateNetworkProfile

Create a value of CreateNetworkProfile 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:currentPassword:CreateNetworkProfile', createNetworkProfile_currentPassword - The current password of the Wi-Fi network.

$sel:nextPassword:CreateNetworkProfile', createNetworkProfile_nextPassword - The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

$sel:eapMethod:CreateNetworkProfile', createNetworkProfile_eapMethod - The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

$sel:description:CreateNetworkProfile', createNetworkProfile_description - Detailed information about a device's network profile.

$sel:trustAnchors:CreateNetworkProfile', createNetworkProfile_trustAnchors - The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

$sel:certificateAuthorityArn:CreateNetworkProfile', createNetworkProfile_certificateAuthorityArn - The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

$sel:tags:CreateNetworkProfile', createNetworkProfile_tags - The tags to be added to the specified resource. Do not provide system tags.

$sel:networkProfileName:CreateNetworkProfile', createNetworkProfile_networkProfileName - The name of the network profile associated with a device.

$sel:ssid:CreateNetworkProfile', createNetworkProfile_ssid - The SSID of the Wi-Fi network.

$sel:securityType:CreateNetworkProfile', createNetworkProfile_securityType - The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

$sel:clientRequestToken:CreateNetworkProfile', createNetworkProfile_clientRequestToken - Undocumented member.

Request Lenses

createNetworkProfile_currentPassword :: Lens' CreateNetworkProfile (Maybe Text) Source #

The current password of the Wi-Fi network.

createNetworkProfile_nextPassword :: Lens' CreateNetworkProfile (Maybe Text) Source #

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

createNetworkProfile_eapMethod :: Lens' CreateNetworkProfile (Maybe NetworkEapMethod) Source #

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

createNetworkProfile_description :: Lens' CreateNetworkProfile (Maybe Text) Source #

Detailed information about a device's network profile.

createNetworkProfile_trustAnchors :: Lens' CreateNetworkProfile (Maybe (NonEmpty Text)) Source #

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

createNetworkProfile_certificateAuthorityArn :: Lens' CreateNetworkProfile (Maybe Text) Source #

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

createNetworkProfile_tags :: Lens' CreateNetworkProfile (Maybe [Tag]) Source #

The tags to be added to the specified resource. Do not provide system tags.

createNetworkProfile_networkProfileName :: Lens' CreateNetworkProfile Text Source #

The name of the network profile associated with a device.

createNetworkProfile_ssid :: Lens' CreateNetworkProfile Text Source #

The SSID of the Wi-Fi network.

createNetworkProfile_securityType :: Lens' CreateNetworkProfile NetworkSecurityType Source #

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

createNetworkProfile_clientRequestToken :: Lens' CreateNetworkProfile Text Source #

Undocumented member.

Destructuring the Response

data CreateNetworkProfileResponse Source #

See: newCreateNetworkProfileResponse smart constructor.

Constructors

CreateNetworkProfileResponse'
Fields networkProfileArn :: Maybe Text The ARN of the network profile associated with a device. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods (==) :: CreateNetworkProfileResponse -> CreateNetworkProfileResponse -> Bool # (/=) :: CreateNetworkProfileResponse -> CreateNetworkProfileResponse -> Bool #
Read CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods readsPrec :: Int -> ReadS CreateNetworkProfileResponse # readList :: ReadS [CreateNetworkProfileResponse] # readPrec :: ReadPrec CreateNetworkProfileResponse # readListPrec :: ReadPrec [CreateNetworkProfileResponse] #
Show CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods showsPrec :: Int -> CreateNetworkProfileResponse -> ShowS # show :: CreateNetworkProfileResponse -> String # showList :: [CreateNetworkProfileResponse] -> ShowS #
Generic CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Associated Types type Rep CreateNetworkProfileResponse :: Type -> Type # Methods from :: CreateNetworkProfileResponse -> Rep CreateNetworkProfileResponse x # to :: Rep CreateNetworkProfileResponse x -> CreateNetworkProfileResponse #
NFData CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile Methods rnf :: CreateNetworkProfileResponse -> () #
type Rep CreateNetworkProfileResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateNetworkProfile type Rep CreateNetworkProfileResponse = D1 ('MetaData "CreateNetworkProfileResponse" "Amazonka.AlexaBusiness.CreateNetworkProfile" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "CreateNetworkProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "networkProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateNetworkProfileResponse Source #

Arguments

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

Create a value of CreateNetworkProfileResponse 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:networkProfileArn:CreateNetworkProfileResponse', createNetworkProfileResponse_networkProfileArn - The ARN of the network profile associated with a device.

$sel:httpStatus:CreateNetworkProfileResponse', createNetworkProfileResponse_httpStatus - The response's http status code.

Response Lenses

createNetworkProfileResponse_networkProfileArn :: Lens' CreateNetworkProfileResponse (Maybe Text) Source #

The ARN of the network profile associated with a device.

createNetworkProfileResponse_httpStatus :: Lens' CreateNetworkProfileResponse Int Source #

The response's http status code.