AlexaForBusiness / Client / search_network_profiles

search_network_profiles#

AlexaForBusiness.Client.search_network_profiles(**kwargs)#

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

See also: AWS API Documentation

Request Syntax

response = client.search_network_profiles(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)
Parameters:

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • Filters (list) –

    The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

      • Key (string) – [REQUIRED]

        The key of a filter.

      • Values (list) – [REQUIRED]

        The values of a filter.

        • (string) –

  • SortCriteria (list) –

    The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

    • (dict) –

      An object representing a sort criteria.

      • Key (string) – [REQUIRED]

        The sort key of a sort object.

      • Value (string) – [REQUIRED]

        The sort value of a sort object.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkProfiles': [
        {
            'NetworkProfileArn': 'string',
            'NetworkProfileName': 'string',
            'Description': 'string',
            'Ssid': 'string',
            'SecurityType': 'OPEN'|'WEP'|'WPA_PSK'|'WPA2_PSK'|'WPA2_ENTERPRISE',
            'EapMethod': 'EAP_TLS',
            'CertificateAuthorityArn': 'string'
        },
    ],
    'NextToken': 'string',
    'TotalCount': 123
}

Response Structure

  • (dict) –

    • NetworkProfiles (list) –

      The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

      • (dict) –

        The data associated with a network profile.

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

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

    • NextToken (string) –

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • TotalCount (integer) –

      The total number of network profiles returned.