benefit_allocations

Creates, updates, deletes, gets or lists a benefit_allocations resource.

Overview

Name	benefit_allocations
Type	Resource
Id	aws.partnercentral_benefits.benefit_allocations

Fields

The following fields are returned by SELECT queries:

get_benefit_allocation

Name	Datatype	Description
applicable_benefit_ids	array	A list of benefit identifiers that this allocation can be applied to.
arn	string	The Amazon Resource Name (ARN) of the benefit allocation. (pattern: <code>(arn:.+benalloc-[0-9a-z]{14})</code>)
benefit_application_id	string	The identifier of the benefit application that resulted in this allocation. (pattern: <code>benappl-[0-9a-z]{14}</code>)
benefit_id	string	The identifier of the benefit that this allocation is based on. (pattern: <code>(arn:.+|ben-[0-9a-z]{14})</code>)
catalog	string	The catalog identifier that the benefit allocation belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
created_at	string (date-time)	The timestamp when the benefit allocation was created.
description	string	A detailed description of the benefit allocation.
expires_at	string (date-time)	The timestamp when the benefit allocation expires and is no longer usable.
fulfillment_detail	object	Detailed information about how the benefit allocation is fulfilled.
fulfillment_type	string	The fulfillment type used for this benefit allocation. (CREDITS, CASH, ACCESS)
id	string	The unique identifier of the benefit allocation. (pattern: <code>benalloc-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit allocation.
starts_at	string (date-time)	The timestamp when the benefit allocation becomes active and usable.
status	string	The current status of the benefit allocation (e.g., active, expired, consumed). (ACTIVE, INACTIVE, FULFILLED)
status_reason	string	Additional information explaining the current status of the benefit allocation.
updated_at	string (date-time)	The timestamp when the benefit allocation was last updated.

list_benefit_allocations

Name	Datatype	Description
applicable_benefit_ids	array	The identifiers of the benefits applicable for this allocation.
arn	string	The Amazon Resource Name (ARN) of the benefit allocation.
benefit_application_id	string	The identifier of the benefit application that resulted in this allocation. (pattern: <code>benappl-[0-9a-z]{14}</code>)
benefit_id	string	The identifier of the benefit that this allocation is based on. (pattern: <code>(arn:.+|ben-[0-9a-z]{14})</code>)
catalog	string	The catalog identifier that the benefit allocation belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
created_at	string (date-time)	The timestamp when the benefit allocation was created.
expires_at	string (date-time)	The timestamp when the benefit allocation expires.
fulfillment_types	array	The fulfillment types used for this benefit allocation.
id	string	The unique identifier of the benefit allocation. (pattern: <code>benalloc-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit allocation.
status	string	The current status of the benefit allocation. (ACTIVE, INACTIVE, FULFILLED)
status_reason	string	Additional information explaining the current status of the benefit allocation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_benefit_allocation	select	region		Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
list_benefit_allocations	select	region		Retrieves a paginated list of benefit allocations based on specified filter criteria.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_benefit_allocation

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

SELECT
applicable_benefit_ids,
arn,
benefit_application_id,
benefit_id,
catalog,
created_at,
description,
expires_at,
fulfillment_detail,
fulfillment_type,
id,
name,
starts_at,
status,
status_reason,
updated_at
FROM aws.partnercentral_benefits.benefit_allocations
WHERE region = '{{ region }}' -- required
;

list_benefit_allocations

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

SELECT
applicable_benefit_ids,
arn,
benefit_application_id,
benefit_id,
catalog,
created_at,
expires_at,
fulfillment_types,
id,
name,
status,
status_reason
FROM aws.partnercentral_benefits.benefit_allocations
WHERE region = '{{ region }}' -- required
;