Alexa For Business
Alexa for Business API (API Version 2017-11-09)

CreateNetworkProfile

Creates a network profile with the specified details.

Request Syntax

{ "CertificateAuthorityArn": "string", "ClientRequestToken": "string", "CurrentPassword": "string", "Description": "string", "EapMethod": "string", "NetworkProfileName": "string", "NextPassword": "string", "SecurityType": "string", "Ssid": "string", "TrustAnchors": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CertificateAuthorityArn

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

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

ClientRequestToken

A unique, user-specified identifier for the request that ensures idempotency.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

CurrentPassword

The current password of the Wi-Fi network.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 128.

Pattern: [\x00-\x7F]*

Required: No

Description

Detailed information about a device's network profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

EapMethod

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

Type: String

Valid Values: EAP_TLS

Required: No

NetworkProfileName

The name of the network profile associated with a device.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: (^$)|([\x00-\x7F]{5,})

Required: No

SecurityType

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

Type: String

Valid Values: OPEN | WEP | WPA_PSK | WPA2_PSK | WPA2_ENTERPRISE

Required: Yes

Ssid

The SSID of the Wi-Fi network.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: Yes

TrustAnchors

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Pattern: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A)?

Required: No

Response Syntax

{ "NetworkProfileArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NetworkProfileArn

The ARN of the network profile associated with a device.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Errors

For information about the errors that are common to all actions, see Common Errors.

AlreadyExistsException

The resource being created already exists.

HTTP Status Code: 400

ConcurrentModificationException

There is a concurrent modification of resources.

HTTP Status Code: 400

InvalidCertificateAuthorityException

The Certificate Authority can't issue or revoke a certificate.

HTTP Status Code: 400

InvalidServiceLinkedRoleStateException

The service linked role is locked for deletion.

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: