SDK for PHP V3

Partner Central Benefits API 2018-05-10

Client: Aws\PartnerCentralBenefits\PartnerCentralBenefitsClient
Service ID: partnercentral-benefits
Version: 2018-05-10

This page describes the parameters and results for the operations of the Partner Central Benefits API (2018-05-10), and shows how to use the Aws\PartnerCentralBenefits\PartnerCentralBenefitsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AmendBenefitApplication ( array $params = [] )
Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
AssociateBenefitApplicationResource ( array $params = [] )
Links an AWS resource to an existing benefit application for tracking and management purposes.
CancelBenefitApplication ( array $params = [] )
Cancels a benefit application that is currently in progress, preventing further processing.
CreateBenefitApplication ( array $params = [] )
Creates a new benefit application for a partner to request access to AWS benefits and programs.
DisassociateBenefitApplicationResource ( array $params = [] )
Removes the association between an AWS resource and a benefit application.
GetBenefit ( array $params = [] )
Retrieves detailed information about a specific benefit available in the partner catalog.
GetBenefitAllocation ( array $params = [] )
Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
GetBenefitApplication ( array $params = [] )
Retrieves detailed information about a specific benefit application.
ListBenefitAllocations ( array $params = [] )
Retrieves a paginated list of benefit allocations based on specified filter criteria.
ListBenefitApplications ( array $params = [] )
Retrieves a paginated list of benefit applications based on specified filter criteria.
ListBenefits ( array $params = [] )
Retrieves a paginated list of available benefits based on specified filter criteria.
ListTagsForResource ( array $params = [] )
Retrieves all tags associated with a specific resource.
RecallBenefitApplication ( array $params = [] )
Recalls a submitted benefit application, returning it to draft status for further modifications.
SubmitBenefitApplication ( array $params = [] )
Submits a benefit application for review and processing by AWS.
TagResource ( array $params = [] )
Adds or updates tags for a specified resource.
UntagResource ( array $params = [] )
Removes specified tags from a resource.
UpdateBenefitApplication ( array $params = [] )
Updates an existing benefit application with new information while maintaining revision control.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBenefitAllocations
ListBenefitApplications
ListBenefits

Operations

AmendBenefitApplication 

$result = $client->amendBenefitApplication([/* ... */]);
$promise = $client->amendBenefitApplicationAsync([/* ... */]);

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

Parameter Syntax

