SDK for PHP V3

Client: Aws\PartnerCentralRevenueMeasurement\PartnerCentralRevenueMeasurementClient
Service ID: partnercentral-revenue-measurement
Version: 2022-07-26

This page describes the parameters and results for the operations of the Partner Central Revenue Measurement API (2022-07-26), and shows how to use the Aws\PartnerCentralRevenueMeasurement\PartnerCentralRevenueMeasurementClient object to call the described operations. This documentation is specific to the 2022-07-26 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 */).

CreateMarketplaceRevenueShare ( array $params = [] )
Creates a new marketplace revenue share resource in the specified catalog.
CreateMarketplaceRevenueShareAllocation ( array $params = [] )
Creates a new marketplace revenue share allocation for the specified product.
CreateRevenueAttribution ( array $params = [] )
Creates a new revenue attribution record in the specified catalog.
GetMarketplaceRevenueShare ( array $params = [] )
Retrieves the details of a specific marketplace revenue share.
GetMarketplaceRevenueShareAllocation ( array $params = [] )
Retrieves the details of a specific marketplace revenue share allocation.
GetRevenueAttribution ( array $params = [] )
Retrieves the details of a specific revenue attribution.
GetRevenueAttributionAllocation ( array $params = [] )
Retrieves a single allocation by its RevenueAttributionAllocationId.
GetRevenueAttributionAllocationsTask ( array $params = [] )
Retrieves the current status of a previously submitted allocations task.
ListMarketplaceRevenueShareAllocations ( array $params = [] )
Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range.
ListMarketplaceRevenueShares ( array $params = [] )
Returns a paginated list of marketplace revenue shares with optional filters.
ListRevenueAttributionAllocations ( array $params = [] )
Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.
ListRevenueAttributions ( array $params = [] )
Returns a paginated list of revenue attributions with optional filters.
ListTagsForResource ( array $params = [] )
Returns the tags associated with the specified resource.
StartRevenueAttributionAllocationsTask ( array $params = [] )
Submits a batch of up to 250 allocation changes (CREATE and/or UPDATE) for asynchronous processing.
TagResource ( array $params = [] )
Adds or overwrites one or more tags for the specified resource.
UntagResource ( array $params = [] )
Removes one or more tags from the specified resource.
UpdateMarketplaceRevenueShareAllocation ( array $params = [] )
Updates an existing marketplace revenue share allocation.
UpdateRevenueAttribution ( array $params = [] )
Updates an existing revenue attribution record.

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:

ListMarketplaceRevenueShareAllocations
ListMarketplaceRevenueShares
ListRevenueAttributionAllocations
ListRevenueAttributions

Operations

CreateMarketplaceRevenueShare

$result = $client->createMarketplaceRevenueShare([/* ... */]);
$promise = $client->createMarketplaceRevenueShareAsync([/* ... */]);

Creates a new marketplace revenue share resource in the specified catalog.

Parameter Syntax

