You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ApplicationDiscoveryService::Types::DescribeAgentsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApplicationDiscoveryService::Types::DescribeAgentsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeAgentsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
agent_ids: ["AgentId"],
filters: [
{
name: "String", # required
values: ["FilterValue"], # required
condition: "Condition", # required
},
],
max_results: 1,
next_token: "NextToken",
}
Instance Attribute Summary collapse
-
#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.
#filters ⇒ Array<Types::Filter>
You can filter the request using various logical operators and a key-value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
#max_results ⇒ Integer
The total number of agents/Connectors to return in a single page of output. The maximum value is 100.
#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.