Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchUpdateBillScenarioCommitmentModification

Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.

Note

The BatchUpdateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon principals, include the permission bcm-pricing-calculator:UpdateBillScenarioCommitmentModification in your policies.

Request Syntax


{
   "billScenarioId": "string",
   "commitmentModifications": [ 
      { 
         "group": "string",
         "id": "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.

billScenarioId

The ID of the Bill Scenario for which you want to modify the commitment group of a modeled commitment.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

commitmentModifications

List of commitments that you want to update in a Bill Scenario.

Type: Array of BatchUpdateBillScenarioCommitmentModificationEntry objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax


{
   "errors": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "id": "string"
      }
   ],
   "items": [ 
      { 
         "commitmentAction": { ... },
         "group": "string",
         "id": "string",
         "usageAccountId": "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.

errors

Returns the list of error reasons and commitment line item IDs that could not be updated for the Bill Scenario.

Type: Array of BatchUpdateBillScenarioCommitmentModificationError objects

items

Returns the list of successful commitment line items that were updated for a Bill Scenario.

Type: Array of BillScenarioCommitmentModificationItem objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 400

DataUnavailableException

The requested data is currently unavailable.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon support.

retryAfterSeconds: An internal error has occurred. Retry your request, but if the problem persists, contact Amazon support.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

quotaCode: The quota code that exceeded the throttling limit.
retryAfterSeconds: The service code that exceeded the throttling limit. Retry your request, but if the problem persists, contact Amazon support.
serviceCode: The service code that exceeded the throttling limit.

HTTP Status Code: 400

ValidationException

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

fieldList: The list of fields that are invalid.
reason: The reason for the validation exception.

HTTP Status Code: 400