create-agreement-request¶

Description¶

Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.

Synopsis¶

  create-agreement-request
[--client-token <value>]
--intent <value>
--requested-terms <value>
[--source-agreement-identifier <value>]
[--agreement-proposal-identifier <value>]
[--tax-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-]+

--intent (string) [required]

The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

NEW – Creates a new agreement for terms in the request.

AMEND – Modifies an existing agreement with terms that are accepted in the request.

REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

Possible values:

NEW

AMEND

REPLACE

--requested-terms (list) [required]

A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

Constraints:

min: 1

max: 30

(structure)

Defines what is being accepted as part of the agreement creation or update request, and it includes their configurations.

id -> (string) [required]

The unique identifier of the term in the agreement proposal.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

configuration -> (tagged union structure)

Additional configuration for the requested terms. This configuration is applicable only to the terms that accept a customer-provided configuration, such as ConfigurableUpfrontPricingTerm .

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: configurableUpfrontPricingTermConfiguration, renewalTermConfiguration, variablePaymentTermConfiguration.

configurableUpfrontPricingTermConfiguration -> (structure)

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

selectorValue -> (string) [required]

Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.

Constraints:

min: 1

max: 4096

pattern: (.)+

dimensions -> (list) [required]

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

Constraints:

min: 1

(structure)

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

dimensionKey -> (string) [required]

The name of key value of the dimension.

Constraints:

min: 1

max: 4096

pattern: (.)+

dimensionValue -> (integer) [required]

The number of units of the dimension the acceptor has purchased.

Note
For Agreements with ConfigurableUpfrontPricingTerm , the RateCard section will define the prices and dimensions defined by the seller (proposer), whereas the Configuration section will define the actual dimensions, prices, and units the buyer has chosen to accept.

Constraints:

min: 0

renewalTermConfiguration -> (structure)

Additional parameters specified by the acceptor while accepting the term.

enableAutoRenew -> (boolean) [required]

Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False .

variablePaymentTermConfiguration -> (structure)

Additional parameters specified by the acceptor while accepting the variable payment term.

paymentRequestApprovalStrategy -> (string) [required]

Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL

Possible values:

AUTO_APPROVE_ON_EXPIRATION

WAIT_FOR_APPROVAL

expirationDuration -> (string)

Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION . The duration is represented in the ISO_8601 format (e.g., P10D for 10 days).

Constraints:

