2025/12/01 - Partner Central Benefits API - 17 new api methods
Changes Initial GA launch of Partner Central Benefits
Cancels a benefit application that is currently in progress, preventing further processing.
See also: AWS API Documentation
Request Syntax
client.cancel_benefit_application(
Catalog='string',
ClientToken='string',
Identifier='string',
Reason='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.
string
[REQUIRED]
The unique identifier of the benefit application to cancel.
string
A descriptive reason explaining why the benefit application is being cancelled.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
See also: AWS API Documentation
Request Syntax
client.get_benefit_allocation(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog to query.
string
[REQUIRED]
The unique identifier of the benefit allocation to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Catalog': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'INACTIVE'|'FULFILLED',
'StatusReason': 'string',
'BenefitApplicationId': 'string',
'BenefitId': 'string',
'FulfillmentType': 'CREDITS'|'CASH'|'ACCESS',
'ApplicableBenefitIds': [
'string',
],
'FulfillmentDetail': {
'DisbursementDetails': {
'DisbursedAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'IssuanceDetails': {
'IssuanceId': 'string',
'IssuanceAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'IssuedAt': datetime(2015, 1, 1)
}
},
'ConsumableDetails': {
'AllocatedAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'RemainingAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'UtilizedAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'IssuanceDetails': {
'IssuanceId': 'string',
'IssuanceAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'IssuedAt': datetime(2015, 1, 1)
}
},
'CreditDetails': {
'AllocatedAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'IssuedAmount': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'Codes': [
{
'AwsAccountId': 'string',
'Value': {
'Amount': 'string',
'CurrencyCode': 'AED'|'AMD'|'ARS'|'AUD'|'AWG'|'AZN'|'BBD'|'BDT'|'BGN'|'BMD'|'BND'|'BOB'|'BRL'|'BSD'|'BYR'|'BZD'|'CAD'|'CHF'|'CLP'|'CNY'|'COP'|'CRC'|'CZK'|'DKK'|'DOP'|'EEK'|'EGP'|'EUR'|'GBP'|'GEL'|'GHS'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'INR'|'ISK'|'JMD'|'JPY'|'KES'|'KHR'|'KRW'|'KYD'|'KZT'|'LBP'|'LKR'|'LTL'|'LVL'|'MAD'|'MNT'|'MOP'|'MUR'|'MVR'|'MXN'|'MYR'|'NAD'|'NGN'|'NIO'|'NOK'|'NZD'|'PAB'|'PEN'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RUB'|'SAR'|'SEK'|'SGD'|'SIT'|'SKK'|'THB'|'TND'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'USD'|'UYU'|'UZS'|'VND'|'XAF'|'XCD'|'XOF'|'XPF'|'ZAR'
},
'AwsCreditCode': 'string',
'Status': 'ACTIVE'|'INACTIVE'|'FULFILLED',
'IssuedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1)
},
]
},
'AccessDetails': {
'Description': 'string'
}
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'StartsAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the benefit allocation.
Catalog (string) --
The catalog identifier that the benefit allocation belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit allocation.
Name (string) --
The human-readable name of the benefit allocation.
Description (string) --
A detailed description of the benefit allocation.
Status (string) --
The current status of the benefit allocation (e.g., active, expired, consumed).
StatusReason (string) --
Additional information explaining the current status of the benefit allocation.
BenefitApplicationId (string) --
The identifier of the benefit application that resulted in this allocation.
BenefitId (string) --
The identifier of the benefit that this allocation is based on.
FulfillmentType (string) --
The fulfillment type used for this benefit allocation.
ApplicableBenefitIds (list) --
A list of benefit identifiers that this allocation can be applied to.
(string) --
FulfillmentDetail (dict) --
Detailed information about how the benefit allocation is fulfilled.
DisbursementDetails (dict) --
Details about disbursement-based fulfillment, if applicable to this benefit allocation.
DisbursedAmount (dict) --
The total amount that has been disbursed for this benefit allocation.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
IssuanceDetails (dict) --
Detailed information about how the disbursement was issued and processed.
IssuanceId (string) --
The unique identifier for this specific issuance.
IssuanceAmount (dict) --
The monetary amount or value that was issued in this specific issuance.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
IssuedAt (datetime) --
The timestamp when this specific issuance was processed.
ConsumableDetails (dict) --
Details about consumable-based fulfillment, if applicable to this benefit allocation.
AllocatedAmount (dict) --
The total amount of the consumable benefit that has been allocated.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
RemainingAmount (dict) --
The remaining amount of the consumable benefit that is still available for use.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
UtilizedAmount (dict) --
The amount of the consumable benefit that has already been used.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
IssuanceDetails (dict) --
Detailed information about how the consumable benefit was issued and distributed.
IssuanceId (string) --
The unique identifier for this specific issuance.
IssuanceAmount (dict) --
The monetary amount or value that was issued in this specific issuance.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
IssuedAt (datetime) --
The timestamp when this specific issuance was processed.
CreditDetails (dict) --
Details about credit-based fulfillment, if applicable to this benefit allocation.
AllocatedAmount (dict) --
The total amount of credits that have been allocated for this benefit.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
IssuedAmount (dict) --
The amount of credits that have actually been issued and are available for use.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Codes (list) --
A list of credit codes that have been generated for this benefit allocation.
(dict) --
Represents an AWS credit code that can be applied to an AWS account for billing purposes.
AwsAccountId (string) --
The AWS account ID that the credit code is associated with or can be applied to.
Value (dict) --
The monetary value of the credit code.
Amount (string) --
The numeric amount of the monetary value.
CurrencyCode (string) --
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
AwsCreditCode (string) --
The actual credit code string that can be redeemed in the AWS billing console.
Status (string) --
The current status of the credit code (e.g., active, redeemed, expired).
IssuedAt (datetime) --
The timestamp when the credit code was issued.
ExpiresAt (datetime) --
The timestamp when the credit code expires and can no longer be redeemed.
AccessDetails (dict) --
Details about access-based fulfillment, if applicable to this benefit allocation.
Description (string) --
A description of the access privileges or permissions granted by this benefit.
CreatedAt (datetime) --
The timestamp when the benefit allocation was created.
UpdatedAt (datetime) --
The timestamp when the benefit allocation was last updated.
StartsAt (datetime) --
The timestamp when the benefit allocation becomes active and usable.
ExpiresAt (datetime) --
The timestamp when the benefit allocation expires and is no longer usable.
Retrieves a paginated list of benefit allocations based on specified filter criteria.
See also: AWS API Documentation
Request Syntax
client.list_benefit_allocations(
Catalog='string',
FulfillmentTypes=[
'CREDITS'|'CASH'|'ACCESS',
],
BenefitIdentifiers=[
'string',
],
BenefitApplicationIdentifiers=[
'string',
],
Status=[
'ACTIVE'|'INACTIVE'|'FULFILLED',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog identifier to filter benefit allocations by catalog.
list
Filter benefit allocations by specific fulfillment types.
(string) --
list
Filter benefit allocations by specific benefit identifiers.
(string) --
list
Filter benefit allocations by specific benefit application identifiers.
(string) --
list
Filter benefit allocations by their current status.
(string) --
integer
The maximum number of benefit allocations to return in a single response.
string
A pagination token to retrieve the next set of results from a previous request.
dict
Response Syntax
{
'BenefitAllocationSummaries': [
{
'Id': 'string',
'Catalog': 'string',
'Arn': 'string',
'Status': 'ACTIVE'|'INACTIVE'|'FULFILLED',
'StatusReason': 'string',
'Name': 'string',
'BenefitId': 'string',
'BenefitApplicationId': 'string',
'FulfillmentTypes': [
'CREDITS'|'CASH'|'ACCESS',
],
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'ApplicableBenefitIds': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BenefitAllocationSummaries (list) --
A list of benefit allocation summaries matching the specified criteria.
(dict) --
A summary view of a benefit allocation containing key information for list operations.
Id (string) --
The unique identifier of the benefit allocation.
Catalog (string) --
The catalog identifier that the benefit allocation belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit allocation.
Status (string) --
The current status of the benefit allocation.
StatusReason (string) --
Additional information explaining the current status of the benefit allocation.
Name (string) --
The human-readable name of the benefit allocation.
BenefitId (string) --
The identifier of the benefit that this allocation is based on.
BenefitApplicationId (string) --
The identifier of the benefit application that resulted in this allocation.
FulfillmentTypes (list) --
The fulfillment types used for this benefit allocation.
(string) --
CreatedAt (datetime) --
The timestamp when the benefit allocation was created.
ExpiresAt (datetime) --
The timestamp when the benefit allocation expires.
ApplicableBenefitIds (list) --
The identifiers of the benefits applicable for this allocation.
(string) --
NextToken (string) --
A pagination token to retrieve the next set of results, if more results are available.
Adds or updates tags for a specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to add tags to.
list
[REQUIRED]
A list of key-value pairs to add as tags to the resource.
(dict) --
Represents a key-value pair used for categorizing and organizing AWS resources.
Key (string) -- [REQUIRED]
The tag key, which acts as a category or label for the tag.
Value (string) -- [REQUIRED]
The tag value, which provides additional information or context for the tag key.
dict
Response Syntax
{}
Response Structure
(dict) --
Submits a benefit application for review and processing by AWS.
See also: AWS API Documentation
Request Syntax
client.submit_benefit_application(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
The unique identifier of the benefit application to submit.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove tags from.
list
[REQUIRED]
A list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves detailed information about a specific benefit available in the partner catalog.
See also: AWS API Documentation
Request Syntax
client.get_benefit(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog to query.
string
[REQUIRED]
The unique identifier of the benefit to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Catalog': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Programs': [
'string',
],
'FulfillmentTypes': [
'CREDITS'|'CASH'|'ACCESS',
],
'BenefitRequestSchema': {...}|[...]|123|123.4|'string'|True|None,
'Status': 'ACTIVE'|'INACTIVE'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the benefit.
Catalog (string) --
The catalog identifier that the benefit belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit.
Name (string) --
The human-readable name of the benefit.
Description (string) --
A detailed description of the benefit and its purpose.
Programs (list) --
The AWS partner programs that this benefit is associated with.
(string) --
FulfillmentTypes (list) --
The available fulfillment types for this benefit (e.g., credits, access, disbursement).
(string) --
BenefitRequestSchema (:ref:`document<document>`) --
The schema definition that describes the required fields for requesting this benefit.
Status (string) --
The current status of the benefit (e.g., active, inactive, deprecated).
Updates an existing benefit application with new information while maintaining revision control.
See also: AWS API Documentation
Request Syntax
client.update_benefit_application(
Catalog='string',
ClientToken='string',
Name='string',
Description='string',
Identifier='string',
Revision='string',
BenefitApplicationDetails={...}|[...]|123|123.4|'string'|True|None,
PartnerContacts=[
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
FileDetails=[
{
'FileURI': 'string',
'BusinessUseCase': 'string'
},
]
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
A unique, case-sensitive identifier to ensure idempotent processing of the update request.
string
The updated human-readable name for the benefit application.
string
The updated detailed description of the benefit application.
string
[REQUIRED]
The unique identifier of the benefit application to update.
string
[REQUIRED]
The current revision number of the benefit application to ensure optimistic concurrency control.
:ref:`document<document>`
Updated detailed information and requirements specific to the benefit being requested.
list
Updated contact information for partner representatives responsible for this benefit application.
(dict) --
Represents contact information for a partner representative.
Email (string) --
The email address of the contact person.
FirstName (string) --
The first name of the contact person.
LastName (string) --
The last name of the contact person.
BusinessTitle (string) --
The business title or role of the contact person within the organization.
Phone (string) --
The phone number of the contact person.
list
Updated supporting documents and files attached to the benefit application.
(dict) --
Represents input information for uploading a file to a benefit application.
FileURI (string) -- [REQUIRED]
The URI or location where the file should be stored or has been uploaded.
BusinessUseCase (string) --
The business purpose or use case that this file supports in the benefit application.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the updated benefit application.
Arn (string) --
The Amazon Resource Name (ARN) of the updated benefit application.
Revision (string) --
The new revision number of the benefit application after the update.
Recalls a submitted benefit application, returning it to draft status for further modifications.
See also: AWS API Documentation
Request Syntax
client.recall_benefit_application(
Catalog='string',
ClientToken='string',
Identifier='string',
Reason='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
A unique, case-sensitive identifier to ensure idempotent processing of the recall request.
string
[REQUIRED]
The unique identifier of the benefit application to recall.
string
[REQUIRED]
A descriptive reason explaining why the benefit application is being recalled.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a paginated list of benefit applications based on specified filter criteria.
See also: AWS API Documentation
Request Syntax
client.list_benefit_applications(
Catalog='string',
Programs=[
'string',
],
FulfillmentTypes=[
'CREDITS'|'CASH'|'ACCESS',
],
BenefitIdentifiers=[
'string',
],
Status=[
'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
],
Stages=[
'string',
],
AssociatedResources=[
{
'ResourceType': 'OPPORTUNITY'|'BENEFIT_ALLOCATION',
'ResourceIdentifier': 'string',
'ResourceArn': 'string'
},
],
AssociatedResourceArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog identifier to filter benefit applications by catalog.
list
Filter benefit applications by specific AWS partner programs.
(string) --
list
Filter benefit applications by specific fulfillment types.
(string) --
list
Filter benefit applications by specific benefit identifiers.
(string) --
list
Filter benefit applications by their current processing status.
(string) --
list
Filter benefit applications by their current processing stage.
(string) --
list
Filter benefit applications by associated AWS resources.
(dict) --
Represents an AWS resource that is associated with a benefit application for tracking and management.
ResourceType (string) --
The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).
ResourceIdentifier (string) --
The unique identifier of the AWS resource within its service.
ResourceArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.
list
Filter benefit applications by specific AWS resource ARNs.
(string) --
integer
The maximum number of benefit applications to return in a single response.
string
A pagination token to retrieve the next set of results from a previous request.
dict
Response Syntax
{
'BenefitApplicationSummaries': [
{
'Catalog': 'string',
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'BenefitId': 'string',
'Programs': [
'string',
],
'FulfillmentTypes': [
'CREDITS'|'CASH'|'ACCESS',
],
'Status': 'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
'Stage': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'BenefitApplicationDetails': {
'string': 'string'
},
'AssociatedResources': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BenefitApplicationSummaries (list) --
A list of benefit application summaries matching the specified criteria.
(dict) --
A summary view of a benefit application containing key information for list operations.
Catalog (string) --
The catalog identifier that the benefit application belongs to.
Name (string) --
The human-readable name of the benefit application.
Id (string) --
The unique identifier of the benefit application.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit application.
BenefitId (string) --
The identifier of the benefit being requested in this application.
Programs (list) --
The AWS partner programs associated with this benefit application.
(string) --
FulfillmentTypes (list) --
The fulfillment types requested for this benefit application.
(string) --
Status (string) --
The current processing status of the benefit application.
Stage (string) --
The current stage in the benefit application processing workflow..
CreatedAt (datetime) --
The timestamp when the benefit application was created.
UpdatedAt (datetime) --
The timestamp when the benefit application was last updated.
BenefitApplicationDetails (dict) --
Additional attributes and metadata associated with the benefit application.
(string) --
(string) --
AssociatedResources (list) --
AWS resources that are associated with this benefit application.
(string) --
NextToken (string) --
A pagination token to retrieve the next set of results, if more results are available.
Creates a new benefit application for a partner to request access to AWS benefits and programs.
See also: AWS API Documentation
Request Syntax
client.create_benefit_application(
Catalog='string',
ClientToken='string',
Name='string',
Description='string',
BenefitIdentifier='string',
FulfillmentTypes=[
'CREDITS'|'CASH'|'ACCESS',
],
BenefitApplicationDetails={...}|[...]|123|123.4|'string'|True|None,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AssociatedResources=[
'string',
],
PartnerContacts=[
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
FileDetails=[
{
'FileURI': 'string',
'BusinessUseCase': 'string'
},
]
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog to create the application in.
string
[REQUIRED]
A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
string
A human-readable name for the benefit application.
string
A detailed description of the benefit application and its intended use.
string
[REQUIRED]
The unique identifier of the benefit being requested in this application.
list
The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
(string) --
:ref:`document<document>`
Detailed information and requirements specific to the benefit being requested.
list
Key-value pairs to categorize and organize the benefit application.
(dict) --
Represents a key-value pair used for categorizing and organizing AWS resources.
Key (string) -- [REQUIRED]
The tag key, which acts as a category or label for the tag.
Value (string) -- [REQUIRED]
The tag value, which provides additional information or context for the tag key.
list
AWS resources that are associated with this benefit application.
(string) --
list
Contact information for partner representatives responsible for this benefit application.
(dict) --
Represents contact information for a partner representative.
Email (string) --
The email address of the contact person.
FirstName (string) --
The first name of the contact person.
LastName (string) --
The last name of the contact person.
BusinessTitle (string) --
The business title or role of the contact person within the organization.
Phone (string) --
The phone number of the contact person.
list
Supporting documents and files attached to the benefit application.
(dict) --
Represents input information for uploading a file to a benefit application.
FileURI (string) -- [REQUIRED]
The URI or location where the file should be stored or has been uploaded.
BusinessUseCase (string) --
The business purpose or use case that this file supports in the benefit application.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier assigned to the newly created benefit application.
Arn (string) --
The Amazon Resource Name (ARN) of the newly created benefit application.
Revision (string) --
The initial revision number of the newly created benefit application.
Retrieves a paginated list of available benefits based on specified filter criteria.
See also: AWS API Documentation
Request Syntax
client.list_benefits(
Catalog='string',
Programs=[
'string',
],
FulfillmentTypes=[
'CREDITS'|'CASH'|'ACCESS',
],
Status=[
'ACTIVE'|'INACTIVE',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog identifier to filter benefits by catalog.
list
Filter benefits by specific AWS partner programs.
(string) --
list
Filter benefits by specific fulfillment types.
(string) --
list
Filter benefits by their current status.
(string) --
integer
The maximum number of benefits to return in a single response.
string
A pagination token to retrieve the next set of results from a previous request.
dict
Response Syntax
{
'BenefitSummaries': [
{
'Id': 'string',
'Catalog': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Programs': [
'string',
],
'FulfillmentTypes': [
'CREDITS'|'CASH'|'ACCESS',
],
'Status': 'ACTIVE'|'INACTIVE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BenefitSummaries (list) --
A list of benefit summaries matching the specified criteria.
(dict) --
A summary view of a benefit containing key information for list operations.
Id (string) --
The unique identifier of the benefit.
Catalog (string) --
The catalog identifier that the benefit belongs to.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit.
Name (string) --
The human-readable name of the benefit.
Description (string) --
A brief description of the benefit and its purpose.
Programs (list) --
The AWS partner programs that this benefit is associated with.
(string) --
FulfillmentTypes (list) --
The available fulfillment types for this benefit.
(string) --
Status (string) --
The current status of the benefit.
NextToken (string) --
A pagination token to retrieve the next set of results, if more results are available.
Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
See also: AWS API Documentation
Request Syntax
client.amend_benefit_application(
Catalog='string',
ClientToken='string',
Revision='string',
Identifier='string',
AmendmentReason='string',
Amendments=[
{
'FieldPath': 'string',
'NewValue': 'string'
},
]
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.
string
[REQUIRED]
The current revision number of the benefit application to ensure optimistic concurrency control.
string
[REQUIRED]
The unique identifier of the benefit application to be amended.
string
[REQUIRED]
A descriptive reason explaining why the benefit application is being amended.
list
[REQUIRED]
A list of specific field amendments to apply to the benefit application.
(dict) --
Represents a specific change to be made to a benefit application field.
FieldPath (string) -- [REQUIRED]
The JSON path or field identifier specifying which field in the benefit application to modify.
NewValue (string) -- [REQUIRED]
The new value to set for the specified field in the benefit application.
dict
Response Syntax
{}
Response Structure
(dict) --
Links an AWS resource to an existing benefit application for tracking and management purposes.
See also: AWS API Documentation
Request Syntax
client.associate_benefit_application_resource(
Catalog='string',
BenefitApplicationIdentifier='string',
ResourceArn='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
The unique identifier of the benefit application to associate the resource with.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the benefit application after the resource association.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit application after the resource association.
Revision (string) --
The updated revision number of the benefit application after the resource association.
Removes the association between an AWS resource and a benefit application.
See also: AWS API Documentation
Request Syntax
client.disassociate_benefit_application_resource(
Catalog='string',
BenefitApplicationIdentifier='string',
ResourceArn='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog the application belongs to.
string
[REQUIRED]
The unique identifier of the benefit application to disassociate the resource from.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Revision': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the benefit application after the resource disassociation.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.
Revision (string) --
The updated revision number of the benefit application after the resource disassociation.
Retrieves all tags associated with a specific resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to list tags for.
dict
Response Syntax
{
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
tags (list) --
A list of key-value pairs representing the tags associated with the resource.
(dict) --
Represents a key-value pair used for categorizing and organizing AWS resources.
Key (string) --
The tag key, which acts as a category or label for the tag.
Value (string) --
The tag value, which provides additional information or context for the tag key.
Retrieves detailed information about a specific benefit application.
See also: AWS API Documentation
Request Syntax
client.get_benefit_application(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
The catalog identifier that specifies which benefit catalog to query.
string
[REQUIRED]
The unique identifier of the benefit application to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Catalog': 'string',
'BenefitId': 'string',
'Name': 'string',
'Description': 'string',
'FulfillmentTypes': [
'CREDITS'|'CASH'|'ACCESS',
],
'BenefitApplicationDetails': {...}|[...]|123|123.4|'string'|True|None,
'Programs': [
'string',
],
'Status': 'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
'Stage': 'string',
'StatusReason': 'string',
'StatusReasonCode': 'string',
'StatusReasonCodes': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Revision': 'string',
'AssociatedResources': [
'string',
],
'PartnerContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'FileDetails': [
{
'FileURI': 'string',
'BusinessUseCase': 'string',
'FileName': 'string',
'FileStatus': 'string',
'FileStatusReason': 'string',
'FileType': 'application/msword'|'application/vnd.openxmlformats-officedocument.wordprocessingml.document'|'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'|'application/vnd.openxmlformats-officedocument.presentationml.presentation'|'application/pdf'|'image/png'|'image/jpeg'|'image/svg+xml'|'text/csv',
'CreatedBy': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the benefit application.
Arn (string) --
The Amazon Resource Name (ARN) of the benefit application.
Catalog (string) --
The catalog identifier that the benefit application belongs to.
BenefitId (string) --
The identifier of the benefit being requested in this application.
Name (string) --
The human-readable name of the benefit application.
Description (string) --
A detailed description of the benefit application.
FulfillmentTypes (list) --
The fulfillment types requested for this benefit application.
(string) --
BenefitApplicationDetails (:ref:`document<document>`) --
Detailed information and requirements specific to the benefit being requested.
Programs (list) --
The AWS partner programs associated with this benefit application.
(string) --
Status (string) --
The current processing status of the benefit application.
Stage (string) --
The current stage in the benefit application processing workflow.
StatusReason (string) --
Additional information explaining the current status of the benefit application.
StatusReasonCode (string) --
A standardized code representing the reason for the current status.
StatusReasonCodes (list) --
The list of standardized codes representing the reason for the current status.
(string) --
CreatedAt (datetime) --
The timestamp when the benefit application was created.
UpdatedAt (datetime) --
The timestamp when the benefit application was last updated.
Revision (string) --
The current revision number of the benefit application.
AssociatedResources (list) --
AWS resources that are associated with this benefit application.
(string) --
PartnerContacts (list) --
Contact information for partner representatives responsible for this benefit application.
(dict) --
Represents contact information for a partner representative.
Email (string) --
The email address of the contact person.
FirstName (string) --
The first name of the contact person.
LastName (string) --
The last name of the contact person.
BusinessTitle (string) --
The business title or role of the contact person within the organization.
Phone (string) --
The phone number of the contact person.
FileDetails (list) --
Supporting documents and files attached to the benefit application.
(dict) --
Represents detailed information about a file attached to a benefit application.
FileURI (string) --
The URI or location where the file is stored.
BusinessUseCase (string) --
The business purpose or use case that this file supports in the benefit application.
FileName (string) --
The original name of the uploaded file.
FileStatus (string) --
The current processing status of the file (e.g., uploaded, processing, approved, rejected).
FileStatusReason (string) --
The reason for that particulat file status.
FileType (string) --
The type or category of the file (e.g., document, image, spreadsheet).
CreatedBy (string) --
The identifier of the user who uploaded the file.
CreatedAt (datetime) --
The timestamp when the file was uploaded.