AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateAgreementAsync.

Namespace: Amazon.Transfer
Assembly: AWSSDK.Transfer.dll
Version: 3.x.y.z

Syntax

C#
public abstract UpdateAgreementResponse UpdateAgreement(
         UpdateAgreementRequest request
)

Parameters

request
Type: Amazon.Transfer.Model.UpdateAgreementRequest

Container for the necessary parameters to execute the UpdateAgreement service method.

Return Value


The response from the UpdateAgreement service method, as returned by Transfer.

Exceptions

ExceptionCondition
InternalServiceErrorException This exception is thrown when an error occurs in the Transfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ThrottlingException The request was denied due to request throttling.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also