Class: Aws::ApplicationDiscoveryService::Types::DescribeAgentsRequest

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationDiscoveryService::Types::DescribeAgentsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-applicationdiscoveryservice/types.rb

Overview

Note:

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

{
  agent_ids: ["AgentId"],
  filters: [
    {
      name: "String", # required
      values: ["FilterValue"], # required
      condition: "Condition", # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary

• #agent_ids ⇒ Array<String>

  The agent or the Connector IDs for which you want information.

• #filters ⇒ Array<Types::Filter>

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

• #max_results ⇒ Integer

  The total number of agents/Connectors to return in a single page of output.

• #next_token ⇒ String

  Token to retrieve the next set of results.

Instance Attribute Details

#agent_ids ⇒ Array<String>

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

class DescribeAgentsRequest < Struct.new(
  :agent_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

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

‘“collectionStatus”, “value”: “STARTED”`

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

class DescribeAgentsRequest < Struct.new(
  :agent_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

class DescribeAgentsRequest < Struct.new(
  :agent_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ‘DescribeAgentsRequest$agentIds` but set `DescribeAgentsRequest$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)

# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

class DescribeAgentsRequest < Struct.new(
  :agent_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end