$result = $client->createMarketplaceRevenueShare([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog in which to create the marketplace revenue share.

ClientToken
Type: string

A unique token to ensure idempotency of the create request.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier for this revenue share.

Tags
Type: Array of Tag structures

Tags to associate with the marketplace revenue share upon creation.

Result Syntax

[
    'Arn' => '<string>',
    'Catalog' => 'AWS|Sandbox',
    'CreatedDate' => <DateTime>,
    'LastModifiedDate' => <DateTime>,
    'ProductCode' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'Revision' => <integer>,
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the newly created marketplace revenue share.

Catalog
Type: string

The catalog that the marketplace revenue share belongs to.

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

The date when the marketplace revenue share was created.

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

The date when the marketplace revenue share was last modified.

ProductCode
Type: string

The AWS Marketplace product code.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier of the newly created revenue share.

ProductName
Type: string

The display name of the AWS Marketplace product.

Revision
Type: int

The revision number of the newly created marketplace revenue share.

Errors

ServiceQuotaExceededException:

The request would exceed a service quota limit.

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for CreateMarketplaceRevenueShare
$result = $client->createMarketplaceRevenueShare([
    'Catalog' => 'AWS',
    'ProductId' => 'prod-abc123def4567',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share/prod-abc123def4567',
    'ProductId' => 'prod-abc123def4567',
]

CreateMarketplaceRevenueShareAllocation

$result = $client->createMarketplaceRevenueShareAllocation([/* ... */]);
$promise = $client->createMarketplaceRevenueShareAllocationAsync([/* ... */]);

Creates a new marketplace revenue share allocation for the specified product.

Parameter Syntax

$result = $client->createMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'EffectiveFrom' => '<string>', // REQUIRED
    'EffectiveUntil' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'RevenueSharePercent' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog in which to create the allocation.

ClientToken
Type: string

A unique token to ensure idempotency of the create request.

EffectiveFrom
Required: Yes
Type: string

The effective start date for the allocation. Must be the first day of a month.

EffectiveUntil
Type: string

The effective end date for the allocation. Must be the last day of a month (YYYY-MM-DD). Omit for open-ended allocations.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier for the parent revenue share.

RevenueSharePercent
Required: Yes
Type: string

The revenue share percentage for this allocation.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedDate' => <DateTime>,
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LatestMarketplaceRevenueShareRevision' => '<string>',
    'MarketplaceRevenueShareAllocationId' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'RevenueSharePercent' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the allocation.

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

The date when the allocation was created.

EffectiveFrom
Required: Yes
Type: string

The effective start date of the allocation.

EffectiveUntil
Type: string

The effective end date of the allocation, or null if open-ended.

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

The date when the allocation was last modified.

LatestMarketplaceRevenueShareRevision
Type: string

The latest revision of the parent marketplace revenue share.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The unique identifier of the newly created allocation.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier.

ProductName
Type: string

The display name of the AWS Marketplace product.

RevenueSharePercent
Required: Yes
Type: string

The revenue share percentage.

Status
Required: Yes
Type: string

The status of the allocation.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Example for CreateMarketplaceRevenueShareAllocation
$result = $client->createMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS',
    'EffectiveFrom' => '2026-07-01',
    'ProductId' => 'prod-abc123def4567',
    'RevenueSharePercent' => '15.50',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567',
    'EffectiveFrom' => '2026-07-01',
    'MarketplaceRevenueShareAllocationId' => 'mrsa-abc123def4567',
    'ProductId' => 'prod-abc123def4567',
    'RevenueSharePercent' => '15.50',
    'Status' => 'ACTIVE',
]

CreateRevenueAttribution

$result = $client->createRevenueAttribution([/* ... */]);
$promise = $client->createRevenueAttributionAsync([/* ... */]);

Creates a new revenue attribution record in the specified catalog.

Parameter Syntax

$result = $client->createRevenueAttribution([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ProductIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TenancyModel' => 'MULTI_TENANT|SINGLE_TENANT', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog in which to create the revenue attribution.

ClientToken
Type: string

A unique token to ensure idempotency of the create request.

Description
Type: string

A description of the revenue attribution.

Name
Required: Yes
Type: string

The name of the revenue attribution. Must be unique within the catalog and the partner's account.

ProductIdentifier
Type: string

The unique product identifier in AWS Marketplace. Accepts a product entity ID (e.g., prod-abc123def4567) or a product ARN.

Tags
Type: Array of Tag structures

Tags to associate with the revenue attribution upon creation.

TenancyModel
Required: Yes
Type: string

The tenancy model for this revenue attribution.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'MarketplaceProduct' => [
        'ProductCode' => '<string>',
        'ProductId' => '<string>',
        'ProductName' => '<string>',
    ],
    'Name' => '<string>',
    'Revision' => '<string>',
    'TenancyModel' => 'MULTI_TENANT|SINGLE_TENANT',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the newly created revenue attribution.

Description
Type: string

The description of the revenue attribution.

Id
Required: Yes
Type: string

The unique identifier of the newly created revenue attribution.

MarketplaceProduct
Type: MarketplaceProductSummary structure

The associated AWS Marketplace product listing, if set at creation.

Name
Type: string

The name of the revenue attribution.

Revision
Type: string

The revision of the newly created attribution resource.

TenancyModel
Required: Yes
Type: string

The tenancy model for this revenue attribution.

Errors

ServiceQuotaExceededException:

The request would exceed a service quota limit.

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for CreateRevenueAttribution
$result = $client->createRevenueAttribution([
    'Catalog' => 'AWS',
    'Name' => 'My Revenue Attribution',
    'TenancyModel' => 'MULTI_TENANT',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6',
    'Id' => 'ra-0a1b2c3d4e5f6',
    'TenancyModel' => 'MULTI_TENANT',
]

GetMarketplaceRevenueShare

$result = $client->getMarketplaceRevenueShare([/* ... */]);
$promise = $client->getMarketplaceRevenueShareAsync([/* ... */]);

Retrieves the details of a specific marketplace revenue share.

Parameter Syntax

$result = $client->getMarketplaceRevenueShare([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'Revision' => <integer>,
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that the marketplace revenue share belongs to.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier of the revenue share to retrieve.

Revision
Type: int

The revision of the marketplace revenue share to retrieve. Omit to return the latest revision.

Result Syntax

[
    'Arn' => '<string>',
    'Catalog' => 'AWS|Sandbox',
    'CreatedDate' => <DateTime>,
    'LastModifiedDate' => <DateTime>,
    'LatestRevision' => <integer>,
    'ProductCode' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'Revision' => <integer>,
    'TotalActiveMarketplaceRevenueShareAllocationCount' => <integer>,
    'TotalMarketplaceRevenueShareAllocationCount' => <integer>,
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the marketplace revenue share.

Catalog
Required: Yes
Type: string

The catalog that the marketplace revenue share belongs to.

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

The date when the marketplace revenue share was created.

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

The date when the marketplace revenue share was last modified.

LatestRevision
Type: int

The latest revision number of the marketplace revenue share.

ProductCode
Type: string

The AWS Marketplace product code.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier of the revenue share.

ProductName
Type: string

The display name of the AWS Marketplace product.

Revision
Type: int

The revision number of the retrieved marketplace revenue share.

TotalActiveMarketplaceRevenueShareAllocationCount
Type: int

The number of active allocations under this marketplace revenue share.

TotalMarketplaceRevenueShareAllocationCount
Type: int

The total number of allocations under this marketplace revenue share.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Example for GetMarketplaceRevenueShare
$result = $client->getMarketplaceRevenueShare([
    'Catalog' => 'AWS',
    'ProductId' => 'prod-abc123def4567',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share/prod-abc123def4567',
    'Catalog' => 'AWS',
    'ProductId' => 'prod-abc123def4567',
]

GetMarketplaceRevenueShareAllocation

$result = $client->getMarketplaceRevenueShareAllocation([/* ... */]);
$promise = $client->getMarketplaceRevenueShareAllocationAsync([/* ... */]);

Retrieves the details of a specific marketplace revenue share allocation.

Parameter Syntax

$result = $client->getMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'MarketplaceRevenueShareAllocationId' => '<string>', // REQUIRED
    'MarketplaceRevenueShareRevision' => '<string>',
    'ProductId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that the allocation belongs to.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The unique identifier of the allocation to retrieve.

MarketplaceRevenueShareRevision
Type: string

The revision of the parent marketplace revenue share at which to retrieve the allocation. Omit to return the latest.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier of the parent revenue share.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedDate' => <DateTime>,
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LatestMarketplaceRevenueShareRevision' => '<string>',
    'MarketplaceRevenueShareAllocationId' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'RevenueSharePercent' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the allocation.

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

The date when the allocation was created.

EffectiveFrom
Required: Yes
Type: string

The effective start date of the allocation.

EffectiveUntil
Type: string

The effective end date of the allocation, or null if open-ended.

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

The date when the allocation was last modified.

LatestMarketplaceRevenueShareRevision
Type: string

The latest revision of the parent marketplace revenue share.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The unique identifier of the allocation.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier.

ProductName
Type: string

The display name of the AWS Marketplace product.

RevenueSharePercent
Required: Yes
Type: string

The revenue share percentage.

Status
Required: Yes
Type: string

The status of the allocation.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for GetMarketplaceRevenueShareAllocation
$result = $client->getMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS',
    'MarketplaceRevenueShareAllocationId' => 'mrsa-abc123def4567',
    'ProductId' => 'prod-abc123def4567',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567',
    'EffectiveFrom' => '2026-07-01',
    'MarketplaceRevenueShareAllocationId' => 'mrsa-abc123def4567',
    'ProductId' => 'prod-abc123def4567',
    'RevenueSharePercent' => '15.50',
    'Status' => 'ACTIVE',
]

GetRevenueAttribution

$result = $client->getRevenueAttribution([/* ... */]);
$promise = $client->getRevenueAttributionAsync([/* ... */]);

Retrieves the details of a specific revenue attribution.

Parameter Syntax

$result = $client->getRevenueAttribution([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
    'Revision' => '<string>',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that the revenue attribution belongs to.

Identifier
Required: Yes
Type: string

The unique identifier of the revenue attribution to retrieve. Accepts a direct ID or ARN.

Revision
Type: string

The revision of the attribution to retrieve. Omit to return the latest revision.

Result Syntax

[
    'Arn' => '<string>',
    'Catalog' => 'AWS|Sandbox',
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'Id' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LatestRevision' => '<string>',
    'MarketplaceProduct' => [
        'ProductCode' => '<string>',
        'ProductId' => '<string>',
        'ProductName' => '<string>',
    ],
    'Name' => '<string>',
    'Revision' => '<string>',
    'TenancyModel' => 'MULTI_TENANT|SINGLE_TENANT',
    'TotalActiveRevenueAttributionAllocationCount' => <integer>,
    'TotalRevenueAttributionAllocationCount' => <integer>,
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the revenue attribution.

Catalog
Required: Yes
Type: string

The catalog that the revenue attribution belongs to.

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

The date when the revenue attribution was created.

Description
Type: string

A description of the revenue attribution.

EffectiveFrom
Type: string

The date from which this revenue attribution is effective, derived from the earliest allocation start date (YYYY-MM-DD).

EffectiveUntil
Type: string

The date until which this revenue attribution is effective, derived from the latest allocation end date (YYYY-MM-DD).

Id
Required: Yes
Type: string

The unique identifier of the revenue attribution.

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

The date when the revenue attribution was last modified.

LatestRevision
Type: string

The latest revision of the attribution.

MarketplaceProduct
Type: MarketplaceProductSummary structure

The associated AWS Marketplace product listing, if set.

Name
Type: string

The display name of the revenue attribution.

Revision
Type: string

The revision of the retrieved attribution.

TenancyModel
Required: Yes
Type: string

The tenancy model for this revenue attribution.

TotalActiveRevenueAttributionAllocationCount
Type: int

The total number of allocations under this revenue attribution whose Status is ACTIVE.

TotalRevenueAttributionAllocationCount
Type: int

The total number of allocations under this revenue attribution, counting both ACTIVE and INACTIVE.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for GetRevenueAttribution
$result = $client->getRevenueAttribution([
    'Catalog' => 'AWS',
    'Identifier' => 'ra-0a1b2c3d4e5f6',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6',
    'Catalog' => 'AWS',
    'Id' => 'ra-0a1b2c3d4e5f6',
    'TenancyModel' => 'MULTI_TENANT',
]

GetRevenueAttributionAllocation

$result = $client->getRevenueAttributionAllocation([/* ... */]);
$promise = $client->getRevenueAttributionAllocationAsync([/* ... */]);

Retrieves a single allocation by its RevenueAttributionAllocationId. Supports optional point-in-time version queries.

Parameter Syntax

$result = $client->getRevenueAttributionAllocation([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'RevenueAttributionAllocationId' => '<string>', // REQUIRED
    'RevenueAttributionIdentifier' => '<string>', // REQUIRED
    'RevenueAttributionRevision' => '<string>',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that contains the resource.

RevenueAttributionAllocationId
Required: Yes
Type: string

The allocation identifier.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier.

RevenueAttributionRevision
Type: string

Point-in-time revision number to query.

Result Syntax

[
    'CreatedDate' => <DateTime>,
    'CustomerAwsAccountId' => '<string>',
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'EntityIdentifier' => '<string>',
    'EntityName' => '<string>',
    'EntityType' => 'OFFER|OPPORTUNITY',
    'LastModifiedDate' => <DateTime>,
    'RevenueAttributionAllocationId' => '<string>',
    'RevenueAttributionIdentifier' => '<string>',
    'RevenueAttributionLatestRevision' => '<string>',
    'RevenueAttributionRevision' => '<string>',
    'RevenueSharePercent' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

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

When the allocation was first created.

CustomerAwsAccountId
Required: Yes
Type: string

The customer AWS account ID for this associated deal entity.

EffectiveFrom
Required: Yes
Type: string

First day of the effective month.

EffectiveUntil
Required: Yes
Type: string

Last day of the effective month.

EntityIdentifier
Required: Yes
Type: string

The unique identifier of the associated deal entity.

EntityName
Type: string

The display name of the associated deal entity.

EntityType
Required: Yes
Type: string

The type of the associated deal entity.

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

When the allocation was last modified.

RevenueAttributionAllocationId
Required: Yes
Type: string

Unique allocation identifier.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier.

RevenueAttributionLatestRevision
Required: Yes
Type: string

The latest committed revision.

RevenueAttributionRevision
Required: Yes
Type: string

The revision of this allocation version.

RevenueSharePercent
Required: Yes
Type: string

Revenue share percentage.

Status
Required: Yes
Type: string

Current allocation status.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for GetRevenueAttributionAllocation
$result = $client->getRevenueAttributionAllocation([
    'Catalog' => 'AWS',
    'RevenueAttributionAllocationId' => 'alloc-abc123def4567',
    'RevenueAttributionIdentifier' => 'ra-0a1b2c3d4e5f6',
]);

Result syntax:

[
    'CreatedDate' => ,
    'CustomerAwsAccountId' => '123456789012',
    'EffectiveFrom' => '2026-07-01',
    'EffectiveUntil' => '2026-07-31',
    'EntityIdentifier' => 'offer-abc123',
    'EntityType' => 'OFFER',
    'LastModifiedDate' => ,
    'RevenueAttributionAllocationId' => 'alloc-abc123def4567',
    'RevenueAttributionIdentifier' => 'ra-0a1b2c3d4e5f6',
    'RevenueAttributionLatestRevision' => '1',
    'RevenueAttributionRevision' => '1',
    'RevenueSharePercent' => '15.50',
    'Status' => 'ACTIVE',
]

GetRevenueAttributionAllocationsTask

$result = $client->getRevenueAttributionAllocationsTask([/* ... */]);
$promise = $client->getRevenueAttributionAllocationsTaskAsync([/* ... */]);

Retrieves the current status of a previously submitted allocations task. When COMPLETE, includes the latest revision. When FAILED, includes error details.

Parameter Syntax

$result = $client->getRevenueAttributionAllocationsTask([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'RevenueAttributionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that contains the resource.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier.

Result Syntax

[
    'Catalog' => 'AWS|Sandbox',
    'Description' => '<string>',
    'EndedAt' => <DateTime>,
    'ErrorDetailList' => [
        [
            'Action' => 'CREATE|UPDATE',
            'CustomerAwsAccountId' => '<string>',
            'EffectiveFrom' => '<string>',
            'EffectiveUntil' => '<string>',
            'EntityId' => '<string>',
            'EntityType' => 'OFFER|OPPORTUNITY',
            'ErrorCode' => 'ALLOCATION_CAP_EXCEEDED|RESOURCE_NOT_FOUND|IMMUTABLE_ALLOCATION|ACCESS_DENIED|INVALID_VALUE|CONCURRENT_MODIFICATION|INTERNAL_ERROR',
            'ErrorMessage' => '<string>',
            'RevenueAttributionAllocationId' => '<string>',
        ],
        // ...
    ],
    'RevenueAttributionArn' => '<string>',
    'RevenueAttributionLatestRevision' => '<string>',
    'StartedAt' => <DateTime>,
    'Status' => 'IN_PROGRESS|COMPLETE|FAILED',
    'TaskId' => '<string>',
    'TotalRevenueAttributionAllocationRecords' => <integer>,
]

Result Details

Members
Catalog
Required: Yes
Type: string

The catalog used for this task.

Description
Type: string

Human-readable description, if provided at creation.

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

When processing ended. Only present when COMPLETE or FAILED.

ErrorDetailList
Type: Array of RevenueAttributionAllocationErrorDetail structures

All errors discovered during async processing. Only present when FAILED.

RevenueAttributionArn
Required: Yes
Type: string

ARN of the revenue attribution resource.

RevenueAttributionLatestRevision
Type: string

The revision number assigned to this batch. Only present when COMPLETE.

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

When processing started.

Status
Required: Yes
Type: string

Current task status.

TaskId
Required: Yes
Type: string

The unique identifier for the asynchronous task.

TotalRevenueAttributionAllocationRecords
Required: Yes
Type: int

Total revenue attribution allocation records in the batch.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for GetRevenueAttributionAllocationsTask
$result = $client->getRevenueAttributionAllocationsTask([
    'Catalog' => 'AWS',
    'RevenueAttributionIdentifier' => 'ra-0a1b2c3d4e5f6',
]);

Result syntax:

[
    'Catalog' => 'AWS',
    'RevenueAttributionArn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6',
    'StartedAt' => ,
    'Status' => 'COMPLETE',
    'TaskId' => 'raatask-abc123def4567',
    'TotalRevenueAttributionAllocationRecords' => 1,
]

ListMarketplaceRevenueShareAllocations

$result = $client->listMarketplaceRevenueShareAllocations([/* ... */]);
$promise = $client->listMarketplaceRevenueShareAllocationsAsync([/* ... */]);

Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range. Supports historical reads at a specific share revision.

Parameter Syntax

$result = $client->listMarketplaceRevenueShareAllocations([
    'AfterEffectiveFrom' => '<string>',
    'BeforeEffectiveFrom' => '<string>',
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'MarketplaceRevenueShareRevision' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductId' => '<string>', // REQUIRED
    'SortBy' => 'EffectiveFrom',
    'SortOrder' => 'ASCENDING|DESCENDING',
    'Status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members
AfterEffectiveFrom
Type: string

Inclusive lower bound for EffectiveFrom date filter.

BeforeEffectiveFrom
Type: string

Exclusive upper bound for EffectiveFrom date filter (half-open range).

Catalog
Required: Yes
Type: string

The catalog containing the allocations.

MarketplaceRevenueShareRevision
Type: string

Optional share revision for historical list. Returns allocations as they existed at this revision.

MaxResults
Type: int

Maximum number of results per page.

NextToken
Type: string

Pagination token from a previous response.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier for the parent revenue share.

SortBy
Type: string

The field to sort marketplace revenue share allocations by.

SortOrder
Type: string

The direction to sort results. Defaults to DESCENDING.

Status
Type: string

Filter by allocation status.

Result Syntax

[
    'MarketplaceRevenueShareAllocationSummaries' => [
        [
            'Arn' => '<string>',
            'CreatedDate' => <DateTime>,
            'EffectiveFrom' => '<string>',
            'EffectiveUntil' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'MarketplaceRevenueShareAllocationId' => '<string>',
            'ProductId' => '<string>',
            'ProductName' => '<string>',
            'RevenueSharePercent' => '<string>',
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MarketplaceRevenueShareAllocationSummaries
Required: Yes
Type: Array of MarketplaceRevenueShareAllocationSummary structures

The list of allocation summaries for the current page.

NextToken
Type: string

Pagination token for the next page. Absent if no more results.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for ListMarketplaceRevenueShareAllocations
$result = $client->listMarketplaceRevenueShareAllocations([
    'Catalog' => 'AWS',
    'ProductId' => 'prod-abc123def4567',
]);

Result syntax:

[
    'MarketplaceRevenueShareAllocationSummaries' => [
    ],
]

ListMarketplaceRevenueShares

$result = $client->listMarketplaceRevenueShares([/* ... */]);
$promise = $client->listMarketplaceRevenueSharesAsync([/* ... */]);

Returns a paginated list of marketplace revenue shares with optional filters.

Parameter Syntax

$result = $client->listMarketplaceRevenueShares([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'CreatedAfter' => <integer || string || DateTime>,
    'CreatedBefore' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductCodes' => ['<string>', ...],
    'ProductIds' => ['<string>', ...],
    'SortBy' => 'LastModifiedDate',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog to list marketplace revenue shares from.

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

Filter results to only include marketplace revenue shares created after this timestamp.

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

Filter results to only include marketplace revenue shares created before this timestamp.

MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

Token for pagination. Use the value returned in the previous response to retrieve the next page.

ProductCodes
Type: Array of strings

Filter results to only include shares with these product codes.

ProductIds
Type: Array of strings

Filter results to only include shares with these product identifiers.

SortBy
Type: string

The field to sort marketplace revenue shares by.

SortOrder
Type: string

The direction to sort results.

Result Syntax

[
    'MarketplaceRevenueShareSummaries' => [
        [
            'Arn' => '<string>',
            'Catalog' => 'AWS|Sandbox',
            'CreatedDate' => <DateTime>,
            'LastModifiedDate' => <DateTime>,
            'LatestRevision' => <integer>,
            'ProductCode' => '<string>',
            'ProductId' => '<string>',
            'ProductName' => '<string>',
            'TotalActiveMarketplaceRevenueShareAllocationCount' => <integer>,
            'TotalMarketplaceRevenueShareAllocationCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MarketplaceRevenueShareSummaries
Required: Yes
Type: Array of MarketplaceRevenueShareSummary structures

The list of marketplace revenue share summaries.

NextToken
Type: string

Token for pagination. Present if there are more results available.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

Examples

Example 1: Example for ListMarketplaceRevenueShares
$result = $client->listMarketplaceRevenueShares([
    'Catalog' => 'AWS',
    'MaxResults' => 10,
]);

Result syntax:

[
    'MarketplaceRevenueShareSummaries' => [
    ],
]

ListRevenueAttributionAllocations

$result = $client->listRevenueAttributionAllocations([/* ... */]);
$promise = $client->listRevenueAttributionAllocationsAsync([/* ... */]);

Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.

Parameter Syntax

$result = $client->listRevenueAttributionAllocations([
    'AfterEffectiveFrom' => '<string>',
    'AfterEffectiveUntil' => '<string>',
    'BeforeEffectiveFrom' => '<string>',
    'BeforeEffectiveUntil' => '<string>',
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'CustomerAwsAccountIdFilters' => ['<string>', ...],
    'EntityIdentifierFilters' => ['<string>', ...],
    'EntityTypeFilters' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RevenueAttributionIdentifier' => '<string>', // REQUIRED
    'RevenueAttributionRevision' => '<string>',
    'SortBy' => 'EffectiveFrom',
    'SortOrder' => 'ASCENDING|DESCENDING',
    'StatusFilter' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members
AfterEffectiveFrom
Type: string

Inclusive lower bound for EffectiveFrom date filter.

AfterEffectiveUntil
Type: string

Inclusive lower bound for EffectiveUntil date filter.

BeforeEffectiveFrom
Type: string

Exclusive upper bound for EffectiveFrom date filter (half-open range).

BeforeEffectiveUntil
Type: string

Exclusive upper bound for EffectiveUntil date filter (half-open range).

Catalog
Required: Yes
Type: string

The catalog that contains the resource.

CustomerAwsAccountIdFilters
Type: Array of strings

Filter by customer AWS account IDs for associated deal entities.

EntityIdentifierFilters
Type: Array of strings

Filter by deal entity identifiers.

EntityTypeFilters
Type: Array of strings

Filter by deal entity types.

MaxResults
Type: int

Maximum results per page.

NextToken
Type: string

Pagination token from previous response.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier to query.

RevenueAttributionRevision
Type: string

Point-in-time revision number to query.

SortBy
Type: string

Field to sort by.

SortOrder
Type: string

Sort direction. Defaults to ASCENDING.

StatusFilter
Type: string

Filter by allocation status.

Result Syntax

[
    'NextToken' => '<string>',
    'RevenueAttributionAllocationSummaries' => [
        [
            'CustomerAwsAccountId' => '<string>',
            'EffectiveFrom' => '<string>',
            'EffectiveUntil' => '<string>',
            'EntityIdentifier' => '<string>',
            'EntityName' => '<string>',
            'EntityType' => 'OFFER|OPPORTUNITY',
            'RevenueAttributionAllocationId' => '<string>',
            'RevenueAttributionIdentifier' => '<string>',
            'RevenueSharePercent' => '<string>',
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Token for next page. Absent if no more results.

RevenueAttributionAllocationSummaries
Required: Yes
Type: Array of RevenueAttributionAllocationSummary structures

Paginated list of allocations matching filters.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for ListRevenueAttributionAllocations
$result = $client->listRevenueAttributionAllocations([
    'Catalog' => 'AWS',
    'RevenueAttributionIdentifier' => 'ra-0a1b2c3d4e5f6',
]);

Result syntax:

[
    'RevenueAttributionAllocationSummaries' => [
    ],
]

ListRevenueAttributions

$result = $client->listRevenueAttributions([/* ... */]);
$promise = $client->listRevenueAttributionsAsync([/* ... */]);

Returns a paginated list of revenue attributions with optional filters.

Parameter Syntax

$result = $client->listRevenueAttributions([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'CreatedAfter' => <integer || string || DateTime>,
    'CreatedBefore' => <integer || string || DateTime>,
    'Identifiers' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => 'LastModifiedDate',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog to list revenue attributions from.

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

Filter results to only include revenue attributions created after this timestamp.

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

Filter results to only include revenue attributions created before this timestamp.

Identifiers
Type: Array of strings

Filter results to only include revenue attributions with the specified identifiers.

MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

Token for pagination. Use the value returned in the previous response to retrieve the next page.

SortBy
Type: string

The field to sort revenue attributions by.

SortOrder
Type: string

The direction to sort results.

Result Syntax

[
    'NextToken' => '<string>',
    'RevenueAttributionSummaries' => [
        [
            'Arn' => '<string>',
            'Catalog' => 'AWS|Sandbox',
            'CreatedDate' => <DateTime>,
            'EffectiveFrom' => '<string>',
            'EffectiveUntil' => '<string>',
            'Id' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'LatestRevision' => '<string>',
            'MarketplaceProduct' => [
                'ProductCode' => '<string>',
                'ProductId' => '<string>',
                'ProductName' => '<string>',
            ],
            'Name' => '<string>',
            'TenancyModel' => 'MULTI_TENANT|SINGLE_TENANT',
            'TotalActiveRevenueAttributionAllocationCount' => <integer>,
            'TotalRevenueAttributionAllocationCount' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Token for pagination. Present if there are more results available.

RevenueAttributionSummaries
Type: Array of AttributionSummary structures

The list of revenue attribution summaries.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for ListRevenueAttributions
$result = $client->listRevenueAttributions([
    'Catalog' => 'AWS',
]);

Result syntax:

[
    'RevenueAttributionSummaries' => [
    ],
]

ListTagsForResource

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

Returns the tags associated with the specified 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

The tags associated with the resource.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

StartRevenueAttributionAllocationsTask

$result = $client->startRevenueAttributionAllocationsTask([/* ... */]);
$promise = $client->startRevenueAttributionAllocationsTaskAsync([/* ... */]);

Submits a batch of up to 250 allocation changes (CREATE and/or UPDATE) for asynchronous processing. Returns a TaskId for tracking.

Parameter Syntax

$result = $client->startRevenueAttributionAllocationsTask([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'RevenueAttributionIdentifier' => '<string>', // REQUIRED
    'RevenueAttributionRevision' => '<string>', // REQUIRED
    'RevenueShareAllocations' => [ // REQUIRED
        [
            'Action' => 'CREATE|UPDATE', // REQUIRED
            'CustomerAwsAccountId' => '<string>', // REQUIRED
            'EffectiveFrom' => '<string>', // REQUIRED
            'EffectiveUntil' => '<string>', // REQUIRED
            'EntityIdentifier' => '<string>', // REQUIRED
            'EntityType' => 'OFFER|OPPORTUNITY', // REQUIRED
            'RevenueAttributionAllocationId' => '<string>',
            'RevenueSharePercent' => '<string>', // REQUIRED
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog context for this operation.

ClientToken
Type: string

Idempotency token for deduplication and retry.

Description
Type: string

Human-readable description of the batch.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier.

RevenueAttributionRevision
Required: Yes
Type: string

Current revision of the revenue attribution for optimistic locking.

RevenueShareAllocations
Required: Yes
Type: Array of RevenueShareAllocation structures

The list of allocation changes to process in this batch.

Result Syntax

[
    'Catalog' => 'AWS|Sandbox',
    'RevenueAttributionArn' => '<string>',
    'StartedAt' => <DateTime>,
    'Status' => 'IN_PROGRESS|COMPLETE|FAILED',
    'TaskId' => '<string>',
    'TotalRevenueAttributionAllocationRecords' => <integer>,
]

Result Details

Members
Catalog
Required: Yes
Type: string

The catalog used for this task.

RevenueAttributionArn
Required: Yes
Type: string

ARN of the revenue attribution resource.

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

When processing started.

Status
Required: Yes
Type: string

Initial task status. Always IN_PROGRESS on successful submission.

TaskId
Required: Yes
Type: string

Unique identifier for the submitted task.

TotalRevenueAttributionAllocationRecords
Required: Yes
Type: int

Total revenue attribution allocation records in the batch.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Example for StartRevenueAttributionAllocationsTask
$result = $client->startRevenueAttributionAllocationsTask([
    'Catalog' => 'AWS',
    'ClientToken' => 'unique-token-123',
    'RevenueAttributionIdentifier' => 'ra-0a1b2c3d4e5f6',
    'RevenueAttributionRevision' => '1',
    'RevenueShareAllocations' => [
        [
            'Action' => 'CREATE',
            'CustomerAwsAccountId' => '123456789012',
            'EffectiveFrom' => '2026-07-01',
            'EffectiveUntil' => '2026-07-31',
            'EntityIdentifier' => 'offer-abc123',
            'EntityType' => 'OFFER',
            'RevenueSharePercent' => '15.50',
        ],
    ],
]);

Result syntax:

[
    'Catalog' => 'AWS',
    'RevenueAttributionArn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6',
    'StartedAt' => ,
    'Status' => 'IN_PROGRESS',
    'TaskId' => 'raatask-abc123def4567',
    'TotalRevenueAttributionAllocationRecords' => 1,
]

TagResource

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

Adds or overwrites one or more tags for the 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 tag.

tags
Required: Yes
Type: Array of Tag structures

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

UntagResource

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

Removes one or more tags from the specified 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

The tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

UpdateMarketplaceRevenueShareAllocation

$result = $client->updateMarketplaceRevenueShareAllocation([/* ... */]);
$promise = $client->updateMarketplaceRevenueShareAllocationAsync([/* ... */]);

Updates an existing marketplace revenue share allocation. Supports modifying effective dates, revenue share percentage, and status with time-based mutability rules.

Parameter Syntax

$result = $client->updateMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'MarketplaceRevenueShareAllocationId' => '<string>', // REQUIRED
    'MarketplaceRevenueShareRevision' => '<string>', // REQUIRED
    'ProductId' => '<string>', // REQUIRED
    'RevenueSharePercent' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog containing the allocation.

ClientToken
Type: string

A unique token to ensure idempotency of the update request.

EffectiveFrom
Type: string

The new effective start date. Must be the first day of a month. Only modifiable on future-dated allocations.

EffectiveUntil
Type: string

The new effective end date. Must be the last day of a month and on or after today.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The identifier of the allocation to update.

MarketplaceRevenueShareRevision
Required: Yes
Type: string

The current revision of the parent share. Must match for optimistic concurrency control.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier for the parent revenue share.

RevenueSharePercent
Type: string

The new revenue share percentage. Only modifiable on future-dated allocations.

Status
Type: string

The new status. Set to INACTIVE for soft-delete. Only modifiable on future-dated allocations.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedDate' => <DateTime>,
    'EffectiveFrom' => '<string>',
    'EffectiveUntil' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LatestMarketplaceRevenueShareRevision' => '<string>',
    'MarketplaceRevenueShareAllocationId' => '<string>',
    'ProductId' => '<string>',
    'ProductName' => '<string>',
    'RevenueSharePercent' => '<string>',
    'Status' => 'ACTIVE|INACTIVE',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the parent marketplace revenue share.

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

The date when the allocation was created.

EffectiveFrom
Required: Yes
Type: string

The effective start date of the allocation.

EffectiveUntil
Type: string

The effective end date of the allocation, or null if open-ended.

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

The date when the allocation was last modified.

LatestMarketplaceRevenueShareRevision
Type: string

The latest revision of the parent marketplace revenue share after the update.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The unique identifier of the updated allocation.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier.

ProductName
Type: string

The display name of the AWS Marketplace product.

RevenueSharePercent
Required: Yes
Type: string

The revenue share percentage.

Status
Required: Yes
Type: string

The status of the allocation.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Example for UpdateMarketplaceRevenueShareAllocation
$result = $client->updateMarketplaceRevenueShareAllocation([
    'Catalog' => 'AWS',
    'MarketplaceRevenueShareAllocationId' => 'mrsa-abc123def4567',
    'MarketplaceRevenueShareRevision' => '1',
    'ProductId' => 'prod-abc123def4567',
    'RevenueSharePercent' => '20.00',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567',
    'EffectiveFrom' => '2026-07-01',
    'MarketplaceRevenueShareAllocationId' => 'mrsa-abc123def4567',
    'ProductId' => 'prod-abc123def4567',
    'RevenueSharePercent' => '20.00',
    'Status' => 'ACTIVE',
]

UpdateRevenueAttribution

$result = $client->updateRevenueAttribution([/* ... */]);
$promise = $client->updateRevenueAttributionAsync([/* ... */]);

Updates an existing revenue attribution record.

Parameter Syntax

$result = $client->updateRevenueAttribution([
    'Catalog' => 'AWS|Sandbox', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Identifier' => '<string>', // REQUIRED
    'Revision' => '<string>', // REQUIRED
]);

Parameter Details

Members
Catalog
Required: Yes
Type: string

The catalog that the revenue attribution belongs to.

ClientToken
Type: string

A unique token to ensure idempotency of the update request.

Description
Type: string

The updated description of the revenue attribution.

Identifier
Required: Yes
Type: string

The unique identifier of the revenue attribution to update. Accepts a direct ID or ARN.

Revision
Required: Yes
Type: string

The current revision of the revenue attribution. Must match the server's current value.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LatestRevision' => '<string>',
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the updated revenue attribution.

Description
Type: string

The updated description of the revenue attribution.

Id
Required: Yes
Type: string

The unique identifier of the updated revenue attribution.

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

The date when the attribution was last modified.

LatestRevision
Type: string

The latest revision of the attribution after the update.

Errors

ThrottlingException:

The request was throttled due to too many requests. Retry your request.

ValidationException:

The request failed validation due to invalid input parameters.

AccessDeniedException:

The request was denied due to insufficient permissions.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ResourceNotFoundException:

The specified resource was not found.

Examples

Example 1: Example for UpdateRevenueAttribution
$result = $client->updateRevenueAttribution([
    'Catalog' => 'AWS',
    'Identifier' => 'ra-0a1b2c3d4e5f6',
    'Revision' => '1',
]);

Result syntax:

[
    'Arn' => 'arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6',
    'Id' => 'ra-0a1b2c3d4e5f6',
    'LastModifiedDate' => ,
]

Shapes

AccessDeniedException

Description

The request was denied due to insufficient permissions.

Members
Message
Required: Yes
Type: string
Reason
Required: Yes
Type: string

The reason for the access denial.

AttributionSummary

Description

Summary representation of a revenue attribution returned in list operations.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the revenue attribution.

Catalog
Type: string

The catalog that the revenue attribution belongs to.

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

The date when the revenue attribution was created.

EffectiveFrom
Type: string

The date from which this revenue attribution is effective, derived from the earliest allocation start date (YYYY-MM-DD).

EffectiveUntil
Type: string

The date until which this revenue attribution is effective, derived from the latest allocation end date (YYYY-MM-DD).

Id
Type: string

The unique identifier of the revenue attribution.

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

The date when the revenue attribution was last modified.

LatestRevision
Type: string

The latest revision of the revenue attribution resource.

MarketplaceProduct
Type: MarketplaceProductSummary structure

The AWS Marketplace product attributes associated with this attribution, if set.

Name
Type: string

The display name of the revenue attribution.

TenancyModel
Required: Yes
Type: string

The tenancy model for this revenue attribution.

TotalActiveRevenueAttributionAllocationCount
Type: int

The total number of allocations under this revenue attribution whose Status is ACTIVE.

TotalRevenueAttributionAllocationCount
Type: int

The total number of allocations under this revenue attribution, counting both ACTIVE and INACTIVE.

ConflictException

Description

The request could not be completed due to a conflict with the current state of the resource.

Members
Message
Required: Yes
Type: string
Reason
Required: Yes
Type: string

The reason for the conflict.

InternalServerException

Description

An internal server error occurred. Retry your request.

Members
Message
Required: Yes
Type: string

MarketplaceProductSummary

Description

Read-time AWS Marketplace product attributes returned in revenue attribution responses, including service-resolved fields.

Members
ProductCode
Type: string

The AWS Marketplace product code resolved using the product identifier.

ProductId
Type: string

The product identifier provided at attribution creation.

ProductName
Type: string

The display name of the AWS Marketplace product.

MarketplaceRevenueShareAllocationSummary

Description

Summary information about a marketplace revenue share allocation.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the parent marketplace revenue share.

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

The date when the allocation was created.

EffectiveFrom
Required: Yes
Type: string

The effective start date of the allocation.

EffectiveUntil
Type: string

The effective end date of the allocation, or null if open-ended.

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

The date when the allocation was last modified.

MarketplaceRevenueShareAllocationId
Required: Yes
Type: string

The unique identifier of the allocation.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier.

ProductName
Type: string

The display name of the AWS Marketplace product.

RevenueSharePercent
Required: Yes
Type: string

The revenue share percentage.

Status
Required: Yes
Type: string

The status of the allocation.

MarketplaceRevenueShareSummary

Description

Summary information about a marketplace revenue share.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the marketplace revenue share.

Catalog
Type: string

The catalog that the marketplace revenue share belongs to.

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

The date when the marketplace revenue share was created.

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

The date when the marketplace revenue share was last modified.

LatestRevision
Type: int

The latest revision number of the marketplace revenue share.

ProductCode
Type: string

The AWS Marketplace product code.

ProductId
Required: Yes
Type: string

The AWS Marketplace product identifier.

ProductName
Type: string

The display name of the AWS Marketplace product.

TotalActiveMarketplaceRevenueShareAllocationCount
Type: int

The number of active allocations under this share.

TotalMarketplaceRevenueShareAllocationCount
Type: int

The total number of allocations under this share.

ResourceNotFoundException

Description

The specified resource was not found.

Members
Message
Required: Yes
Type: string
Reason
Required: Yes
Type: string

The reason the resource was not found.

RevenueAttributionAllocationErrorDetail

Description

Details of a validation error for a single revenue attribution allocation record.

Members
Action
Required: Yes
Type: string

The action that was attempted.

CustomerAwsAccountId
Required: Yes
Type: string

The customer AWS account ID of the failing record.

EffectiveFrom
Required: Yes
Type: string

Effective start date of the failing record.

EffectiveUntil
Required: Yes
Type: string

Effective end date of the failing record.

EntityId
Required: Yes
Type: string

The deal entity identifier of the failing record.

EntityType
Required: Yes
Type: string

The deal entity type of the failing record.

ErrorCode
Required: Yes
Type: string

Machine-readable error code.

ErrorMessage
Required: Yes
Type: string

Human-readable error description.

RevenueAttributionAllocationId
Type: string

The allocation identifier. Present for UPDATE actions; absent for CREATE actions.

RevenueAttributionAllocationSummary

Description

Summary information about a revenue attribution allocation.

Members
CustomerAwsAccountId
Required: Yes
Type: string

The customer AWS account ID for this associated deal entity.

EffectiveFrom
Required: Yes
Type: string

First day of the effective month.

EffectiveUntil
Required: Yes
Type: string

Last day of the effective month.

EntityIdentifier
Required: Yes
Type: string

The unique identifier of the associated deal entity.

EntityName
Type: string

The display name of the associated deal entity.

EntityType
Required: Yes
Type: string

The type of the associated deal entity.

RevenueAttributionAllocationId
Required: Yes
Type: string

Unique allocation identifier.

RevenueAttributionIdentifier
Required: Yes
Type: string

The revenue attribution identifier.

RevenueSharePercent
Required: Yes
Type: string

Revenue share percentage.

Status
Required: Yes
Type: string

Current allocation status.

RevenueShareAllocation

Description

A single allocation change within a batch request.

Members
Action
Required: Yes
Type: string

The operation type: CREATE or UPDATE.

CustomerAwsAccountId
Required: Yes
Type: string

The customer AWS account ID for this associated deal entity.

EffectiveFrom
Required: Yes
Type: string

The effective start date for this allocation.

EffectiveUntil
Required: Yes
Type: string

The effective end date for this allocation.

EntityIdentifier
Required: Yes
Type: string

The unique identifier of the associated deal entity.

EntityType
Required: Yes
Type: string

The type of the associated deal entity.

RevenueAttributionAllocationId
Type: string

The allocation to update. Required when Action is UPDATE.

RevenueSharePercent
Required: Yes
Type: string

Revenue share percentage.

Status
Type: string

Allocation status. Defaults to ACTIVE on CREATE.

ServiceQuotaExceededException

Description

The request would exceed a service quota limit.

Members
Message
Required: Yes
Type: string
Reason
Required: Yes
Type: string

The reason the service quota was exceeded.

Tag

Description

A key-value pair used for organizing and managing resources through metadata tags.

Members
Key
Required: Yes
Type: string

The key portion of the tag.

Value
Required: Yes
Type: string

The value portion of the tag.

ThrottlingException

Description

The request was throttled due to too many requests. Retry your request.

Members
Message
Required: Yes
Type: string
QuotaCode
Type: string

The quota code associated with the throttling error.

ServiceCode
Type: string

The service code associated with the throttling error.

ValidationException

Description

The request failed validation due to invalid input parameters.

Members
FieldList
Type: Array of ValidationExceptionField structures

A list of fields that failed validation.

Message
Required: Yes
Type: string
Reason
Required: Yes
Type: string

The reason for the validation failure.

ValidationExceptionField

Description

Details about a specific field that failed validation.

Members
Code
Required: Yes
Type: string

The specific validation error code indicating the type of validation failure.

Message
Required: Yes
Type: string

A human-readable message describing why the field validation failed.

Name
Required: Yes
Type: string

The name of the field that failed validation.