Class: Aws::IoTThingsGraph::Types::SearchSystemInstancesRequest

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

Overview

Note:

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

{
  filters: [
    {
      name: "SYSTEM_TEMPLATE_ID", # accepts SYSTEM_TEMPLATE_ID, STATUS, GREENGRASS_GROUP_NAME
      value: ["SystemInstanceFilterValue"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::SystemInstanceFilter>

Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Returns:



1438
1439
1440
1441
1442
1443
1444
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1438

class SearchSystemInstancesRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in the response.

Returns:

  • (Integer)


1438
1439
1440
1441
1442
1443
1444
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1438

class SearchSystemInstancesRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The string that specifies the next page of results. Use this when you're paginating results.

Returns:

  • (String)


1438
1439
1440
1441
1442
1443
1444
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1438

class SearchSystemInstancesRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end