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

AcceptAgreement

Accept an agreement.

Request Syntax


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

{
   "acceptanceTermsToken": "string",
   "agreementId": "string",
   "agreementRevisionId": "string",
   "executeAgreementToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

acceptanceTermsToken

Agreement token for acknowledging acceptance terms of the agreement, received when calling GetAgreement.

Type: String

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

Required: Yes

agreementId

Agreement identifier.

Type: String

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

Required: Yes

agreementRevisionId

Revision Id received when calling GetAgreement.

Type: String

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

Required: Yes

executeAgreementToken

Agreement token for executing an agreement, received when calling GetAgreement.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "customerAgreement": { 
      "acceptanceTerms": [ "string" ],
      "agreementArn": "string",
      "arn": "string",
      "awsAccountId": "string",
      "description": "string",
      "effectiveEnd": "string",
      "effectiveStart": "string",
      "id": "string",
      "name": "string",
      "organizationArn": "string",
      "state": "string",
      "terminateTerms": [ "string" ],
      "type": "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: CustomerAgreementSummary 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.

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