GetBenefitAllocation
Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
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 allocation to retrieve.
Type: String
Pattern:
(arn:.+|benalloc-[0-9a-z]{14})Required: Yes
Response Syntax
{
"ApplicableBenefitIds": [ "string" ],
"Arn": "string",
"BenefitApplicationId": "string",
"BenefitId": "string",
"Catalog": "string",
"CreatedAt": "string",
"Description": "string",
"ExpiresAt": "string",
"FulfillmentDetail": { ... },
"FulfillmentType": "string",
"Id": "string",
"Name": "string",
"StartsAt": "string",
"Status": "string",
"StatusReason": "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.
- ApplicableBenefitIds
-
A list of benefit identifiers that this allocation can be applied to.
Type: Array of strings
Pattern:
(arn:.+|ben-[0-9a-z]{14}) - Arn
-
The Amazon Resource Name (ARN) of the benefit allocation.
Type: String
Pattern:
(arn:.+benalloc-[0-9a-z]{14}) - BenefitApplicationId
-
The identifier of the benefit application that resulted in this allocation.
Type: String
Pattern:
benappl-[0-9a-z]{14} - BenefitId
-
The identifier of the benefit that this allocation is based on.
Type: String
Pattern:
(arn:.+|ben-[0-9a-z]{14}) - Catalog
-
The catalog identifier that the benefit allocation belongs to.
Type: String
Pattern:
[A-Za-z0-9_-]+ - CreatedAt
-
The timestamp when the benefit allocation was created.
Type: Timestamp
- Description
-
A detailed description of the benefit allocation.
Type: String
- ExpiresAt
-
The timestamp when the benefit allocation expires and is no longer usable.
Type: Timestamp
- FulfillmentDetail
-
Detailed information about how the benefit allocation is fulfilled.
Type: FulfillmentDetails object
Note: This object is a Union. Only one member of this object can be specified or returned.
- FulfillmentType
-
The fulfillment type used for this benefit allocation.
Type: String
Valid Values:
CREDITS | CASH | ACCESS - Id
-
The unique identifier of the benefit allocation.
Type: String
Pattern:
benalloc-[0-9a-z]{14} - Name
-
The human-readable name of the benefit allocation.
Type: String
- StartsAt
-
The timestamp when the benefit allocation becomes active and usable.
Type: Timestamp
- Status
-
The current status of the benefit allocation (e.g., active, expired, consumed).
Type: String
Valid Values:
ACTIVE | INACTIVE | FULFILLED - StatusReason
-
Additional information explaining the current status of the benefit allocation.
Type: String
- UpdatedAt
-
The timestamp when the benefit allocation 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
- 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:
