Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeAgreement

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Request Syntax


{
   "agreementId": "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.

Note

In the following list, the required parameters are described first.

agreementId

The unique identifier of the agreement.

Type: String

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

Pattern: [A-Za-z0-9_/-]+

Required: Yes

Response Syntax


{
   "acceptanceTime": number,
   "acceptor": { 
      "accountId": "string"
   },
   "agreementId": "string",
   "agreementType": "string",
   "endTime": number,
   "endTimeBehavior": { 
      "reasonCode": "string",
      "renewalSummary": { 
         "offerId": "string"
      },
      "type": "string"
   },
   "estimatedCharges": { 
      "agreementValue": "string",
      "currencyCode": "string"
   },
   "initialAgreementId": "string",
   "proposalSummary": { 
      "offerId": "string",
      "offerSetId": "string",
      "resources": [ 
         { 
            "id": "string",
            "type": "string"
         }
      ]
   },
   "proposer": { 
      "accountId": "string"
   },
   "startTime": number,
   "status": "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.

acceptanceTime

The date and time the offer was accepted or the agreement was created.

Note

AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

Type: Timestamp

acceptor

The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

Type: Acceptor object

agreementId

The unique identifier of the agreement.

Type: String

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

Pattern: [A-Za-z0-9_/-]+

agreementType

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

Type: String

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

Pattern: [A-Za-z]+

endTime

The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

Type: Timestamp

endTimeBehavior

The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.

This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.

Type: EndTimeBehavior object

estimatedCharges

The estimated cost of the agreement.

Type: EstimatedCharges object

initialAgreementId

The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. When an agreement isn't derived from another agreement, its InitialAgreementId is its own AgreementId.

Type: String

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

Pattern: [A-Za-z0-9_/-]+

proposalSummary

A summary of the proposal received from the proposer.

Type: ProposalSummary object

proposer

The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

Type: Proposer object

startTime

The date and time when the agreement starts.

Type: Timestamp

status

The current status of the agreement.

Statuses include:

ACTIVE – The terms of the agreement are active.
CANCELLED – The acceptor ended the agreement before the defined end date.
EXPIRED – The agreement ended on the defined end date.
RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).
REPLACED – The agreement was replaced using an agreement replacement offer.
TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

Type: String

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

message: Description of the error.
reason: The reason for the access denied exception.
requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

message: Description of the error.
requestId: The unique identifier for the error.
resourceId: The unique identifier for the resource.
resourceType: The type of resource.

HTTP Status Code: 400

ThrottlingException

Request was denied due to request throttling.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service.

fields: The fields associated with the error.
message: Description of the error.
reason: The reason associated with the error.
requestId: The unique identifier associated with the error.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of DescribeAgreement.


{
    "agreementId" : "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95"
}

Sample response

This example illustrates one usage of DescribeAgreement.


{
   "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
   "acceptor": {
        "accountId": "123456789010"
   },
   "proposer": {
        "accountId": "123456789010"
   },
   "startTime": "2019-10-08T21:40:43.644Z",
   "endTime": "2026-10-08T21:40:43.644Z",
   "acceptanceTime": "2019-10-08T00:00:00.000Z",
   "agreementType": "PurchaseAgreement",
   "proposalSummary": {
       "resources": [
           {
               "id": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5",
               "type": "AmiProduct"
           }
       ],
       "offerId": "ABCDEFGHIJKLMNOP123",
       "offerSetId": "KMZQABLKAXWYG3NW516"
   },
   "status": "ACTIVE",
   "estimatedCharges": {
       "currencyCode": "USD",
       "agreementValue": "1000"
   },
   "initialAgreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
   "endTimeBehavior": {
       "type": "EXPIRE",
       "reasonCode": "ACCEPTOR_RENEW_OPTED_OUT",
       "renewalSummary": {
           "offerId": "ABCDEFGHIJKLMNOP123"
       }
   }
}