pattern: ([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?

JSON Syntax:

[
  {
    "id": "string",
    "configuration": {
      "configurableUpfrontPricingTermConfiguration": {
        "selectorValue": "string",
        "dimensions": [
          {
            "dimensionKey": "string",
            "dimensionValue": integer
          }
          ...
        ]
      },
      "renewalTermConfiguration": {
        "enableAutoRenew": true|false
      },
      "variablePaymentTermConfiguration": {
        "paymentRequestApprovalStrategy": "AUTO_APPROVE_ON_EXPIRATION"|"WAIT_FOR_APPROVAL",
        "expirationDuration": "string"
      }
    }
  }
  ...
]

--source-agreement-identifier (string)

The agreement’s identifier that the request acts upon.

Warning
This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE ). Don’t provide this parameter if the intent is NEW .

Constraints:

min: 1

max: 64

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

--agreement-proposal-identifier (string)

The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.

Warning
This parameter is required if the intent is not AMEND .

Constraints:

min: 1

max: 64

pattern: (at-|ap-)[A-Za-z0-9]+

--tax-configuration (structure)

Configuration for tax estimation in the agreement request response.

taxEstimation -> (string)

Toggle to estimate tax as part of the response. Values include ENABLED and DISABLED . Default is DISABLED .

Possible values:

DISABLED

ENABLED

Shorthand Syntax:

taxEstimation=string

JSON Syntax:

{
  "taxEstimation": "DISABLED"|"ENABLED"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

agreementRequestId -> (string)

The unique identifier of the agreement request created. Use this identifier with AcceptAgreementRequest to accept the agreement.

Constraints:

min: 1

max: 64

pattern: ar-[A-Za-z0-9]+

chargeSummary -> (structure)

Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement .

currencyCode -> (string)

The three-letter currency code for all charges (e.g., USD).

Constraints:

min: 3

max: 3

pattern: [A-Z]+

newAgreementValue -> (string)

The total value of the agreement, which includes any amendments.

Constraints:

min: 1

max: 4096

pattern: (.)+

newAgreementValueAfterTax -> (string)

Expected new agreement value after estimated taxes are applied.

Constraints:

min: 1

max: 4096

pattern: (.)+

expectedCharges -> (list)

A list of expected charges for the agreement request.

(structure)

Estimated charge for the request.

id -> (string)

Unique identifier of the charge for a given agreement.

Constraints:

min: 1

max: 64

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

time -> (timestamp)

The date and time when the charge is due to be invoiced. This is available only when the charge date is known.

amount -> (string)

The tax-exclusive amount of the charge. Only available when the charge amount is known.

Constraints:

min: 1

max: 4096

pattern: (.)+

amountAfterTax -> (string)

The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.

Constraints:

min: 1

max: 4096

pattern: (.)+

timing -> (string)

Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).

Possible values:

ON_ACCEPTANCE

SCHEDULED

BILLING_PERIOD

estimatedTaxes -> (structure)

Provides an aggregated view of estimated tax information for this specific charge.

breakdown -> (list)

A list of tax breakdown information.

(structure)

Represents a single tax breakdown entry with amount, rate, and type.

amount -> (string)

The estimated tax amount.

Constraints:

min: 1

max: 4096

pattern: (.)+

rate -> (string)

The tax rate, in decimals.

Constraints:

min: 1

max: 4096

pattern: (.)+

type -> (string)

The type of tax (for example, VAT, ST, or GST).

Constraints:

min: 1

max: 4096

pattern: (.)+

totalAmount -> (string)

The total amount of tax aggregated from the tax breakdown.

Constraints:

min: 1

max: 4096

pattern: (.)+

estimatedTaxes -> (structure)

Provides an aggregated view of estimated tax information for the agreement.

breakdown -> (list)

A list of tax breakdown information.

(structure)

Represents a single tax breakdown entry with amount, rate, and type.

amount -> (string)

The estimated tax amount.

Constraints:

min: 1

max: 4096

pattern: (.)+

rate -> (string)

The tax rate, in decimals.

Constraints:

min: 1

max: 4096

pattern: (.)+

type -> (string)

The type of tax (for example, VAT, ST, or GST).

Constraints:

min: 1

max: 4096

pattern: (.)+

totalAmount -> (string)

The total amount of tax aggregated from the tax breakdown.

Constraints:

min: 1

max: 4096

pattern: (.)+

itemizedCharges -> (list)

An itemized list of charges for the agreement request.

(structure)

A breakdown of individual charges or line items within a billing or pricing context.

dimensionKey -> (string)

The dimension key as specified in the accepted term.

Constraints:

min: 1

max: 4096

pattern: (.)+

newQuantity -> (integer)

The requested quantity for this dimension.

oldQuantity -> (integer)

The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.

chargeReference -> (string)

The identifier of the expected charge that this itemized charge contributes to.

Constraints:

min: 1

max: 64

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

incrementalChargeAmount -> (string)

The total incremental charge amount for this dimension.

Constraints:

min: 1

max: 4096

pattern: (.)+

invoicingEntity -> (structure)

The entity responsible for issuing the invoice.

legalName -> (string)

Legal name of the entity issuing the invoice.

Constraints:

min: 1

max: 4096

pattern: (.)+

branchName -> (string)

The branch where the issuing entity is operating from.

Constraints:

min: 1

max: 4096

pattern: (.)+

Table of Contents

Feedback

User Guide

create-agreement-request¶

Description¶

Synopsis¶

Options¶

Note

Note

Warning

Warning

Global Options¶

Output¶