Class: Aws::SSM::Types::GetOpsSummaryRequest

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

Overview

Note:

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

{
  sync_name: "ResourceDataSyncName",
  filters: [
    {
      key: "OpsFilterKey", # required
      values: ["OpsFilterValue"], # required
      type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
    },
  ],
  aggregators: [
    {
      aggregator_type: "OpsAggregatorType",
      type_name: "OpsDataTypeName",
      attribute_name: "OpsDataAttributeName",
      values: {
        "OpsAggregatorValueKey" => "OpsAggregatorValue",
      },
      filters: [
        {
          key: "OpsFilterKey", # required
          values: ["OpsFilterValue"], # required
          type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
        },
      ],
      aggregators: {
        # recursive OpsAggregatorList
      },
    },
  ],
  result_attributes: [
    {
      type_name: "OpsDataTypeName", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregatorsArray<Types::OpsAggregator>

Optional aggregators that return counts of OpsItems based on one or more expressions.

Returns:



8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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

#filtersArray<Types::OpsFilter>

Optional filters used to scope down the returned OpsItems.

Returns:



8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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

#max_resultsInteger

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

  • (Integer)


8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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

#next_tokenString

A token to start the list. Use this token to get the next set of results.

Returns:

  • (String)


8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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

#result_attributesArray<Types::OpsResultAttribute>

The OpsItem data type to return.

Returns:



8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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

#sync_nameString

Specify the name of a resource data sync to get.

Returns:

  • (String)


8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8219

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