Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListContractualInvestmentSummaries

Lists the investment summaries within a specific private pricing contract. This operation is read-only and paginated.

Request Syntax


{
   "contractArn": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

contractArn

The Amazon Resource Name (ARN) of the contract whose investment summaries you want to list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Pattern: arn:aws[a-z-]*:billing::[0-9]{12}:contract/[a-zA-Z0-9_\+=\.\@-]{0,70}[a-zA-Z0-9]

Required: Yes

maxResults

The maximum number of investment summaries to return in a single call. Minimum value of 1, maximum value of 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token that indicates the next set of results to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4095.

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

Required: No

Response Syntax


{
   "items": [ 
      { 
         "investmentName": "string",
         "investmentSummaryId": "string",
         "investmentType": "string",
         "maxAllowedInvestmentDisbursementValue": { 
            "currencyAmount": "string",
            "currencyCode": "string"
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The list of investment summaries under the contract. It includes the investment name, maximum investment amount, and investment type. It does not provide investment details. Use this to know if the contract has investment terms and what type.

Type: Array of InvestmentSummary objects

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4095.

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

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified ARN in the request doesn't exist.

resourceId: Value is a list of resource IDs that were not found.
resourceType: Value is the type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

fieldList: The input fails to satisfy the constraints specified by an Amazon service.
reason: The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400