[ aws . billing ]

create-contractual-investment-attestation

Description

Creates an attestation that claims an investment award for a completed milestone or outcome within a private pricing contract. Supply a clientToken to make the request idempotent so a safe retry does not create a duplicate attestation. This operation starts an asynchronous review and returns an attestationId while the attestation is pending.

See also: AWS API Documentation

Synopsis

  create-contractual-investment-attestation
--contract-arn <value>
--investment-summary-id <value>
--investment-id <value>
--contract-document-id <value>
--approver-details <value>
[--investment-disbursed-at <value>]
--attestation-details <value>
[--additional-recipients <value>]
[--client-token <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

--contract-arn (string) [required]

The Amazon Resource Name (ARN) of the contract that contains the investment being attested.

Constraints:

  • min: 1
  • max: 500
  • pattern: arn:aws[a-z-]*:billing::[0-9]{12}:contract/[a-zA-Z0-9_\+=\.\@-]{0,70}[a-zA-Z0-9]

--investment-summary-id (string) [required]

The identifier of the investment summary being attested. This is the parent to the investmentId.

Constraints:

  • min: 1
  • max: 36
  • pattern: [a-zA-Z0-9_\-]+

--investment-id (string) [required]

The identifier of the investment (outcome) being attested.

Constraints:

  • min: 1
  • max: 36
  • pattern: [a-zA-Z0-9_\-]+

--contract-document-id (string) [required]

The contract ID from the contract document, located in the top-right corner of the private pricing contract pages. This value confirms that you have access to the contract.

Constraints:

  • min: 1
  • max: 36

--approver-details (structure) [required]

The details of the executive who authorized the attestation, under the terms of the private pricing contract. The executive receives a click-to-accept email to confirm the attestation.

name -> (string) [required]

The name of the approver as it appears on the contract. This value can be up to 256 characters.

Constraints:

  • min: 1
  • max: 256

title -> (string) [required]

The title of the approver, such as Chief Financial Officer . This value can be up to 256 characters.

Constraints:

  • min: 1
  • max: 256

email -> (string) [required]

The email address of the approver. This value is 3–256 characters and must be a valid email address.

Constraints:

  • min: 3
  • max: 256
  • pattern: [A-Za-z0-9._%+\-]+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}

Shorthand Syntax:

name=string,title=string,email=string

JSON Syntax:

{
  "name": "string",
  "title": "string",
  "email": "string"
}

--investment-disbursed-at (timestamp)

The date on which the investment is disbursed to the investment accounts. The disbursement date is subject to review timelines.

--attestation-details (structure) [required]

The details of the attestation, including the value being claimed and how the resulting investment is distributed across investment accounts.

attestationValue -> (tagged union structure) [required]

The value being attested, expressed as either a monetary amount or one or more quantities. Exactly one form is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: attestationAmount, attestationQuantities.

attestationAmount -> (structure)

The value attested as a monetary amount. This form is valid only when the investment has no multiplier.

currencyCode -> (string) [required]

The ISO 4217 currency code for the amount (for example, USD ).

Constraints:

  • pattern: [A-Z]{3}

currencyAmount -> (string) [required]

The amount as a decimal string (for example, "743.21" ). Negative values represent credits that reduce a bill.

Constraints:

  • pattern: [0-9]+(.[0-9]+)

attestationQuantities -> (list)

The value attested as one or more quantities, each with its own unit. The list contains at most 50 quantities.

Constraints:

  • min: 0
  • max: 50

(structure)

A quantity-based attestation value, such as a count of workloads migrated.

attestationVolume -> (string) [required]

The number of units being attested, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1–1000 characters.

Constraints:

  • min: 1
  • max: 1000
  • pattern: [0-9]+(\.[0-9]+)?

attestationUnit -> (string) [required]

The unit of the attestation, such as workloads migrated . This value is 1–1000 characters.

Constraints:

  • min: 1
  • max: 1000

investmentDistributions -> (list)

The distribution of the resulting investment across the eligible investment accounts on the contract. If you omit this value, the full investment is allocated to the single eligible investment account on the contract. This value is required when multiple investment accounts are eligible. When you provide this value, the sum of all distributions must equal the resulting monetary investment value (the attested amount, or the value computed from the attested quantities using the investment multipliers). The list contains at most 200 distributions.

Constraints:

  • min: 0
  • max: 200

(structure)

An allocation of an investment disbursement to a specific recipient account. The account is the target account that receives the investment, not your account.

accountId -> (string) [required]

The recipient Amazon Web Services account ID that receives this portion of the investment. This must be one of the eligible investment accounts on the contract.

Constraints:

  • pattern: [0-9]{12}

investmentAmount -> (structure) [required]

The monetary value allocated to the recipient account.

currencyCode -> (string) [required]

The ISO 4217 currency code for the amount (for example, USD ).

Constraints:

  • pattern: [A-Z]{3}

currencyAmount -> (string) [required]

The amount as a decimal string (for example, "743.21" ). Negative values represent credits that reduce a bill.

Constraints:

  • pattern: [0-9]+(.[0-9]+)

JSON Syntax:

{
  "attestationValue": {
    "attestationAmount": {
      "currencyCode": "string",
      "currencyAmount": "string"
    },
    "attestationQuantities": [
      {
        "attestationVolume": "string",
        "attestationUnit": "string"
      }
      ...
    ]
  },
  "investmentDistributions": [
    {
      "accountId": "string",
      "investmentAmount": {
        "currencyCode": "string",
        "currencyAmount": "string"
      }
    }
    ...
  ]
}

--additional-recipients (list)

The email addresses to copy as viewers on the executive approval request.

Constraints:

  • min: 0
  • max: 10

(structure)

A recipient copied as a viewer on the executive approval request, in addition to the approver.

email -> (string) [required]

The email address of the recipient. This value is 3–256 characters and must be a valid email address.

Constraints:

  • min: 3
  • max: 256
  • pattern: [A-Za-z0-9._%+\-]+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}

Shorthand Syntax:

email=string ...

JSON Syntax:

[
  {
    "email": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry completes without performing any further actions.

Constraints:

  • min: 1
  • max: 64
  • pattern: [!-~]+

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

attestationId -> (string)

The identifier of the submitted attestation.

Constraints:

  • min: 1
  • max: 36
  • pattern: [a-zA-Z0-9_\-]+