DescribeAgreement
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
Request Syntax
{
"agreementId": "string
"
}
Request 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,
"estimatedCharges": {
"agreementValue": "string",
"currencyCode": "string"
},
"proposalSummary": {
"offerId": "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
andStartTime
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
orVendorInsightsAgreement
.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
- estimatedCharges
-
The estimated cost of the agreement.
Type: EstimatedCharges object
- 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. -
ARCHIVED
– The agreement ended without a specified reason. -
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. -
ROLLED_BACK
(Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active. -
SUPERCEDED
(Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active. -
TERMINATED
– The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).
Type: String
Valid Values:
ACTIVE | ARCHIVED | CANCELLED | EXPIRED | RENEWED | REPLACED | ROLLED_BACK | SUPERSEDED | TERMINATED
-
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: 400
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 400
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
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": 2023-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" ], "status": "ACTIVE", "estimatedCharges": { "currencyCode": "USD", "agreementValue": "1000" } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: