Class: Aws::ApplicationDiscoveryService::Types::ListConfigurationsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-applicationdiscoveryservice/types.rb

Overview

Note:

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

{
  configuration_type: "SERVER", # required, accepts SERVER, PROCESS, CONNECTION, APPLICATION
  filters: [
    {
      name: "String", # required
      values: ["FilterValue"], # required
      condition: "Condition", # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  order_by: [
    {
      field_name: "String", # required
      sort_order: "ASC", # accepts ASC, DESC
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_type ⇒ String

A valid configuration identified by Application Discovery Service.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
 
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 926

class ListConfigurationsRequest < Struct.new(
  :configuration_type,
  :filters,
  :max_results,
  :next_token,
  :order_by)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

You can filter the request using various logical operators and a key-value format. For example:

‘“serverType”, “value”: “webServer”`

For a complete list of filter options and guidance about using them with this action, see [Querying Discovered Configuration Items].

[1]: docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations

Returns:



926
927
928
929
930
931
932
933
 
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 926

class ListConfigurationsRequest < Struct.new(
  :configuration_type,
  :filters,
  :max_results,
  :next_token,
  :order_by)
  include Aws::Structure
end

#max_results ⇒ Integer

The total number of items to return. The maximum value is 100.

Returns:

  • (Integer) 


926
927
928
929
930
931
932
933
 
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 926

class ListConfigurationsRequest < Struct.new(
  :configuration_type,
  :filters,
  :max_results,
  :next_token,
  :order_by)
  include Aws::Structure
end

#next_token ⇒ String

Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ‘ListConfigurationsRequest$maxResults` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Returns:

  • (String) 


926
927
928
929
930
931
932
933
 
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 926

class ListConfigurationsRequest < Struct.new(
  :configuration_type,
  :filters,
  :max_results,
  :next_token,
  :order_by)
  include Aws::Structure
end

#order_by ⇒ Array<Types::OrderByElement>

Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see [Using the ListConfigurations Action].

[1]: docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations

Returns:



926
927
928
929
930
931
932
933
 
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 926

class ListConfigurationsRequest < Struct.new(
  :configuration_type,
  :filters,
  :max_results,
  :next_token,
  :order_by)
  include Aws::Structure
end