Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425150118.3 KB

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call <code>DescribeAgents</code> as is without passing any parameters.

post/#X-Amz-Target=AWSPoseidonService_V2015_11_01.DescribeAgents

Headers

X-Amz-Target'AWSPoseidonService_V2015_11_01.DescribeAgents' required

Request body

agentIdsAgentId[]

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 Amazon Web Services user account.

maxResultsinteger

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

nextTokenstring

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

Response

Success

nextTokenstring

Token to retrieve the next set of results. For example, if you specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.