GetBenefitApplication
Retrieves detailed information about a specific benefit application.
Request Syntax
{
"Catalog": "string",
"Identifier": "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.
- Catalog
-
The catalog identifier that specifies which benefit catalog to query.
Type: String
Pattern:
[A-Za-z0-9_-]+Required: Yes
- Identifier
-
The unique identifier of the benefit application to retrieve.
Type: String
Pattern:
(arn:.+|benappl-[0-9a-z]{14})Required: Yes
Response Syntax
{
"Arn": "string",
"AssociatedResources": [ "string" ],
"BenefitApplicationDetails": JSON value,
"BenefitId": "string",
"Catalog": "string",
"CreatedAt": "string",
"Description": "string",
"FileDetails": [
{
"BusinessUseCase": "string",
"CreatedAt": "string",
"CreatedBy": "string",
"FileName": "string",
"FileStatus": "string",
"FileStatusReason": "string",
"FileType": "string",
"FileURI": "string"
}
],
"FulfillmentTypes": [ "string" ],
"Id": "string",
"Name": "string",
"PartnerContacts": [
{
"BusinessTitle": "string",
"Email": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string"
}
],
"Programs": [ "string" ],
"Revision": "string",
"Stage": "string",
"Status": "string",
"StatusReason": "string",
"StatusReasonCode": "string",
"StatusReasonCodes": [ "string" ],
"UpdatedAt": "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 benefit application.
Type: String
Pattern:
arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+) - 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})?:(.+) - BenefitApplicationDetails
-
Detailed information and requirements specific to the benefit being requested.
Type: JSON value
- BenefitId
-
The identifier of the benefit being requested in this application.
Type: String
Pattern:
(arn:.+|ben-[0-9a-z]{14}) - Catalog
-
The catalog identifier that the benefit application belongs to.
Type: String
Pattern:
[A-Za-z0-9_-]+ - CreatedAt
-
The timestamp when the benefit application was created.
Type: Timestamp
- Description
-
A detailed description of the benefit application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
- FileDetails
-
Supporting documents and files attached to the benefit application.
Type: Array of FileDetail objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
- FulfillmentTypes
-
The fulfillment types requested for this benefit application.
Type: Array of strings
Valid Values:
CREDITS | CASH | ACCESS - Id
-
The unique identifier of the benefit application.
Type: String
Pattern:
benappl-[0-9a-z]{14} - Name
-
The human-readable name of the benefit application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- PartnerContacts
-
Contact information for partner representatives responsible for this benefit application.
Type: Array of Contact objects
- Programs
-
The AWS partner programs associated with this benefit application.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z0-9_-]+ - Revision
-
The current revision number of the benefit application.
Type: String
- Stage
-
The current stage in the benefit application processing workflow.
Type: String
- Status
-
The current processing status of the benefit application.
Type: String
Valid Values:
PENDING_SUBMISSION | IN_REVIEW | ACTION_REQUIRED | APPROVED | REJECTED | CANCELED - StatusReason
-
Additional information explaining the current status of the benefit application.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
- StatusReasonCode
-
This parameter has been deprecated.
A standardized code representing the reason for the current status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- StatusReasonCodes
-
The list of standardized codes representing the reason for the current status.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
- UpdatedAt
-
The timestamp when the benefit application was last updated.
Type: Timestamp
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:
