search-network-profiles¶

Description¶

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

Synopsis¶

  search-network-profiles
[--next-token <value>]
[--max-results <value>]
[--filters <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--next-token (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.

--max-results (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.

(structure)

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)

The key of a filter.

Values -> (list)

The values of a filter.

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--sort-criteria (list)

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

(structure)

An object representing a sort criteria.

Key -> (string)

The sort key of a sort object.

Value -> (string)

The sort value of a sort object.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "ASC"|"DESC"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To search network profiles

The following search-network-profiles example lists network profiles that meet a set of filter and sort criteria. In this example, all profiles are listed.

aws alexaforbusiness search-network-profiles

Output:

{
    "NetworkProfiles": [
        {
            "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789111:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "NetworkProfileName": "Networkprofile1",
            "Description": "Personal network",
            "Ssid": "Janenetwork",
            "SecurityType": "WPA2_PSK"
        },
        {
            "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789222:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
            "NetworkProfileName": "Networkprofile2",
            "Ssid": "Johnnetwork",
            "SecurityType": "WPA2_PSK"
        },
        {
            "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789333:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE66666/a1b2c3d4-5678-90ab-cdef-EXAMPLE77777",
            "NetworkProfileName": "Networkprofile3",
            "Ssid": "Carlosnetwork",
            "SecurityType": "WPA2_PSK"
        }
    ],
    "TotalCount": 3
}

For more information, see Managing Network Profiles in the Alexa for Business Administration Guide.

Output¶

NetworkProfiles -> (list)

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

(structure)

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.

Table of Contents

Feedback

User Guide