AlexaForBusiness / Client / get_network_profile

get_network_profile#

AlexaForBusiness.Client.get_network_profile(**kwargs)#

Gets the network profile details by the network profile ARN.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_network_profile(
    NetworkProfileArn='string'
)
Parameters:

NetworkProfileArn (string) –

[REQUIRED]

The ARN of the network profile associated with a device.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkProfile': {
        'NetworkProfileArn': 'string',
        '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',
        ]
    }
}

Response Structure

  • (dict) –

    • NetworkProfile (dict) –

      The network profile associated with a device.

      • NetworkProfileArn (string) –

        The ARN of the network profile associated with a device.

      • NetworkProfileName (string) –

        The name of the network profile associated with a device.

      • Description (string) –

        Detailed information about a device’s network profile.

      • Ssid (string) –

        The SSID of the Wi-Fi network.

      • SecurityType (string) –

        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, which is installed on your devices and used to trust your authentication server during EAP negotiation.

        • (string) –

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException

  • AlexaForBusiness.Client.exceptions.InvalidSecretsManagerResourceException