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

GetNdaForAgreement

Retrieve the NDA document for an agreement.

Request Syntax


GET /v1/agreement/getNdaForAgreement?agreementId=agreementId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

agreementId

Agreement identifier.

Pattern: 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

{
   "acceptNdaForAgreementToken": "string",
   "agreementRevisionId": "string",
   "documentPresignedUrl": "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.

acceptNdaForAgreementToken

NDA token that can be used to accept the NDA retrieved.

Type: String

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

agreementRevisionId

Revision Id of the current NDA for the given agreement.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

documentPresignedUrl

Presigned S3 url to access the NDA content.

Type: String

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

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