CreateBenefitApplication
Creates a new benefit application for a partner to request access to AWS benefits and programs.
Request Syntax
{
"AssociatedResources": [ "string" ],
"BenefitApplicationDetails": JSON value,
"BenefitIdentifier": "string",
"Catalog": "string",
"ClientToken": "string",
"Description": "string",
"FileDetails": [
{
"BusinessUseCase": "string",
"FileURI": "string"
}
],
"FulfillmentTypes": [ "string" ],
"Name": "string",
"PartnerContacts": [
{
"BusinessTitle": "string",
"Email": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "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.
- BenefitIdentifier
-
The unique identifier of the benefit being requested in this application.
Type: String
Pattern:
(arn:.+|ben-[0-9a-z]{14})Required: Yes
- Catalog
-
The catalog identifier that specifies which benefit catalog to create the application in.
Type: String
Pattern:
[A-Za-z0-9_-]+Required: Yes
- ClientToken
-
A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[!-~]{1,64}Required: Yes
- AssociatedResources
-
AWS resources that are associated with this benefit application.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Pattern:
arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)Required: No
- BenefitApplicationDetails
-
Detailed information and requirements specific to the benefit being requested. To retrieve the detailed specifications for any benefit, make a
GetBenefitAPI call using the benefit identifier.Type: JSON value
Required: No
- Description
-
A detailed description of the benefit application and its intended use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- FileDetails
-
Supporting documents and files attached to the benefit application.
Type: Array of FileInput objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Required: No
- FulfillmentTypes
-
The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
Type: Array of strings
Valid Values:
CREDITS | CASH | ACCESSRequired: No
- Name
-
A human-readable name for the benefit application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- PartnerContacts
-
Contact information for partner representatives responsible for this benefit application.
Type: Array of Contact objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
- Tags
-
Key-value pairs to categorize and organize the benefit application.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"Arn": "string",
"Id": "string",
"Revision": "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.
- Arn
-
The Amazon Resource Name (ARN) of the newly created benefit application.
Type: String
- Id
-
The unique identifier assigned to the newly created benefit application.
Type: String
Pattern:
benappl-[0-9a-z]{14} - Revision
-
The initial revision number of the newly created benefit application.
Type: String
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:
