Skip to content

aws.marketplace_agreement.describe_agreement

Example SQL Queries

SELECT * FROM
aws.marketplace_agreement.describe_agreement
WHERE
"agreement_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
agreement_id Required Input Column

The unique identifier of the agreement.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

acceptance_time

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

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

TIMESTAMP_S
acceptor

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

STRUCT(
"account_id" VARCHAR
)
Show child fields
acceptor.account_id

The AWS account ID of the acceptor.

agreement_type

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

VARCHAR
end_time

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

TIMESTAMP_S
estimated_charges

The estimated cost of the agreement.

STRUCT(
"agreement_value" VARCHAR,
"currency_code" VARCHAR
)
Show child fields
estimated_charges.agreement_value

The total known amount customer has to pay across the lifecycle of the agreement.

This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm or FixedUpfrontPricingTerm. In the case of pure contract pricing, this will be the total value of the contract. In the case of contracts with consumption pricing, this will only include the committed value and not include any overages that occur.

If the accepted terms contain PaymentScheduleTerm, it will be the total payment schedule amount. This occurs when flexible payment schedule is used, and is the sum of all invoice charges in the payment schedule.

In case a customer has amended an agreement, by purchasing more units of any dimension, this will include both the original cost as well as the added cost incurred due to addition of new units.

This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm or RecurringPaymentTerm. This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or monthly), because the exact usage is not known upfront.

estimated_charges.currency_code

Defines the currency code for the charge.

proposal_summary

A summary of the proposal received from the proposer.

STRUCT(
"offer_id" VARCHAR,
"resources" STRUCT(
"id" VARCHAR,
"type" VARCHAR
)[]
)
Show child fields
proposal_summary.offer_id

The unique identifier of the offer in AWS Marketplace.

proposal_summary.resources[]
Show child fields
proposal_summary.resources[].id

The unique identifier of the resource.

We mention the term resource, which is most commonly a product, so a resourceId is also a productId.

proposal_summary.resources[].type

Type of the resource, which is the product. Values include SaaSProduct or AmiProduct.

proposer

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

STRUCT(
"account_id" VARCHAR
)
Show child fields
proposer.account_id

The AWS account ID of the proposer.

start_time

The date and time when the agreement starts.

TIMESTAMP_S
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).

VARCHAR