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

GetCustomerAgreement

Retrieve a customer-agreement document.

Request Syntax


GET /v1/customer-agreement/get?customerAgreementId=customerAgreementId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

customerAgreementId

customer-agreement identifier.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "documentPresignedUrl": "string",
   "terminateAgreementToken": "string",
   "terminateTerms": [ "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.

documentPresignedUrl

Presigned S3 url to access the customer-agreement content.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

terminateAgreementToken

Agreement token that can be used to terminate this customer-agreement.

Type: String

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

terminateTerms

Terms that must be acknowledged in order to terminate the given agreement.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [^<>]*

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.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400