AmendBenefitApplication
Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control. The following fields paths can be modified using this API based on benefit program type.
For MAP and POC Programs: $.AccountId
For ISVWMP Programs: $.IsvWmpSecondTrancheConsentCaptured
Request Syntax
{
"AmendmentReason": "string",
"Amendments": [
{
"FieldPath": "string",
"NewValue": "string"
}
],
"Catalog": "string",
"ClientToken": "string",
"Identifier": "string",
"Revision": "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.
Note
In the following list, the required parameters are described first.
- AmendmentReason
-
A descriptive reason explaining why the benefit application is being amended.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: Yes
- Amendments
-
A list of specific field amendments to apply to the benefit application.
Type: Array of Amendment objects
Required: Yes
- Catalog
-
The catalog identifier that specifies which benefit catalog the application belongs to.
Type: String
Pattern:
[A-Za-z0-9_-]+Required: Yes
- ClientToken
-
A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]{1,64}Required: Yes
- Identifier
-
The unique identifier of the benefit application to be amended.
Type: String
Pattern:
(arn:.+|benappl-[0-9a-z]{14})Required: Yes
- Revision
-
The current revision number of the benefit application to ensure optimistic concurrency control.
Type: String
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Thrown when the caller does not have sufficient permissions to perform the requested operation.
- Message
-
A message describing the access denial.
HTTP Status Code: 400
- ConflictException
-
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
- Message
-
A message describing the conflict.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an unexpected error occurs on the server side during request processing.
- Message
-
A message describing the internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when the requested resource cannot be found or does not exist.
- Message
-
A message describing the resource not found error.
HTTP Status Code: 400
- ThrottlingException
-
Thrown when the request rate exceeds the allowed limits and the request is being throttled.
- Message
-
A message describing the throttling error.
HTTP Status Code: 400
- ValidationException
-
Thrown when the request contains invalid parameters or fails input validation requirements.
- FieldList
-
A list of fields that failed validation.
- Message
-
A message describing the validation error.
- Reason
-
The reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
