AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . marketplace-agreement ]

describe-agreement

Description

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

See also: AWS API Documentation

Synopsis

  describe-agreement
--agreement-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--agreement-id (string)

The unique identifier of the agreement.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

agreementId -> (string)

The unique identifier of the agreement.

acceptor -> (structure)

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

accountId -> (string)

The AWS account ID of the acceptor.

proposer -> (structure)

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

accountId -> (string)

The AWS account ID of the proposer.

startTime -> (timestamp)

The date and time when the agreement starts.

endTime -> (timestamp)

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

acceptanceTime -> (timestamp)

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

Note

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

agreementType -> (string)

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement .

estimatedCharges -> (structure)

The estimated cost of the agreement.

currencyCode -> (string)

Defines the currency code for the charge.

agreementValue -> (string)

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

Note

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.

proposalSummary -> (structure)

A summary of the proposal received from the proposer.

resources -> (list)

The list of resources involved in the agreement.

(structure)

The list of resources involved in the agreement.

id -> (string)

The unique identifier of the resource.

Note

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

type -> (string)

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

offerId -> (string)

The unique identifier of the offer in AWS Marketplace.

offerSetId -> (string)

A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

status -> (string)

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.
  • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).