benefit_applications

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

Overview

Name	benefit_applications
Type	Resource
Id	aws.partnercentral_benefits.benefit_applications

Fields

The following fields are returned by SELECT queries:

get_benefit_application

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the benefit application. (pattern: <code>arn:aws:([a-zA-Z0-9-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)</code>)
associated_resources	array	AWS resources that are associated with this benefit application.
benefit_application_details	object	Detailed information and requirements specific to the benefit being requested.
benefit_id	string	The identifier of the benefit being requested in this application. (pattern: <code>(arn:.+|ben-[0-9a-z]{14})</code>)
catalog	string	The catalog identifier that the benefit application belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
created_at	string (date-time)	The timestamp when the benefit application was created.
description	string	A detailed description of the benefit application.
file_details	array	Supporting documents and files attached to the benefit application.
fulfillment_types	array	The fulfillment types requested for this benefit application.
id	string	The unique identifier of the benefit application. (pattern: <code>benappl-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit application.
partner_contacts	array	Contact information for partner representatives responsible for this benefit application.
programs	array	The AWS partner programs associated with this benefit application.
revision	string	The current revision number of the benefit application.
stage	string	The current stage in the benefit application processing workflow.
status	string	The current processing status of the benefit application. (PENDING_SUBMISSION, IN_REVIEW, ACTION_REQUIRED, APPROVED, REJECTED, CANCELED)
status_reason	string	Additional information explaining the current status of the benefit application.
status_reason_code	string	A standardized code representing the reason for the current status.
status_reason_codes	array	The list of standardized codes representing the reason for the current status.
updated_at	string (date-time)	The timestamp when the benefit application was last updated.

list_benefit_applications

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the benefit application.
associated_resources	array	AWS resources that are associated with this benefit application.
benefit_application_details	object	Additional attributes and metadata associated with the benefit application.
benefit_id	string	The identifier of the benefit being requested in this application. (pattern: <code>(arn:.+|ben-[0-9a-z]{14})</code>)
catalog	string	The catalog identifier that the benefit application belongs to. (pattern: <code>[A-Za-z0-9_-]+</code>)
created_at	string (date-time)	The timestamp when the benefit application was created.
fulfillment_types	array	The fulfillment types requested for this benefit application.
id	string	The unique identifier of the benefit application. (pattern: <code>benappl-[0-9a-z]{14}</code>)
name	string	The human-readable name of the benefit application.
programs	array	The AWS partner programs associated with this benefit application.
stage	string	The current stage in the benefit application processing workflow..
status	string	The current processing status of the benefit application. (PENDING_SUBMISSION, IN_REVIEW, ACTION_REQUIRED, APPROVED, REJECTED, CANCELED)
updated_at	string (date-time)	The timestamp when the benefit application was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_benefit_application	select	region		Retrieves detailed information about a specific benefit application.
list_benefit_applications	select	region		Retrieves a paginated list of benefit applications based on specified filter criteria.
create_benefit_application	insert	region, ClientToken, BenefitIdentifier		Creates a new benefit application for a partner to request access to AWS benefits and programs.
associate_benefit_application_resource	update	region, BenefitApplicationIdentifier, ResourceArn		Links an AWS resource to an existing benefit application for tracking and management purposes.
update_benefit_application	update	region, ClientToken, Identifier		Updates an existing benefit application with new information while maintaining revision control.
disassociate_benefit_application_resource	exec	region, BenefitApplicationIdentifier, ResourceArn		Removes the association between an AWS resource and a benefit application.

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_application

Retrieves detailed information about a specific benefit application.

SELECT
arn,
associated_resources,
benefit_application_details,
benefit_id,
catalog,
created_at,
description,
file_details,
fulfillment_types,
id,
name,
partner_contacts,
programs,
revision,
stage,
status,
status_reason,
status_reason_code,
status_reason_codes,
updated_at
FROM aws.partnercentral_benefits.benefit_applications
WHERE region = '{{ region }}' -- required
;

list_benefit_applications

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

SELECT
arn,
associated_resources,
benefit_application_details,
benefit_id,
catalog,
created_at,
fulfillment_types,
id,
name,
programs,
stage,
status,
updated_at
FROM aws.partnercentral_benefits.benefit_applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_benefit_application

Creates a new benefit application for a partner to request access to AWS benefits and programs.

INSERT INTO aws.partnercentral_benefits.benefit_applications (
Catalog,
ClientToken,
Name,
Description,
BenefitIdentifier,
FulfillmentTypes,
BenefitApplicationDetails,
Tags,
AssociatedResources,
PartnerContacts,
FileDetails,
region
)
SELECT 
'{{ Catalog }}',
'{{ ClientToken }}' /* required */,
'{{ Name }}',
'{{ Description }}',
'{{ BenefitIdentifier }}' /* required */,
'{{ FulfillmentTypes }}',
'{{ BenefitApplicationDetails }}',
'{{ Tags }}',
'{{ AssociatedResources }}',
'{{ PartnerContacts }}',
'{{ FileDetails }}',
'{{ region }}'
RETURNING
arn,
id,
revision
;

Manifest

# Description fields are for documentation purposes
- name: benefit_applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the benefit_applications resource.
  - name: Catalog
    value: "{{ Catalog }}"
    description: |
      The catalog identifier that specifies which benefit catalog to create the application in.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
  - name: Name
    value: "{{ Name }}"
    description: |
      A human-readable name for the benefit application.
  - name: Description
    value: "{{ Description }}"
    description: |
      A detailed description of the benefit application and its intended use.
  - name: BenefitIdentifier
    value: "{{ BenefitIdentifier }}"
    description: |
      The unique identifier of the benefit being requested in this application.
  - name: FulfillmentTypes
    value:
      - "{{ FulfillmentTypes }}"
    description: |
      The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
  - name: BenefitApplicationDetails
    value: "{{ BenefitApplicationDetails }}"
    description: |
      Detailed information and requirements specific to the benefit being requested.
  - name: Tags
    description: |
      Key-value pairs to categorize and organize the benefit application.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: AssociatedResources
    value:
      - "{{ AssociatedResources }}"
    description: |
      AWS resources that are associated with this benefit application.
  - name: PartnerContacts
    description: |
      Contact information for partner representatives responsible for this benefit application.
    value:
      - Email: "{{ Email }}"
        FirstName: "{{ FirstName }}"
        LastName: "{{ LastName }}"
        BusinessTitle: "{{ BusinessTitle }}"
        Phone: "{{ Phone }}"
  - name: FileDetails
    description: |
      Supporting documents and files attached to the benefit application.
    value:
      - FileURI: "{{ FileURI }}"
        BusinessUseCase: "{{ BusinessUseCase }}"

UPDATE examples

associate_benefit_application_resource

Links an AWS resource to an existing benefit application for tracking and management purposes.

UPDATE aws.partnercentral_benefits.benefit_applications
SET 
Catalog = '{{ Catalog }}',
BenefitApplicationIdentifier = '{{ BenefitApplicationIdentifier }}',
ResourceArn = '{{ ResourceArn }}'
WHERE 
region = '{{ region }}' --required
AND BenefitApplicationIdentifier = '{{ BenefitApplicationIdentifier }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
RETURNING
arn,
id,
revision;

update_benefit_application

Updates an existing benefit application with new information while maintaining revision control.

UPDATE aws.partnercentral_benefits.benefit_applications
SET 
Catalog = '{{ Catalog }}',
ClientToken = '{{ ClientToken }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
Identifier = '{{ Identifier }}',
Revision = '{{ Revision }}',
BenefitApplicationDetails = '{{ BenefitApplicationDetails }}',
PartnerContacts = '{{ PartnerContacts }}',
FileDetails = '{{ FileDetails }}'
WHERE 
region = '{{ region }}' --required
AND ClientToken = '{{ ClientToken }}' --required
AND Identifier = '{{ Identifier }}' --required
RETURNING
arn,
id,
revision;

Lifecycle Methods

disassociate_benefit_application_resource

Removes the association between an AWS resource and a benefit application.

EXEC aws.partnercentral_benefits.benefit_applications.disassociate_benefit_application_resource 
@region='{{ region }}' --required 
@@json=
'{
"Catalog": "{{ Catalog }}", 
"BenefitApplicationIdentifier": "{{ BenefitApplicationIdentifier }}", 
"ResourceArn": "{{ ResourceArn }}"
}'
;