benefits

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

Overview

Name	benefits
Type	Resource
Id	aws.partnercentral_benefits.benefits

Fields

The following fields are returned by SELECT queries:

get_benefit

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the benefit.
benefit_request_schema	object	The schema definition that describes the required fields for requesting this benefit.
catalog	string	The catalog identifier that the benefit belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
description	string	A detailed description of the benefit and its purpose.
fulfillment_types	array	The available fulfillment types for this benefit (e.g., credits, access, disbursement).
id	string	The unique identifier of the benefit. (pattern: <code>ben-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit.
programs	array	The AWS partner programs that this benefit is associated with.
status	string	The current status of the benefit (e.g., active, inactive, deprecated). (ACTIVE, INACTIVE)

list_benefits

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the benefit.
catalog	string	The catalog identifier that the benefit belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
description	string	A brief description of the benefit and its purpose.
fulfillment_types	array	The available fulfillment types for this benefit.
id	string	The unique identifier of the benefit. (pattern: <code>ben-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit.
programs	array	The AWS partner programs that this benefit is associated with.
status	string	The current status of the benefit. (ACTIVE, INACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_benefit	select	region		Retrieves detailed information about a specific benefit available in the partner catalog.
list_benefits	select	region		Retrieves a paginated list of available benefits based on specified filter criteria.
cancel_benefit_application	exec	region, ClientToken, Identifier		Cancels a benefit application that is currently in progress, preventing further processing.
submit_benefit_application	exec	region, Identifier		Submits a benefit application for review and processing by AWS.

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

Retrieves detailed information about a specific benefit available in the partner catalog.

SELECT
arn,
benefit_request_schema,
catalog,
description,
fulfillment_types,
id,
name,
programs,
status
FROM aws.partnercentral_benefits.benefits
WHERE region = '{{ region }}' -- required
;

list_benefits

Retrieves a paginated list of available benefits based on specified filter criteria.

SELECT
arn,
catalog,
description,
fulfillment_types,
id,
name,
programs,
status
FROM aws.partnercentral_benefits.benefits
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

cancel_benefit_application

Cancels a benefit application that is currently in progress, preventing further processing.

EXEC aws.partnercentral_benefits.benefits.cancel_benefit_application 
@region='{{ region }}' --required 
@@json=
'{
"Catalog": "{{ Catalog }}", 
"ClientToken": "{{ ClientToken }}", 
"Identifier": "{{ Identifier }}", 
"Reason": "{{ Reason }}"
}'
;

submit_benefit_application

Submits a benefit application for review and processing by AWS.

EXEC aws.partnercentral_benefits.benefits.submit_benefit_application 
@region='{{ region }}' --required 
@@json=
'{
"Catalog": "{{ Catalog }}", 
"Identifier": "{{ Identifier }}"
}'
;