$result = $client->amendBenefitApplication([
    'AmendmentReason' => '<string>', // REQUIRED
    'Amendments' => [ // REQUIRED
        [
            'FieldPath' => '<string>', // REQUIRED
            'NewValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
    'Revision' => '<string>', // REQUIRED
]);

Parameter Details

Members
AmendmentReason
Required: Yes
Type: string

A descriptive reason explaining why the benefit application is being amended.

Amendments
Required: Yes
Type: Array of Amendment structures

A list of specific field amendments to apply to the benefit application.

Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ClientToken
Required: Yes
Type: string

A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to be amended.

Revision
Required: Yes
Type: string

The current revision number of the benefit application to ensure optimistic concurrency control.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

AssociateBenefitApplicationResource 

$result = $client->associateBenefitApplicationResource([/* ... */]);
$promise = $client->associateBenefitApplicationResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateBenefitApplicationResource([
    'BenefitApplicationIdentifier' => '<string>', // REQUIRED
    'Catalog' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
BenefitApplicationIdentifier
Required: Yes
Type: string

The unique identifier of the benefit application to associate the resource with.

Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Revision' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit application after the resource association.

Id
Type: string

The unique identifier of the benefit application after the resource association.

Revision
Type: string

The updated revision number of the benefit application after the resource association.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

CancelBenefitApplication 

$result = $client->cancelBenefitApplication([/* ... */]);
$promise = $client->cancelBenefitApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->cancelBenefitApplication([
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
    'Reason' => '<string>',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ClientToken
Required: Yes
Type: string

A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to cancel.

Reason
Type: string

A descriptive reason explaining why the benefit application is being cancelled.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

CreateBenefitApplication 

$result = $client->createBenefitApplication([/* ... */]);
$promise = $client->createBenefitApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createBenefitApplication([
    'AssociatedResources' => ['<string>', ...],
    'BenefitApplicationDetails' => [
    ],
    'BenefitIdentifier' => '<string>', // REQUIRED
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'FileDetails' => [
        [
            'BusinessUseCase' => '<string>',
            'FileURI' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FulfillmentTypes' => ['<string>', ...],
    'Name' => '<string>',
    'PartnerContacts' => [
        [
            'BusinessTitle' => '<string>',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Phone' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AssociatedResources
Type: Array of strings

AWS resources that are associated with this benefit application.

BenefitApplicationDetails
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Detailed information and requirements specific to the benefit being requested.

BenefitIdentifier
Required: Yes
Type: string

The unique identifier of the benefit being requested in this application.

Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog to create the application in.

ClientToken
Required: Yes
Type: string

A unique, case-sensitive identifier to ensure idempotent processing of the creation request.

Description
Type: string

A detailed description of the benefit application and its intended use.

FileDetails
Type: Array of FileInput structures

Supporting documents and files attached to the benefit application.

FulfillmentTypes
Type: Array of strings

The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

Name
Type: string

A human-readable name for the benefit application.

PartnerContacts
Type: Array of Contact structures

Contact information for partner representatives responsible for this benefit application.

Tags
Type: Array of Tag structures

Key-value pairs to categorize and organize the benefit application.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Revision' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the newly created benefit application.

Id
Type: string

The unique identifier assigned to the newly created benefit application.

Revision
Type: string

The initial revision number of the newly created benefit application.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

DisassociateBenefitApplicationResource 

$result = $client->disassociateBenefitApplicationResource([/* ... */]);
$promise = $client->disassociateBenefitApplicationResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateBenefitApplicationResource([
    'BenefitApplicationIdentifier' => '<string>', // REQUIRED
    'Catalog' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
BenefitApplicationIdentifier
Required: Yes
Type: string

The unique identifier of the benefit application to disassociate the resource from.

Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Revision' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.

Id
Type: string

The unique identifier of the benefit application after the resource disassociation.

Revision
Type: string

The updated revision number of the benefit application after the resource disassociation.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

GetBenefit 

$result = $client->getBenefit([/* ... */]);
$promise = $client->getBenefitAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getBenefit([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog to query.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit to retrieve.

Result Syntax

[
    'Arn' => '<string>',
    'BenefitRequestSchema' => [
    ],
    'Catalog' => '<string>',
    'Description' => '<string>',
    'FulfillmentTypes' => ['<string>', ...],
    'Id' => '<string>',
    'Name' => '<string>',
    'Programs' => ['<string>', ...],
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit.

BenefitRequestSchema
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The schema definition that describes the required fields for requesting this benefit.

Catalog
Type: string

The catalog identifier that the benefit belongs to.

Description
Type: string

A detailed description of the benefit and its purpose.

FulfillmentTypes
Type: Array of strings

The available fulfillment types for this benefit (e.g., credits, access, disbursement).

Id
Type: string

The unique identifier of the benefit.

Name
Type: string

The human-readable name of the benefit.

Programs
Type: Array of strings

The AWS partner programs that this benefit is associated with.

Status
Type: string

The current status of the benefit (e.g., active, inactive, deprecated).

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

GetBenefitAllocation 

$result = $client->getBenefitAllocation([/* ... */]);
$promise = $client->getBenefitAllocationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getBenefitAllocation([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog to query.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit allocation to retrieve.

Result Syntax

[
    'ApplicableBenefitIds' => ['<string>', ...],
    'Arn' => '<string>',
    'BenefitApplicationId' => '<string>',
    'BenefitId' => '<string>',
    'Catalog' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ExpiresAt' => <DateTime>,
    'FulfillmentDetail' => [
        'AccessDetails' => [
            'Description' => '<string>',
        ],
        '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',
            ],
            'IssuanceDetails' => [
                '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',
                ],
                'IssuanceId' => '<string>',
                'IssuedAt' => <DateTime>,
            ],
            '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',
            ],
        ],
        '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',
            ],
            'Codes' => [
                [
                    'AwsAccountId' => '<string>',
                    'AwsCreditCode' => '<string>',
                    'ExpiresAt' => <DateTime>,
                    'IssuedAt' => <DateTime>,
                    'Status' => 'ACTIVE|INACTIVE|FULFILLED',
                    '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',
                    ],
                ],
                // ...
            ],
            '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',
            ],
        ],
        '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' => [
                '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',
                ],
                'IssuanceId' => '<string>',
                'IssuedAt' => <DateTime>,
            ],
        ],
    ],
    'FulfillmentType' => 'CREDITS|CASH|ACCESS',
    'Id' => '<string>',
    'Name' => '<string>',
    'StartsAt' => <DateTime>,
    'Status' => 'ACTIVE|INACTIVE|FULFILLED',
    'StatusReason' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
ApplicableBenefitIds
Type: Array of strings

A list of benefit identifiers that this allocation can be applied to.

Arn
Type: string

The Amazon Resource Name (ARN) of the benefit allocation.

BenefitApplicationId
Type: string

The identifier of the benefit application that resulted in this allocation.

BenefitId
Type: string

The identifier of the benefit that this allocation is based on.

Catalog
Type: string

The catalog identifier that the benefit allocation belongs to.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation was created.

Description
Type: string

A detailed description of the benefit allocation.

ExpiresAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation expires and is no longer usable.

FulfillmentDetail
Type: FulfillmentDetails structure

Detailed information about how the benefit allocation is fulfilled.

FulfillmentType
Type: string

The fulfillment type used for this benefit allocation.

Id
Type: string

The unique identifier of the benefit allocation.

Name
Type: string

The human-readable name of the benefit allocation.

StartsAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation becomes active and usable.

Status
Type: string

The current status of the benefit allocation (e.g., active, expired, consumed).

StatusReason
Type: string

Additional information explaining the current status of the benefit allocation.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation was last updated.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

GetBenefitApplication 

$result = $client->getBenefitApplication([/* ... */]);
$promise = $client->getBenefitApplicationAsync([/* ... */]);

Retrieves detailed information about a specific benefit application.

Parameter Syntax

$result = $client->getBenefitApplication([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog to query.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to retrieve.

Result Syntax

[
    'Arn' => '<string>',
    'AssociatedResources' => ['<string>', ...],
    'BenefitApplicationDetails' => [
    ],
    'BenefitId' => '<string>',
    'Catalog' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'FileDetails' => [
        [
            'BusinessUseCase' => '<string>',
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<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',
            'FileURI' => '<string>',
        ],
        // ...
    ],
    'FulfillmentTypes' => ['<string>', ...],
    'Id' => '<string>',
    'Name' => '<string>',
    'PartnerContacts' => [
        [
            'BusinessTitle' => '<string>',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Phone' => '<string>',
        ],
        // ...
    ],
    'Programs' => ['<string>', ...],
    'Revision' => '<string>',
    'Stage' => '<string>',
    'Status' => 'PENDING_SUBMISSION|IN_REVIEW|ACTION_REQUIRED|APPROVED|REJECTED|CANCELED',
    'StatusReason' => '<string>',
    'StatusReasonCode' => '<string>',
    'StatusReasonCodes' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit application.

AssociatedResources
Type: Array of strings

AWS resources that are associated with this benefit application.

BenefitApplicationDetails
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Detailed information and requirements specific to the benefit being requested.

BenefitId
Type: string

The identifier of the benefit being requested in this application.

Catalog
Type: string

The catalog identifier that the benefit application belongs to.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit application was created.

Description
Type: string

A detailed description of the benefit application.

FileDetails
Type: Array of FileDetail structures

Supporting documents and files attached to the benefit application.

FulfillmentTypes
Type: Array of strings

The fulfillment types requested for this benefit application.

Id
Type: string

The unique identifier of the benefit application.

Name
Type: string

The human-readable name of the benefit application.

PartnerContacts
Type: Array of Contact structures

Contact information for partner representatives responsible for this benefit application.

Programs
Type: Array of strings

The AWS partner programs associated with this benefit application.

Revision
Type: string

The current revision number of the benefit application.

Stage
Type: string

The current stage in the benefit application processing workflow.

Status
Type: string

The current processing status of the benefit application.

StatusReason
Type: string

Additional information explaining the current status of the benefit application.

StatusReasonCode
Type: string

A standardized code representing the reason for the current status.

StatusReasonCodes
Type: Array of strings

The list of standardized codes representing the reason for the current status.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit application was last updated.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ListBenefitAllocations 

$result = $client->listBenefitAllocations([/* ... */]);
$promise = $client->listBenefitAllocationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBenefitAllocations([
    'BenefitApplicationIdentifiers' => ['<string>', ...],
    'BenefitIdentifiers' => ['<string>', ...],
    'Catalog' => '<string>', // REQUIRED
    'FulfillmentTypes' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => ['<string>', ...],
]);

Parameter Details

Members
BenefitApplicationIdentifiers
Type: Array of strings

Filter benefit allocations by specific benefit application identifiers.

BenefitIdentifiers
Type: Array of strings

Filter benefit allocations by specific benefit identifiers.

Catalog
Required: Yes
Type: string

The catalog identifier to filter benefit allocations by catalog.

FulfillmentTypes
Type: Array of strings

Filter benefit allocations by specific fulfillment types.

MaxResults
Type: int

The maximum number of benefit allocations to return in a single response.

NextToken
Type: string

A pagination token to retrieve the next set of results from a previous request.

Status
Type: Array of strings

Filter benefit allocations by their current status.

Result Syntax

[
    'BenefitAllocationSummaries' => [
        [
            'ApplicableBenefitIds' => ['<string>', ...],
            'Arn' => '<string>',
            'BenefitApplicationId' => '<string>',
            'BenefitId' => '<string>',
            'Catalog' => '<string>',
            'CreatedAt' => <DateTime>,
            'ExpiresAt' => <DateTime>,
            'FulfillmentTypes' => ['<string>', ...],
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'ACTIVE|INACTIVE|FULFILLED',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BenefitAllocationSummaries
Type: Array of BenefitAllocationSummary structures

A list of benefit allocation summaries matching the specified criteria.

NextToken
Type: string

A pagination token to retrieve the next set of results, if more results are available.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ListBenefitApplications 

$result = $client->listBenefitApplications([/* ... */]);
$promise = $client->listBenefitApplicationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBenefitApplications([
    'AssociatedResourceArns' => ['<string>', ...],
    'AssociatedResources' => [
        [
            'ResourceArn' => '<string>',
            'ResourceIdentifier' => '<string>',
            'ResourceType' => 'OPPORTUNITY|BENEFIT_ALLOCATION',
        ],
        // ...
    ],
    'BenefitIdentifiers' => ['<string>', ...],
    'Catalog' => '<string>', // REQUIRED
    'FulfillmentTypes' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Programs' => ['<string>', ...],
    'Stages' => ['<string>', ...],
    'Status' => ['<string>', ...],
]);

Parameter Details

Members
AssociatedResourceArns
Type: Array of strings

Filter benefit applications by specific AWS resource ARNs.

AssociatedResources
Type: Array of AssociatedResource structures

Filter benefit applications by associated AWS resources.

BenefitIdentifiers
Type: Array of strings

Filter benefit applications by specific benefit identifiers.

Catalog
Required: Yes
Type: string

The catalog identifier to filter benefit applications by catalog.

FulfillmentTypes
Type: Array of strings

Filter benefit applications by specific fulfillment types.

MaxResults
Type: int

The maximum number of benefit applications to return in a single response.

NextToken
Type: string

A pagination token to retrieve the next set of results from a previous request.

Programs
Type: Array of strings

Filter benefit applications by specific AWS partner programs.

Stages
Type: Array of strings

Filter benefit applications by their current processing stage.

Status
Type: Array of strings

Filter benefit applications by their current processing status.

Result Syntax

[
    'BenefitApplicationSummaries' => [
        [
            'Arn' => '<string>',
            'AssociatedResources' => ['<string>', ...],
            'BenefitApplicationDetails' => ['<string>', ...],
            'BenefitId' => '<string>',
            'Catalog' => '<string>',
            'CreatedAt' => <DateTime>,
            'FulfillmentTypes' => ['<string>', ...],
            'Id' => '<string>',
            'Name' => '<string>',
            'Programs' => ['<string>', ...],
            'Stage' => '<string>',
            'Status' => 'PENDING_SUBMISSION|IN_REVIEW|ACTION_REQUIRED|APPROVED|REJECTED|CANCELED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BenefitApplicationSummaries
Type: Array of BenefitApplicationSummary structures

A list of benefit application summaries matching the specified criteria.

NextToken
Type: string

A pagination token to retrieve the next set of results, if more results are available.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ListBenefits 

$result = $client->listBenefits([/* ... */]);
$promise = $client->listBenefitsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBenefits([
    'Catalog' => '<string>', // REQUIRED
    'FulfillmentTypes' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Programs' => ['<string>', ...],
    'Status' => ['<string>', ...],
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier to filter benefits by catalog.

FulfillmentTypes
Type: Array of strings

Filter benefits by specific fulfillment types.

MaxResults
Type: int

The maximum number of benefits to return in a single response.

NextToken
Type: string

A pagination token to retrieve the next set of results from a previous request.

Programs
Type: Array of strings

Filter benefits by specific AWS partner programs.

Status
Type: Array of strings

Filter benefits by their current status.

Result Syntax

[
    'BenefitSummaries' => [
        [
            'Arn' => '<string>',
            'Catalog' => '<string>',
            'Description' => '<string>',
            'FulfillmentTypes' => ['<string>', ...],
            'Id' => '<string>',
            'Name' => '<string>',
            'Programs' => ['<string>', ...],
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BenefitSummaries
Type: Array of BenefitSummary structures

A list of benefit summaries matching the specified criteria.

NextToken
Type: string

A pagination token to retrieve the next set of results, if more results are available.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves all tags associated with a specific resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to list tags for.

Result Syntax

[
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
tags
Type: Array of Tag structures

A list of key-value pairs representing the tags associated with the resource.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

RecallBenefitApplication 

$result = $client->recallBenefitApplication([/* ... */]);
$promise = $client->recallBenefitApplicationAsync([/* ... */]);

Recalls a submitted benefit application, returning it to draft status for further modifications.

Parameter Syntax

$result = $client->recallBenefitApplication([
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Identifier' => '<string>', // REQUIRED
    'Reason' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ClientToken
Type: string

A unique, case-sensitive identifier to ensure idempotent processing of the recall request.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to recall.

Reason
Required: Yes
Type: string

A descriptive reason explaining why the benefit application is being recalled.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

SubmitBenefitApplication 

$result = $client->submitBenefitApplication([/* ... */]);
$promise = $client->submitBenefitApplicationAsync([/* ... */]);

Submits a benefit application for review and processing by AWS.

Parameter Syntax

$result = $client->submitBenefitApplication([
    'Catalog' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to submit.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates tags for a specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to add tags to.

tags
Required: Yes
Type: Array of Tag structures

A list of key-value pairs to add as tags to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ServiceQuotaExceededException:

Thrown when the request would exceed the service quotas or limits for the account.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes specified tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to remove tags from.

tagKeys
Required: Yes
Type: Array of strings

A list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ServiceQuotaExceededException:

Thrown when the request would exceed the service quotas or limits for the account.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

UpdateBenefitApplication 

$result = $client->updateBenefitApplication([/* ... */]);
$promise = $client->updateBenefitApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateBenefitApplication([
    'BenefitApplicationDetails' => [
    ],
    'Catalog' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'FileDetails' => [
        [
            'BusinessUseCase' => '<string>',
            'FileURI' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Identifier' => '<string>', // REQUIRED
    'Name' => '<string>',
    'PartnerContacts' => [
        [
            'BusinessTitle' => '<string>',
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
            'Phone' => '<string>',
        ],
        // ...
    ],
    'Revision' => '<string>', // REQUIRED
]);

Parameter Details

Members
BenefitApplicationDetails
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Updated detailed information and requirements specific to the benefit being requested.

Catalog
Required: Yes
Type: string

The catalog identifier that specifies which benefit catalog the application belongs to.

ClientToken
Required: Yes
Type: string

A unique, case-sensitive identifier to ensure idempotent processing of the update request.

Description
Type: string

The updated detailed description of the benefit application.

FileDetails
Type: Array of FileInput structures

Updated supporting documents and files attached to the benefit application.

Identifier
Required: Yes
Type: string

The unique identifier of the benefit application to update.

Name
Type: string

The updated human-readable name for the benefit application.

PartnerContacts
Type: Array of Contact structures

Updated contact information for partner representatives responsible for this benefit application.

Revision
Required: Yes
Type: string

The current revision number of the benefit application to ensure optimistic concurrency control.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Revision' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the updated benefit application.

Id
Type: string

The unique identifier of the updated benefit application.

Revision
Type: string

The new revision number of the benefit application after the update.

Errors

ValidationException:

Thrown when the request contains invalid parameters or fails input validation requirements.

AccessDeniedException:

Thrown when the caller does not have sufficient permissions to perform the requested operation.

InternalServerException:

Thrown when an unexpected error occurs on the server side during request processing.

ConflictException:

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

ResourceNotFoundException:

Thrown when the requested resource cannot be found or does not exist.

ThrottlingException:

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

Shapes

AccessDeniedException

Description

Thrown when the caller does not have sufficient permissions to perform the requested operation.

Members
Message
Required: Yes
Type: string

A message describing the access denial.

AccessDetails

Description

Contains information about access-based benefit fulfillment, such as service permissions or feature access.

Members
Description
Type: string

A description of the access privileges or permissions granted by this benefit.

Amendment

Description

Represents a specific change to be made to a benefit application field.

Members
FieldPath
Required: Yes
Type: string

The JSON path or field identifier specifying which field in the benefit application to modify.

NewValue
Required: Yes
Type: string

The new value to set for the specified field in the benefit application.

AssociatedResource

Description

Represents an AWS resource that is associated with a benefit application for tracking and management.

Members
ResourceArn
Type: string

The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.

ResourceIdentifier
Type: string

The unique identifier of the AWS resource within its service.

ResourceType
Type: string

The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).

BenefitAllocationSummary

Description

A summary view of a benefit allocation containing key information for list operations.

Members
ApplicableBenefitIds
Type: Array of strings

The identifiers of the benefits applicable for this allocation.

Arn
Type: string

The Amazon Resource Name (ARN) of the benefit allocation.

BenefitApplicationId
Type: string

The identifier of the benefit application that resulted in this allocation.

BenefitId
Type: string

The identifier of the benefit that this allocation is based on.

Catalog
Type: string

The catalog identifier that the benefit allocation belongs to.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation was created.

ExpiresAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit allocation expires.

FulfillmentTypes
Type: Array of strings

The fulfillment types used for this benefit allocation.

Id
Type: string

The unique identifier of the benefit allocation.

Name
Type: string

The human-readable name of the benefit allocation.

Status
Type: string

The current status of the benefit allocation.

StatusReason
Type: string

Additional information explaining the current status of the benefit allocation.

BenefitApplicationSummary

Description

A summary view of a benefit application containing key information for list operations.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit application.

AssociatedResources
Type: Array of strings

AWS resources that are associated with this benefit application.

BenefitApplicationDetails
Type: Associative array of custom strings keys (String) to strings

Additional attributes and metadata associated with the benefit application.

BenefitId
Type: string

The identifier of the benefit being requested in this application.

Catalog
Type: string

The catalog identifier that the benefit application belongs to.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit application was created.

FulfillmentTypes
Type: Array of strings

The fulfillment types requested for this benefit application.

Id
Type: string

The unique identifier of the benefit application.

Name
Type: string

The human-readable name of the benefit application.

Programs
Type: Array of strings

The AWS partner programs associated with this benefit application.

Stage
Type: string

The current stage in the benefit application processing workflow..

Status
Type: string

The current processing status of the benefit application.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the benefit application was last updated.

BenefitSummary

Description

A summary view of a benefit containing key information for list operations.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the benefit.

Catalog
Type: string

The catalog identifier that the benefit belongs to.

Description
Type: string

A brief description of the benefit and its purpose.

FulfillmentTypes
Type: Array of strings

The available fulfillment types for this benefit.

Id
Type: string

The unique identifier of the benefit.

Name
Type: string

The human-readable name of the benefit.

Programs
Type: Array of strings

The AWS partner programs that this benefit is associated with.

Status
Type: string

The current status of the benefit.

ConflictException

Description

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.

Members
Message
Required: Yes
Type: string

A message describing the conflict.

ConsumableDetails

Description

Contains information about consumable benefit fulfillment, such as usage quotas or service limits.

Members
AllocatedAmount
Type: MonetaryValue structure

The total amount of the consumable benefit that has been allocated.

IssuanceDetails
Type: IssuanceDetail structure

Detailed information about how the consumable benefit was issued and distributed.

RemainingAmount
Type: MonetaryValue structure

The remaining amount of the consumable benefit that is still available for use.

UtilizedAmount
Type: MonetaryValue structure

The amount of the consumable benefit that has already been used.

Contact

Description

Represents contact information for a partner representative.

Members
BusinessTitle
Type: string

The business title or role of the contact person within the organization.

Email
Type: string

The email address of the contact person.

FirstName
Type: string

The first name of the contact person.

LastName
Type: string

The last name of the contact person.

Phone
Type: string

The phone number of the contact person.

CreditCode

Description

Represents an AWS credit code that can be applied to an AWS account for billing purposes.

Members
AwsAccountId
Required: Yes
Type: string

The AWS account ID that the credit code is associated with or can be applied to.

AwsCreditCode
Required: Yes
Type: string

The actual credit code string that can be redeemed in the AWS billing console.

ExpiresAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the credit code expires and can no longer be redeemed.

IssuedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the credit code was issued.

Status
Required: Yes
Type: string

The current status of the credit code (e.g., active, redeemed, expired).

Value
Required: Yes
Type: MonetaryValue structure

The monetary value of the credit code.

CreditDetails

Description

Contains information about credit-based benefit fulfillment, including AWS promotional credits.

Members
AllocatedAmount
Required: Yes
Type: MonetaryValue structure

The total amount of credits that have been allocated for this benefit.

Codes
Required: Yes
Type: Array of CreditCode structures

A list of credit codes that have been generated for this benefit allocation.

IssuedAmount
Required: Yes
Type: MonetaryValue structure

The amount of credits that have actually been issued and are available for use.

DisbursementDetails

Description

Contains information about disbursement-based benefit fulfillment, such as direct payments or reimbursements.

Members
DisbursedAmount
Type: MonetaryValue structure

The total amount that has been disbursed for this benefit allocation.

IssuanceDetails
Type: IssuanceDetail structure

Detailed information about how the disbursement was issued and processed.

Document

Members

FileDetail

Description

Represents detailed information about a file attached to a benefit application.

Members
BusinessUseCase
Type: string

The business purpose or use case that this file supports in the benefit application.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the file was uploaded.

CreatedBy
Type: string

The identifier of the user who uploaded the file.

FileName
Type: string

The original name of the uploaded file.

FileStatus
Type: string

The current processing status of the file (e.g., uploaded, processing, approved, rejected).

FileStatusReason
Type: string

The reason for that particulat file status.

FileType
Type: string

The type or category of the file (e.g., document, image, spreadsheet).

FileURI
Required: Yes
Type: string

The URI or location where the file is stored.

FileInput

Description

Represents input information for uploading a file to a benefit application.

Members
BusinessUseCase
Type: string

The business purpose or use case that this file supports in the benefit application.

FileURI
Required: Yes
Type: string

The URI or location where the file should be stored or has been uploaded.

FulfillmentDetails

Description

Contains comprehensive information about how a benefit allocation is fulfilled across different fulfillment types.

Members
AccessDetails
Type: AccessDetails structure

Details about access-based fulfillment, if applicable to this benefit allocation.

ConsumableDetails
Type: ConsumableDetails structure

Details about consumable-based fulfillment, if applicable to this benefit allocation.

CreditDetails
Type: CreditDetails structure

Details about credit-based fulfillment, if applicable to this benefit allocation.

DisbursementDetails
Type: DisbursementDetails structure

Details about disbursement-based fulfillment, if applicable to this benefit allocation.

InternalServerException

Description

Thrown when an unexpected error occurs on the server side during request processing.

Members
Message
Required: Yes
Type: string

A message describing the internal server error.

IssuanceDetail

Description

Represents detailed information about a specific issuance of benefit value.

Members
IssuanceAmount
Type: MonetaryValue structure

The monetary amount or value that was issued in this specific issuance.

IssuanceId
Type: string

The unique identifier for this specific issuance.

IssuedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when this specific issuance was processed.

MonetaryValue

Description

Represents a monetary amount with its associated currency.

Members
Amount
Required: Yes
Type: string

The numeric amount of the monetary value.

CurrencyCode
Required: Yes
Type: string

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

ResourceNotFoundException

Description

Thrown when the requested resource cannot be found or does not exist.

Members
Message
Required: Yes
Type: string

A message describing the resource not found error.

ServiceQuotaExceededException

Description

Thrown when the request would exceed the service quotas or limits for the account.

Members
Message
Required: Yes
Type: string

A message describing the service quota exceeded error.

QuotaCode
Required: Yes
Type: string

The code identifying the specific quota that would be exceeded.

ResourceId
Required: Yes
Type: string

The identifier of the resource that would exceed the quota.

ResourceType
Required: Yes
Type: string

The type of the resource that would exceed the quota.

Tag

Description

Represents a key-value pair used for categorizing and organizing AWS resources.

Members
Key
Required: Yes
Type: string

The tag key, which acts as a category or label for the tag.

Value
Required: Yes
Type: string

The tag value, which provides additional information or context for the tag key.

ThrottlingException

Description

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

Members
Message
Required: Yes
Type: string

A message describing the throttling error.

ValidationException

Description

Thrown when the request contains invalid parameters or fails input validation requirements.

Members
FieldList
Type: Array of ValidationExceptionField structures

A list of fields that failed validation.

Message
Required: Yes
Type: string

A message describing the validation error.

Reason
Required: Yes
Type: string

The reason for the validation failure.

ValidationExceptionField

Description

Represents a field-specific validation error with detailed information.

Members
Code
Type: string

An error code explaining why the field validation failed.

Message
Required: Yes
Type: string

A detailed message explaining why the field validation failed.

Name
Required: Yes
Type: string

The name of the field that failed validation.