- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateAgentCommand
Updates the name of an DataSync agent.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, UpdateAgentCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateAgentCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateAgentRequest
AgentArn: "STRING_VALUE", // required
Name: "STRING_VALUE",
};
const command = new UpdateAgentCommand(input);
const response = await client.send(command);
// {};
UpdateAgentCommand Input
See UpdateAgentCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AgentArnRequired | string | undefined | The Amazon Resource Name (ARN) of the agent to update. |
Name | string | undefined | The name that you want to use to configure the agent. |
UpdateAgentCommand Output
See UpdateAgentCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalException | server | This exception is thrown when an error occurs in the DataSync service. |
| InvalidRequestException | client | This exception is thrown when the client submits a malformed request. |
| DataSyncServiceException | Base exception class for all service exceptions from DataSync service. |