Class: Aws::IoT::Types::GetBucketsAggregationRequest

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

Overview

Note:

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

{
  index_name: "IndexName",
  query_string: "QueryString", # required
  aggregation_field: "AggregationField", # required
  query_version: "QueryVersion",
  buckets_aggregation_type: { # required
    terms_aggregation: {
      max_buckets: 1,
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_fieldString

The aggregation field.

Returns:

  • (String)


9035
9036
9037
9038
9039
9040
9041
9042
9043
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9035

class GetBucketsAggregationRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version,
  :buckets_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#buckets_aggregation_typeTypes::BucketsAggregationType

The basic control of the response shape and the bucket aggregation type to perform.



9035
9036
9037
9038
9039
9040
9041
9042
9043
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9035

class GetBucketsAggregationRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version,
  :buckets_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#index_nameString

The name of the index to search.

Returns:

  • (String)


9035
9036
9037
9038
9039
9040
9041
9042
9043
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9035

class GetBucketsAggregationRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version,
  :buckets_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The search query string.

Returns:

  • (String)


9035
9036
9037
9038
9039
9040
9041
9042
9043
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9035

class GetBucketsAggregationRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version,
  :buckets_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#query_versionString

The version of the query.

Returns:

  • (String)


9035
9036
9037
9038
9039
9040
9041
9042
9043
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9035

class GetBucketsAggregationRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version,
  :buckets_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end