UpdateFarmCommand

Updates a farm.

Example Syntax

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

import { DeadlineClient, UpdateFarmCommand } from "@aws-sdk/client-deadline"; // ES Modules import
// const { DeadlineClient, UpdateFarmCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
const client = new DeadlineClient(config);
const input = { // UpdateFarmRequest
  farmId: "STRING_VALUE", // required
  displayName: "STRING_VALUE",
  description: "STRING_VALUE",
};
const command = new UpdateFarmCommand(input);
const response = await client.send(command);
// {};

UpdateFarmCommand Input

See UpdateFarmCommandInput for more details

Parameter
Type
Description
farmId
Required
string | undefined

The farm ID to update.

description
string | undefined

The description of the farm to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

displayName
string | undefined

The display name of the farm to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

UpdateFarmCommand Output

See UpdateFarmCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permission to perform the action.

InternalServerErrorException
server

Deadline Cloud can't process your request right now. Try again later.

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a request rate quota.

ValidationException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

DeadlineServiceException
Base exception class for all service exceptions from Deadline service.