Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

TerminateAgreement

Terminate an existing customer-agreement.

Request Syntax


POST /v1/customer-agreement/terminate HTTP/1.1
Content-type: application/json

{
   "customerAgreementId": "string",
   "terminateAgreementToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

customerAgreementId

customer-agreement identifier.

Type: String

Pattern: customer-agreement-[a-zA-Z0-9]{16}

Required: Yes

terminateAgreementToken

Agreement token for terminating an agreement, received when calling GetCustomerAgreement.

Type: String

Pattern: agreement-token-[a-zA-Z0-9]{24}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "customerAgreement": { 
      "agreementArn": "string",
      "arn": "string",
      "effectiveEnd": "string",
      "effectiveStart": "string",
      "id": "string",
      "name": "string",
      "state": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

customerAgreement

customer-agreement summary details.

Type: TerminateCustomerAgreementSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unknown server exception has occurred.

retryAfterSeconds: Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: Identifier of the affected resource.
resourceType: Type of the affected resource.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

quotaCode: Code for the affected quota.
resourceId: Identifier of the affected resource.
resourceType: Type of the affected resource.
serviceCode: Code for the affected service.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

quotaCode: Code for the affected quota.
retryAfterSeconds: Number of seconds in which the caller can retry the request.
serviceCode: Code for the affected service.

HTTP Status Code: 429

ValidationException

Request fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
reason: Reason the request failed validation.

HTTP Status Code: 400