Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListAgentsCommand

Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

example

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, ListAgentsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, ListAgentsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const command = new ListAgentsCommand(input);
const response = await client.send(command);
see

ListAgentsCommandInput for command's input shape.

see

ListAgentsCommandOutput for command's response shape.

see

config for DataSyncClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: ListAgentsCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListAgentsCommandInput, ListAgentsCommandOutput>

Methods

Static getEndpointParameterInstructions