Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate BillScenarioCommitmentModificationAction of BatchCreateBillScenarioCommitmentModification operation.
Note
The BatchDeleteBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for AWS principals,
include the permission bcm-pricing-calculator:DeleteBillScenarioCommitmentModification in your policies.
Request Syntax
{
"billScenarioId": "string",
"ids": [ "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 delete the 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
- ids
-
List of commitments that you want to delete from the Bill Scenario.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
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
Response Syntax
{
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"id": "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 errors reason and the commitment item keys that cannot be deleted from the Bill Scenario.
Type: Array of BatchDeleteBillScenarioCommitmentModificationError 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.
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 AWS support.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input provided fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
