AlexaForBusiness / Client / create_network_profile

create_network_profile#

AlexaForBusiness.Client.create_network_profile(**kwargs)#

Creates a network profile with the specified details.

See also: AWS API Documentation

Request Syntax

response = client.create_network_profile(
    NetworkProfileName='string',
    Description='string',
    Ssid='string',
    SecurityType='OPEN'|'WEP'|'WPA_PSK'|'WPA2_PSK'|'WPA2_ENTERPRISE',
    EapMethod='EAP_TLS',
    CurrentPassword='string',
    NextPassword='string',
    CertificateAuthorityArn='string',
    TrustAnchors=[
        'string',
    ],
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • NetworkProfileName (string) –

    [REQUIRED]

    The name of the network profile associated with a device.

  • Description (string) – Detailed information about a device’s network profile.

  • Ssid (string) –

    [REQUIRED]

    The SSID of the Wi-Fi network.

  • SecurityType (string) –

    [REQUIRED]

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

  • EapMethod (string) – The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

  • CurrentPassword (string) – The current password of the Wi-Fi network.

  • NextPassword (string) – 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.

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

  • TrustAnchors (list) –

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

    • (string) –

  • ClientRequestToken (string) –

    [REQUIRED]

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

    This field is autopopulated if not provided.

  • Tags (list) –

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

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkProfileArn': 'string'
}

Response Structure

  • (dict) –

    • NetworkProfileArn (string) –

      The ARN of the network profile associated with a device.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException

  • AlexaForBusiness.Client.exceptions.LimitExceededException

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException

  • AlexaForBusiness.Client.exceptions.InvalidCertificateAuthorityException

  • AlexaForBusiness.Client.exceptions.InvalidServiceLinkedRoleStateException