Class: Aws::AlexaForBusiness::Types::SearchNetworkProfilesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchNetworkProfilesRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
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
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of network profiles.
-
#max_results ⇒ Integer
The maximum number of results to include in the response.
-
#next_token ⇒ String
An optional token returned from a prior request.
-
#sort_criteria ⇒ Array<Types::Sort>
The sort order to use to list the specified set of network profiles.
Instance Attribute Details
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
4873 4874 4875 4876 4877 4878 4879 4880 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4873 class SearchNetworkProfilesRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#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.
4873 4874 4875 4876 4877 4878 4879 4880 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4873 class SearchNetworkProfilesRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#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.
4873 4874 4875 4876 4877 4878 4879 4880 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4873 class SearchNetworkProfilesRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#sort_criteria ⇒ Array<Types::Sort>
The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
4873 4874 4875 4876 4877 4878 4879 4880 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4873 class SearchNetworkProfilesRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |