list-contractual-investments¶

Description¶

Lists the investments within a specific investment summary. This operation is read-only and paginated.

Synopsis¶

  list-contractual-investments
--contract-arn <value>
--investment-summary-id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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 summary.

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 whose investments you want to list.

Constraints:

min: 1

max: 36

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

items -> (list)

The list of investments for the investment summary.

(tagged union structure)

An investment within an investment summary. This is a union in which exactly one member is set. The milestoneBasedInvestment member represents a fixed, scheduled investment. The outcomeBasedInvestment member represents an attestable investment awarded upon completion of a defined outcome. Check which member is present to determine the investment type.

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

milestoneBasedInvestment -> (structure)

An investment with a fixed value that is disbursed on a schedule. This member is set for a milestone-based investment and corresponds to the MILESTONE_BASED investment type.

investmentId -> (string) [required]

The identifier of the investment, as returned by ListContractualInvestments . This value is 1–36 characters.

Constraints:

min: 1

max: 36

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

investmentValue -> (structure) [required]

The total value of the investment, including its currency and amount.

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]+)

investmentDisbursedAt -> (timestamp) [required]

The date on which the investment is disbursed to the investment accounts.

outcomeBasedInvestment -> (structure)

An investment that is awarded upon completion of a defined outcome. This member is set for an outcome-based (attestable) investment and corresponds to the OUTCOME_BASED investment type.

investmentId -> (string) [required]

The identifier of the investment, as returned by ListContractualInvestments . This value is 1–36 characters.

Constraints:

min: 1

max: 36

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

outcomeDescription -> (string) [required]

The description of what must be completed to attest the outcome. This value is 1–2048 characters.

Constraints:

min: 1

max: 2048

attestationWindow -> (structure) [required]

The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.

startDateInclusive -> (timestamp) [required]

The start date of the interval. This date is included in the interval.

endDateInclusive -> (timestamp) [required]

The end date of the interval. This date is included in the interval.

investmentRestrictions -> (list)

The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.

Constraints:

min: 0

max: 10

(structure)

A restriction that caps the value that can be disbursed for an investment. The cap applies for each attestation window.

amount -> (structure) [required]

The maximum monetary amount allowed under the restriction.

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]+)

investmentMultipliers -> (list)

The multipliers used to compute the investment value from the attestation input. The list contains at most 200 multipliers. Multipliers are derived from the terms of the private pricing contract.

Constraints:

min: 0

max: 200

(structure)

A multiplier used to convert attestation input into an investment value.

value -> (string) [required]

The multiplier value, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1–1000 characters. The terms of the contract define this value.

Constraints:

min: 1

max: 1000

pattern: [0-9]+(\.[0-9]+)?

investmentAttestationInputUnit -> (string) [required]

The unit of the attestation input that the multiplier applies to, such as workloads migrated . This value is 1–1000 characters. The terms of the contract define this value.

Constraints:

min: 1

max: 1000

multiplierType -> (string) [required]

The type of the multiplier. A value of PERCENTAGE applies a percentage of a value. A value of CURRENCY_AMOUNT applies a currency amount per unit of attestation input. The terms of the contract define this value.

Possible values:

PERCENTAGE

CURRENCY_AMOUNT

disbursedValue -> (structure) [required]

The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.

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]+)

nextToken -> (string)

The pagination token to use on subsequent calls to retrieve the next set of results.

Constraints:

min: 1

max: 4095

pattern: [-a-zA-Z0-9+=/_]+

Table of Contents

Feedback

User Guide