Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBenefitAllocations

Retrieves a paginated list of benefit allocations based on specified filter criteria.

Request Syntax


{
   "BenefitApplicationIdentifiers": [ "string" ],
   "BenefitIdentifiers": [ "string" ],
   "Catalog": "string",
   "FulfillmentTypes": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Status": [ "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 to filter benefit allocations by catalog.

Type: String

Pattern: [A-Za-z0-9_-]+

Required: Yes

BenefitApplicationIdentifiers

Filter benefit allocations by specific benefit application identifiers.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Pattern: (arn:.+|benappl-[0-9a-z]{14})

Required: No

BenefitIdentifiers

Filter benefit allocations by specific benefit identifiers.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Pattern: (arn:.+|ben-[0-9a-z]{14})

Required: No

FulfillmentTypes

Filter benefit allocations by specific fulfillment types.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Valid Values: CREDITS | CASH | ACCESS

Required: No

MaxResults

The maximum number of benefit allocations to return in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A pagination token to retrieve the next set of results from a previous request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\s\S]*

Required: No

Status

Filter benefit allocations by their current status.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Valid Values: ACTIVE | INACTIVE | FULFILLED

Required: No

Response Syntax


{
   "BenefitAllocationSummaries": [ 
      { 
         "ApplicableBenefitIds": [ "string" ],
         "Arn": "string",
         "BenefitApplicationId": "string",
         "BenefitId": "string",
         "Catalog": "string",
         "CreatedAt": "string",
         "ExpiresAt": "string",
         "FulfillmentTypes": [ "string" ],
         "Id": "string",
         "Name": "string",
         "Status": "string",
         "StatusReason": "string"
      }
   ],
   "NextToken": "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.

BenefitAllocationSummaries

A list of benefit allocation summaries matching the specified criteria.

Type: Array of BenefitAllocationSummary objects

NextToken

A pagination token to retrieve the next set of results, if more results are available.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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