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 ]

batch-create-billing-adjustment-request

Description

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed validation.

Note

Each entry requires a unique clientToken for idempotency. A ValidationException is returned if the adjustment amount exceeds the maximum refundable amount for the invoice.

See also: AWS API Documentation

Synopsis

  batch-create-billing-adjustment-request
--billing-adjustment-request-entries <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

--billing-adjustment-request-entries (list)

A list of billing adjustment request entries. Each entry specifies the invoice and adjustment details.

(structure)

An individual entry in a batch billing adjustment request, specifying the invoice and adjustment details.

agreementId -> (string)

The unique identifier of the agreement associated with the invoice.

originalInvoiceId -> (string)

The identifier of the original invoice to adjust.

adjustmentAmount -> (string)

The adjustment amount as a string representation of a decimal number in the currency of the invoice.

currencyCode -> (string)

The 3-letter ISO 4217 currency code for the adjustment amount (e.g., USD ).

adjustmentReasonCode -> (string)

The reason code for the billing adjustment. Valid values include INCORRECT_TERMS_ACCEPTED , INCORRECT_METERING , TEST_ENVIRONMENT_CHARGES , ALTERNATIVE_PROCUREMENT_CHANNEL , UNINTENDED_RENEWAL , BUYER_DISSATISFACTION , and OTHER .

description -> (string)

An optional detailed description of the adjustment reason.

clientToken -> (string)

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

Shorthand Syntax:

agreementId=string,originalInvoiceId=string,adjustmentAmount=string,currencyCode=string,adjustmentReasonCode=string,description=string,clientToken=string ...

JSON Syntax:

[
  {
    "agreementId": "string",
    "originalInvoiceId": "string",
    "adjustmentAmount": "string",
    "currencyCode": "string",
    "adjustmentReasonCode": "INCORRECT_TERMS_ACCEPTED"|"INCORRECT_METERING"|"TEST_ENVIRONMENT_CHARGES"|"ALTERNATIVE_PROCUREMENT_CHANNEL"|"UNINTENDED_RENEWAL"|"BUYER_DISSATISFACTION"|"OTHER",
    "description": "string",
    "clientToken": "string"
  }
  ...
]

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

items -> (list)

A list of successfully created billing adjustment items, each containing the billingAdjustmentRequestId and clientToken .

(structure)

A successfully created billing adjustment request item.

billingAdjustmentRequestId -> (string)

The unique identifier of the created billing adjustment request.

clientToken -> (string)

The client token provided in the corresponding request entry.

errors -> (list)

A list of errors for entries that failed validation, each containing the clientToken , error code , and message .

(structure)

An error for a billing adjustment request entry that failed validation.

code -> (string)

The error code indicating the reason for failure.

message -> (string)

A human-readable message describing the error.

clientToken -> (string)

The client token of the request entry that failed.