BenefitAllocationSummary
A summary view of a benefit allocation containing key information for list operations.
Contents
Note
In the following list, the required parameters are described first.
- ApplicableBenefitIds
-
The identifiers of the benefits applicable for this allocation.
Type: Array of strings
Pattern:
(arn:.+|ben-[0-9a-z]{14})Required: No
- Arn
-
The Amazon Resource Name (ARN) of the benefit allocation.
Type: String
Required: No
- BenefitApplicationId
-
The identifier of the benefit application that resulted in this allocation.
Type: String
Pattern:
benappl-[0-9a-z]{14}Required: No
- BenefitId
-
The identifier of the benefit that this allocation is based on.
Type: String
Pattern:
(arn:.+|ben-[0-9a-z]{14})Required: No
- Catalog
-
The catalog identifier that the benefit allocation belongs to.
Type: String
Pattern:
[A-Za-z0-9_-]+Required: No
- CreatedAt
-
The timestamp when the benefit allocation was created.
Type: Timestamp
Required: No
- ExpiresAt
-
The timestamp when the benefit allocation expires.
Type: Timestamp
Required: No
- FulfillmentTypes
-
The fulfillment types used for this benefit allocation.
Type: Array of strings
Valid Values:
CREDITS | CASH | ACCESSRequired: No
- Id
-
The unique identifier of the benefit allocation.
Type: String
Pattern:
benalloc-[0-9a-z]{14}Required: No
- Name
-
The human-readable name of the benefit allocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- Status
-
The current status of the benefit allocation.
Type: String
Valid Values:
ACTIVE | INACTIVE | FULFILLEDRequired: No
- StatusReason
-
Additional information explaining the current status of the benefit allocation.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
