You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationdiscoveryservice/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 collapse

Instance Attribute Details

#agent_idsArray<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>)


415
416
417
418
419
420
421
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

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

#filtersArray<Types::Filter>

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

\{"key": "collectionStatus", "value": "STARTED"\}

Returns:



415
416
417
418
419
420
421
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

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

#max_resultsInteger

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

Returns:

  • (Integer)


415
416
417
418
419
420
421
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

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

#next_tokenString

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)


415
416
417
418
419
420
421
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 415

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