DeleteAgreement
Delete the agreement that's specified in the provided AgreementId.
Request Syntax
{
"AgreementId": "string",
"ServerId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AgreementId
-
A unique identifier for the agreement. This identifier is returned when you create an agreement.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
a-([0-9a-f]{17})Required: Yes
- ServerId
-
The server identifier associated with the agreement that you are deleting.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
s-([0-9a-f]{17})Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
