You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AlexaForBusiness::Types::SearchNetworkProfilesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

When making an API call, you may pass SearchNetworkProfilesRequest data as a hash:

{
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

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

Returns:



4292
4293
4294
4295
4296
4297
4298
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4292

class SearchNetworkProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


4292
4293
4294
4295
4296
4297
4298
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4292

class SearchNetworkProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


4292
4293
4294
4295
4296
4297
4298
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4292

class SearchNetworkProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  include Aws::Structure
end

#sort_criteriaArray<Types::Sort>

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

Returns:



4292
4293
4294
4295
4296
4297
4298
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4292

class SearchNetworkProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  include Aws::Structure
end