Partner Central Revenue Measurement API

2026/07/07 - Partner Central Revenue Measurement API - 18 new api methods

Changes  Add support for AWS Partner Central Revenue Measurement API for creating, managing, and tracking revenue attributions and marketplace revenue share allocations.

ListMarketplaceRevenueShares (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_marketplace_revenue_shares(
    Catalog='AWS'|'Sandbox',
    ProductIds=[
        'string',
    ],
    ProductCodes=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    SortBy='LastModifiedDate',
    SortOrder='ASCENDING'|'DESCENDING',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1)
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog to list marketplace revenue shares from.

type ProductIds:

list

param ProductIds:

Filter results to only include shares with these product identifiers.

  • (string) --

type ProductCodes:

list

param ProductCodes:

Filter results to only include shares with these product codes.

  • (string) --

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type SortBy:

string

param SortBy:

The field to sort marketplace revenue shares by.

type SortOrder:

string

param SortOrder:

The direction to sort results.

type CreatedAfter:

datetime

param CreatedAfter:

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

type CreatedBefore:

datetime

param CreatedBefore:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareSummaries': [
        {
            'ProductId': 'string',
            'Arn': 'string',
            'Catalog': 'AWS'|'Sandbox',
            'ProductCode': 'string',
            'ProductName': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1),
            'LatestRevision': 123,
            'TotalActiveMarketplaceRevenueShareAllocationCount': 123,
            'TotalMarketplaceRevenueShareAllocationCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareSummaries (list) --

      The list of marketplace revenue share summaries.

      • (dict) --

        Summary information about a marketplace revenue share.

        • ProductId (string) --

          The AWS Marketplace product identifier.

        • Arn (string) --

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

        • Catalog (string) --

          The catalog that the marketplace revenue share belongs to.

        • ProductCode (string) --

          The AWS Marketplace product code.

        • ProductName (string) --

          The display name of the AWS Marketplace product.

        • CreatedDate (datetime) --

          The date when the marketplace revenue share was created.

        • LastModifiedDate (datetime) --

          The date when the marketplace revenue share was last modified.

        • LatestRevision (integer) --

          The latest revision number of the marketplace revenue share.

        • TotalActiveMarketplaceRevenueShareAllocationCount (integer) --

          The number of active allocations under this share.

        • TotalMarketplaceRevenueShareAllocationCount (integer) --

          The total number of allocations under this share.

    • NextToken (string) --

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

ListRevenueAttributionAllocations (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_revenue_attribution_allocations(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string',
    EntityTypeFilters=[
        'OFFER'|'OPPORTUNITY',
    ],
    EntityIdentifierFilters=[
        'string',
    ],
    CustomerAwsAccountIdFilters=[
        'string',
    ],
    StatusFilter='ACTIVE'|'INACTIVE',
    AfterEffectiveFrom='string',
    BeforeEffectiveFrom='string',
    AfterEffectiveUntil='string',
    BeforeEffectiveUntil='string',
    SortBy='EffectiveFrom',
    SortOrder='ASCENDING'|'DESCENDING',
    RevenueAttributionRevision='string',
    MaxResults=123,
    NextToken='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that contains the resource.

type RevenueAttributionIdentifier:

string

param RevenueAttributionIdentifier:

[REQUIRED]

The revenue attribution identifier to query.

type EntityTypeFilters:

list

param EntityTypeFilters:

Filter by deal entity types.

  • (string) --

type EntityIdentifierFilters:

list

param EntityIdentifierFilters:

Filter by deal entity identifiers.

  • (string) --

type CustomerAwsAccountIdFilters:

list

param CustomerAwsAccountIdFilters:

Filter by customer AWS account IDs for associated deal entities.

  • (string) --

type StatusFilter:

string

param StatusFilter:

Filter by allocation status.

type AfterEffectiveFrom:

string

param AfterEffectiveFrom:

Inclusive lower bound for EffectiveFrom date filter.

type BeforeEffectiveFrom:

string

param BeforeEffectiveFrom:

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

type AfterEffectiveUntil:

string

param AfterEffectiveUntil:

Inclusive lower bound for EffectiveUntil date filter.

type BeforeEffectiveUntil:

string

param BeforeEffectiveUntil:

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

type SortBy:

string

param SortBy:

Field to sort by.

type SortOrder:

string

param SortOrder:

Sort direction. Defaults to ASCENDING.

type RevenueAttributionRevision:

string

param RevenueAttributionRevision:

Point-in-time revision number to query.

type MaxResults:

integer

param MaxResults:

Maximum results per page.

type NextToken:

string

param NextToken:

Pagination token from previous response.

rtype:

dict

returns:

Response Syntax

{
    'RevenueAttributionAllocationSummaries': [
        {
            'RevenueAttributionAllocationId': 'string',
            'RevenueAttributionIdentifier': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityIdentifier': 'string',
            'EntityName': 'string',
            'CustomerAwsAccountId': 'string',
            'RevenueSharePercent': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Status': 'ACTIVE'|'INACTIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RevenueAttributionAllocationSummaries (list) --

      Paginated list of allocations matching filters.

      • (dict) --

        Summary information about a revenue attribution allocation.

        • RevenueAttributionAllocationId (string) --

          Unique allocation identifier.

        • RevenueAttributionIdentifier (string) --

          The revenue attribution identifier.

        • EntityType (string) --

          The type of the associated deal entity.

        • EntityIdentifier (string) --

          The unique identifier of the associated deal entity.

        • EntityName (string) --

          The display name of the associated deal entity.

        • CustomerAwsAccountId (string) --

          The customer AWS account ID for this associated deal entity.

        • RevenueSharePercent (string) --

          Revenue share percentage.

        • EffectiveFrom (string) --

          First day of the effective month.

        • EffectiveUntil (string) --

          Last day of the effective month.

        • Status (string) --

          Current allocation status.

    • NextToken (string) --

      Token for next page. Absent if no more results.

GetMarketplaceRevenueShareAllocation (new) Link ¶

Retrieves the details of a specific marketplace revenue share allocation.

See also: AWS API Documentation

Request Syntax

client.get_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    MarketplaceRevenueShareAllocationId='string',
    MarketplaceRevenueShareRevision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the allocation belongs to.

type ProductId:

string

param ProductId:

[REQUIRED]

The AWS Marketplace product identifier of the parent revenue share.

type MarketplaceRevenueShareAllocationId:

string

param MarketplaceRevenueShareAllocationId:

[REQUIRED]

The unique identifier of the allocation to retrieve.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'ProductId': 'string',
    'ProductName': 'string',
    'Arn': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestMarketplaceRevenueShareRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the allocation.

    • ProductId (string) --

      The AWS Marketplace product identifier.

    • ProductName (string) --

      The display name of the AWS Marketplace product.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the allocation.

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

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

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • LatestMarketplaceRevenueShareRevision (string) --

      The latest revision of the parent marketplace revenue share.

GetRevenueAttributionAllocationsTask (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_revenue_attribution_allocations_task(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that contains the resource.

type RevenueAttributionIdentifier:

string

param RevenueAttributionIdentifier:

[REQUIRED]

The revenue attribution identifier.

rtype:

dict

returns:

Response Syntax

{
    'TaskId': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'Catalog': 'AWS'|'Sandbox',
    'RevenueAttributionArn': 'string',
    'StartedAt': datetime(2015, 1, 1),
    'EndedAt': datetime(2015, 1, 1),
    'TotalRevenueAttributionAllocationRecords': 123,
    'Description': 'string',
    'RevenueAttributionLatestRevision': 'string',
    'ErrorDetailList': [
        {
            'RevenueAttributionAllocationId': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityId': 'string',
            'CustomerAwsAccountId': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Action': 'CREATE'|'UPDATE',
            'ErrorCode': 'ALLOCATION_CAP_EXCEEDED'|'RESOURCE_NOT_FOUND'|'IMMUTABLE_ALLOCATION'|'ACCESS_DENIED'|'INVALID_VALUE'|'CONCURRENT_MODIFICATION'|'INTERNAL_ERROR',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • TaskId (string) --

      The unique identifier for the asynchronous task.

    • Status (string) --

      Current task status.

    • Catalog (string) --

      The catalog used for this task.

    • RevenueAttributionArn (string) --

      ARN of the revenue attribution resource.

    • StartedAt (datetime) --

      When processing started.

    • EndedAt (datetime) --

      When processing ended. Only present when COMPLETE or FAILED.

    • TotalRevenueAttributionAllocationRecords (integer) --

      Total revenue attribution allocation records in the batch.

    • Description (string) --

      Human-readable description, if provided at creation.

    • RevenueAttributionLatestRevision (string) --

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

    • ErrorDetailList (list) --

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

      • (dict) --

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

        • RevenueAttributionAllocationId (string) --

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

        • EntityType (string) --

          The deal entity type of the failing record.

        • EntityId (string) --

          The deal entity identifier of the failing record.

        • CustomerAwsAccountId (string) --

          The customer AWS account ID of the failing record.

        • EffectiveFrom (string) --

          Effective start date of the failing record.

        • EffectiveUntil (string) --

          Effective end date of the failing record.

        • Action (string) --

          The action that was attempted.

        • ErrorCode (string) --

          Machine-readable error code.

        • ErrorMessage (string) --

          Human-readable error description.

GetRevenueAttribution (new) Link ¶

Retrieves the details of a specific revenue attribution.

See also: AWS API Documentation

Request Syntax

client.get_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    Revision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the revenue attribution belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

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

type Revision:

string

param Revision:

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

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'Name': 'string',
    'Description': 'string',
    'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
    'MarketplaceProduct': {
        'ProductId': 'string',
        'ProductCode': 'string',
        'ProductName': 'string'
    },
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 'string',
    'LatestRevision': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'TotalActiveRevenueAttributionAllocationCount': 123,
    'TotalRevenueAttributionAllocationCount': 123
}

Response Structure

  • (dict) --

    • Arn (string) --

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

    • Id (string) --

      The unique identifier of the revenue attribution.

    • Catalog (string) --

      The catalog that the revenue attribution belongs to.

    • Name (string) --

      The display name of the revenue attribution.

    • Description (string) --

      A description of the revenue attribution.

    • TenancyModel (string) --

      The tenancy model for this revenue attribution.

    • MarketplaceProduct (dict) --

      The associated AWS Marketplace product listing, if set.

      • ProductId (string) --

        The product identifier provided at attribution creation.

      • ProductCode (string) --

        The AWS Marketplace product code resolved using the product identifier.

      • ProductName (string) --

        The display name of the AWS Marketplace product.

    • CreatedDate (datetime) --

      The date when the revenue attribution was created.

    • LastModifiedDate (datetime) --

      The date when the revenue attribution was last modified.

    • Revision (string) --

      The revision of the retrieved attribution.

    • LatestRevision (string) --

      The latest revision of the attribution.

    • EffectiveFrom (string) --

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

    • EffectiveUntil (string) --

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

    • TotalActiveRevenueAttributionAllocationCount (integer) --

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

    • TotalRevenueAttributionAllocationCount (integer) --

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

GetMarketplaceRevenueShare (new) Link ¶

Retrieves the details of a specific marketplace revenue share.

See also: AWS API Documentation

Request Syntax

client.get_marketplace_revenue_share(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    Revision=123
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the marketplace revenue share belongs to.

type ProductId:

string

param ProductId:

[REQUIRED]

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

type Revision:

integer

param Revision:

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

rtype:

dict

returns:

Response Syntax

{
    'ProductId': 'string',
    'Arn': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'ProductCode': 'string',
    'ProductName': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 123,
    'LatestRevision': 123,
    'TotalActiveMarketplaceRevenueShareAllocationCount': 123,
    'TotalMarketplaceRevenueShareAllocationCount': 123
}

Response Structure

  • (dict) --

    • ProductId (string) --

      The AWS Marketplace product identifier of the revenue share.

    • Arn (string) --

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

    • Catalog (string) --

      The catalog that the marketplace revenue share belongs to.

    • ProductCode (string) --

      The AWS Marketplace product code.

    • ProductName (string) --

      The display name of the AWS Marketplace product.

    • CreatedDate (datetime) --

      The date when the marketplace revenue share was created.

    • LastModifiedDate (datetime) --

      The date when the marketplace revenue share was last modified.

    • Revision (integer) --

      The revision number of the retrieved marketplace revenue share.

    • LatestRevision (integer) --

      The latest revision number of the marketplace revenue share.

    • TotalActiveMarketplaceRevenueShareAllocationCount (integer) --

      The number of active allocations under this marketplace revenue share.

    • TotalMarketplaceRevenueShareAllocationCount (integer) --

      The total number of allocations under this marketplace revenue share.

GetRevenueAttributionAllocation (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_revenue_attribution_allocation(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string',
    RevenueAttributionAllocationId='string',
    RevenueAttributionRevision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that contains the resource.

type RevenueAttributionIdentifier:

string

param RevenueAttributionIdentifier:

[REQUIRED]

The revenue attribution identifier.

type RevenueAttributionAllocationId:

string

param RevenueAttributionAllocationId:

[REQUIRED]

The allocation identifier.

type RevenueAttributionRevision:

string

param RevenueAttributionRevision:

Point-in-time revision number to query.

rtype:

dict

returns:

Response Syntax

{
    'RevenueAttributionAllocationId': 'string',
    'RevenueAttributionIdentifier': 'string',
    'EntityType': 'OFFER'|'OPPORTUNITY',
    'EntityIdentifier': 'string',
    'EntityName': 'string',
    'CustomerAwsAccountId': 'string',
    'RevenueSharePercent': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'RevenueAttributionRevision': 'string',
    'RevenueAttributionLatestRevision': 'string'
}

Response Structure

  • (dict) --

    • RevenueAttributionAllocationId (string) --

      Unique allocation identifier.

    • RevenueAttributionIdentifier (string) --

      The revenue attribution identifier.

    • EntityType (string) --

      The type of the associated deal entity.

    • EntityIdentifier (string) --

      The unique identifier of the associated deal entity.

    • EntityName (string) --

      The display name of the associated deal entity.

    • CustomerAwsAccountId (string) --

      The customer AWS account ID for this associated deal entity.

    • RevenueSharePercent (string) --

      Revenue share percentage.

    • EffectiveFrom (string) --

      First day of the effective month.

    • EffectiveUntil (string) --

      Last day of the effective month.

    • Status (string) --

      Current allocation status.

    • CreatedDate (datetime) --

      When the allocation was first created.

    • LastModifiedDate (datetime) --

      When the allocation was last modified.

    • RevenueAttributionRevision (string) --

      The revision of this allocation version.

    • RevenueAttributionLatestRevision (string) --

      The latest committed revision.

ListTagsForResource (new) Link ¶

Returns the tags associated with the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • tags (list) --

      The tags associated with the resource.

      • (dict) --

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

        • Key (string) --

          The key portion of the tag.

        • Value (string) --

          The value portion of the tag.

ListRevenueAttributions (new) Link ¶

Returns a paginated list of revenue attributions with optional filters.

See also: AWS API Documentation

Request Syntax

client.list_revenue_attributions(
    Catalog='AWS'|'Sandbox',
    Identifiers=[
        'string',
    ],
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='LastModifiedDate',
    SortOrder='ASCENDING'|'DESCENDING',
    MaxResults=123,
    NextToken='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog to list revenue attributions from.

type Identifiers:

list

param Identifiers:

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

  • (string) --

type CreatedAfter:

datetime

param CreatedAfter:

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

type CreatedBefore:

datetime

param CreatedBefore:

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

type SortBy:

string

param SortBy:

The field to sort revenue attributions by.

type SortOrder:

string

param SortOrder:

The direction to sort results.

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'RevenueAttributionSummaries': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Catalog': 'AWS'|'Sandbox',
            'Name': 'string',
            'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
            'MarketplaceProduct': {
                'ProductId': 'string',
                'ProductCode': 'string',
                'ProductName': 'string'
            },
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1),
            'LatestRevision': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'TotalActiveRevenueAttributionAllocationCount': 123,
            'TotalRevenueAttributionAllocationCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RevenueAttributionSummaries (list) --

      The list of revenue attribution summaries.

      • (dict) --

        Summary representation of a revenue attribution returned in list operations.

        • Arn (string) --

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

        • Id (string) --

          The unique identifier of the revenue attribution.

        • Catalog (string) --

          The catalog that the revenue attribution belongs to.

        • Name (string) --

          The display name of the revenue attribution.

        • TenancyModel (string) --

          The tenancy model for this revenue attribution.

        • MarketplaceProduct (dict) --

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

          • ProductId (string) --

            The product identifier provided at attribution creation.

          • ProductCode (string) --

            The AWS Marketplace product code resolved using the product identifier.

          • ProductName (string) --

            The display name of the AWS Marketplace product.

        • CreatedDate (datetime) --

          The date when the revenue attribution was created.

        • LastModifiedDate (datetime) --

          The date when the revenue attribution was last modified.

        • LatestRevision (string) --

          The latest revision of the revenue attribution resource.

        • EffectiveFrom (string) --

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

        • EffectiveUntil (string) --

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

        • TotalActiveRevenueAttributionAllocationCount (integer) --

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

        • TotalRevenueAttributionAllocationCount (integer) --

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

    • NextToken (string) --

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

StartRevenueAttributionAllocationsTask (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.start_revenue_attribution_allocations_task(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string',
    RevenueAttributionRevision='string',
    RevenueShareAllocations=[
        {
            'Action': 'CREATE'|'UPDATE',
            'RevenueAttributionAllocationId': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityIdentifier': 'string',
            'CustomerAwsAccountId': 'string',
            'RevenueSharePercent': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Status': 'ACTIVE'|'INACTIVE'
        },
    ],
    ClientToken='string',
    Description='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog context for this operation.

type RevenueAttributionIdentifier:

string

param RevenueAttributionIdentifier:

[REQUIRED]

The revenue attribution identifier.

type RevenueAttributionRevision:

string

param RevenueAttributionRevision:

[REQUIRED]

Current revision of the revenue attribution for optimistic locking.

type RevenueShareAllocations:

list

param RevenueShareAllocations:

[REQUIRED]

The list of allocation changes to process in this batch.

  • (dict) --

    A single allocation change within a batch request.

    • Action (string) -- [REQUIRED]

      The operation type: CREATE or UPDATE.

    • RevenueAttributionAllocationId (string) --

      The allocation to update. Required when Action is UPDATE.

    • EntityType (string) -- [REQUIRED]

      The type of the associated deal entity.

    • EntityIdentifier (string) -- [REQUIRED]

      The unique identifier of the associated deal entity.

    • CustomerAwsAccountId (string) -- [REQUIRED]

      The customer AWS account ID for this associated deal entity.

    • RevenueSharePercent (string) -- [REQUIRED]

      Revenue share percentage.

    • EffectiveFrom (string) -- [REQUIRED]

      The effective start date for this allocation.

    • EffectiveUntil (string) -- [REQUIRED]

      The effective end date for this allocation.

    • Status (string) --

      Allocation status. Defaults to ACTIVE on CREATE.

type ClientToken:

string

param ClientToken:

Idempotency token for deduplication and retry.

This field is autopopulated if not provided.

type Description:

string

param Description:

Human-readable description of the batch.

rtype:

dict

returns:

Response Syntax

{
    'TaskId': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'Catalog': 'AWS'|'Sandbox',
    'RevenueAttributionArn': 'string',
    'StartedAt': datetime(2015, 1, 1),
    'TotalRevenueAttributionAllocationRecords': 123
}

Response Structure

  • (dict) --

    • TaskId (string) --

      Unique identifier for the submitted task.

    • Status (string) --

      Initial task status. Always IN_PROGRESS on successful submission.

    • Catalog (string) --

      The catalog used for this task.

    • RevenueAttributionArn (string) --

      ARN of the revenue attribution resource.

    • StartedAt (datetime) --

      When processing started.

    • TotalRevenueAttributionAllocationRecords (integer) --

      Total revenue attribution allocation records in the batch.

TagResource (new) Link ¶

Adds or overwrites one or more tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type tags:

list

param tags:

[REQUIRED]

The tags to add to the resource.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The key portion of the tag.

    • Value (string) -- [REQUIRED]

      The value portion of the tag.

returns:

None

UpdateRevenueAttribution (new) Link ¶

Updates an existing revenue attribution record.

See also: AWS API Documentation

Request Syntax

client.update_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    Identifier='string',
    ClientToken='string',
    Description='string',
    Revision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog that the revenue attribution belongs to.

type Identifier:

string

param Identifier:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the update request.

This field is autopopulated if not provided.

type Description:

string

param Description:

The updated description of the revenue attribution.

type Revision:

string

param Revision:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Description': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestRevision': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the updated revenue attribution.

    • Arn (string) --

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

    • Description (string) --

      The updated description of the revenue attribution.

    • LastModifiedDate (datetime) --

      The date when the attribution was last modified.

    • LatestRevision (string) --

      The latest revision of the attribution after the update.

CreateRevenueAttribution (new) Link ¶

Creates a new revenue attribution record in the specified catalog.

See also: AWS API Documentation

Request Syntax

client.create_revenue_attribution(
    Catalog='AWS'|'Sandbox',
    ClientToken='string',
    Name='string',
    Description='string',
    TenancyModel='MULTI_TENANT'|'SINGLE_TENANT',
    ProductIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the revenue attribution.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type Name:

string

param Name:

[REQUIRED]

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

type Description:

string

param Description:

A description of the revenue attribution.

type TenancyModel:

string

param TenancyModel:

[REQUIRED]

The tenancy model for this revenue attribution.

type ProductIdentifier:

string

param ProductIdentifier:

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

type Tags:

list

param Tags:

Tags to associate with the revenue attribution upon creation.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The key portion of the tag.

    • Value (string) -- [REQUIRED]

      The value portion of the tag.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
    'MarketplaceProduct': {
        'ProductId': 'string',
        'ProductCode': 'string',
        'ProductName': 'string'
    },
    'Revision': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the newly created revenue attribution.

    • Arn (string) --

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

    • Name (string) --

      The name of the revenue attribution.

    • Description (string) --

      The description of the revenue attribution.

    • TenancyModel (string) --

      The tenancy model for this revenue attribution.

    • MarketplaceProduct (dict) --

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

      • ProductId (string) --

        The product identifier provided at attribution creation.

      • ProductCode (string) --

        The AWS Marketplace product code resolved using the product identifier.

      • ProductName (string) --

        The display name of the AWS Marketplace product.

    • Revision (string) --

      The revision of the newly created attribution resource.

CreateMarketplaceRevenueShare (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_marketplace_revenue_share(
    Catalog='AWS'|'Sandbox',
    ClientToken='string',
    ProductId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the marketplace revenue share.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type ProductId:

string

param ProductId:

[REQUIRED]

The AWS Marketplace product identifier for this revenue share.

type Tags:

list

param Tags:

Tags to associate with the marketplace revenue share upon creation.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The key portion of the tag.

    • Value (string) -- [REQUIRED]

      The value portion of the tag.

rtype:

dict

returns:

Response Syntax

{
    'ProductId': 'string',
    'Arn': 'string',
    'Catalog': 'AWS'|'Sandbox',
    'ProductCode': 'string',
    'ProductName': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'Revision': 123
}

Response Structure

  • (dict) --

    • ProductId (string) --

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

    • Arn (string) --

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

    • Catalog (string) --

      The catalog that the marketplace revenue share belongs to.

    • ProductCode (string) --

      The AWS Marketplace product code.

    • ProductName (string) --

      The display name of the AWS Marketplace product.

    • CreatedDate (datetime) --

      The date when the marketplace revenue share was created.

    • LastModifiedDate (datetime) --

      The date when the marketplace revenue share was last modified.

    • Revision (integer) --

      The revision number of the newly created marketplace revenue share.

UntagResource (new) Link ¶

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type tagKeys:

list

param tagKeys:

[REQUIRED]

The tag keys to remove from the resource.

  • (string) --

returns:

None

UpdateMarketplaceRevenueShareAllocation (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    MarketplaceRevenueShareAllocationId='string',
    MarketplaceRevenueShareRevision='string',
    ClientToken='string',
    EffectiveFrom='string',
    EffectiveUntil='string',
    RevenueSharePercent='string',
    Status='ACTIVE'|'INACTIVE'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog containing the allocation.

type ProductId:

string

param ProductId:

[REQUIRED]

The AWS Marketplace product identifier for the parent revenue share.

type MarketplaceRevenueShareAllocationId:

string

param MarketplaceRevenueShareAllocationId:

[REQUIRED]

The identifier of the allocation to update.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the update request.

This field is autopopulated if not provided.

type EffectiveFrom:

string

param EffectiveFrom:

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

type EffectiveUntil:

string

param EffectiveUntil:

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

type RevenueSharePercent:

string

param RevenueSharePercent:

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

type Status:

string

param Status:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'ProductId': 'string',
    'ProductName': 'string',
    'Arn': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestMarketplaceRevenueShareRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the updated allocation.

    • ProductId (string) --

      The AWS Marketplace product identifier.

    • ProductName (string) --

      The display name of the AWS Marketplace product.

    • Arn (string) --

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

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

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

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • LatestMarketplaceRevenueShareRevision (string) --

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

CreateMarketplaceRevenueShareAllocation (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_marketplace_revenue_share_allocation(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    ClientToken='string',
    EffectiveFrom='string',
    EffectiveUntil='string',
    RevenueSharePercent='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog in which to create the allocation.

type ProductId:

string

param ProductId:

[REQUIRED]

The AWS Marketplace product identifier for the parent revenue share.

type ClientToken:

string

param ClientToken:

A unique token to ensure idempotency of the create request.

This field is autopopulated if not provided.

type EffectiveFrom:

string

param EffectiveFrom:

[REQUIRED]

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

type EffectiveUntil:

string

param EffectiveUntil:

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

type RevenueSharePercent:

string

param RevenueSharePercent:

[REQUIRED]

The revenue share percentage for this allocation.

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationId': 'string',
    'ProductId': 'string',
    'ProductName': 'string',
    'Arn': 'string',
    'EffectiveFrom': 'string',
    'EffectiveUntil': 'string',
    'RevenueSharePercent': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'CreatedDate': datetime(2015, 1, 1),
    'LastModifiedDate': datetime(2015, 1, 1),
    'LatestMarketplaceRevenueShareRevision': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationId (string) --

      The unique identifier of the newly created allocation.

    • ProductId (string) --

      The AWS Marketplace product identifier.

    • ProductName (string) --

      The display name of the AWS Marketplace product.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the allocation.

    • EffectiveFrom (string) --

      The effective start date of the allocation.

    • EffectiveUntil (string) --

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

    • RevenueSharePercent (string) --

      The revenue share percentage.

    • Status (string) --

      The status of the allocation.

    • CreatedDate (datetime) --

      The date when the allocation was created.

    • LastModifiedDate (datetime) --

      The date when the allocation was last modified.

    • LatestMarketplaceRevenueShareRevision (string) --

      The latest revision of the parent marketplace revenue share.

ListMarketplaceRevenueShareAllocations (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_marketplace_revenue_share_allocations(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    Status='ACTIVE'|'INACTIVE',
    AfterEffectiveFrom='string',
    BeforeEffectiveFrom='string',
    SortBy='EffectiveFrom',
    SortOrder='ASCENDING'|'DESCENDING',
    MaxResults=123,
    NextToken='string',
    MarketplaceRevenueShareRevision='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog containing the allocations.

type ProductId:

string

param ProductId:

[REQUIRED]

The AWS Marketplace product identifier for the parent revenue share.

type Status:

string

param Status:

Filter by allocation status.

type AfterEffectiveFrom:

string

param AfterEffectiveFrom:

Inclusive lower bound for EffectiveFrom date filter.

type BeforeEffectiveFrom:

string

param BeforeEffectiveFrom:

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

type SortBy:

string

param SortBy:

The field to sort marketplace revenue share allocations by.

type SortOrder:

string

param SortOrder:

The direction to sort results. Defaults to DESCENDING.

type MaxResults:

integer

param MaxResults:

Maximum number of results per page.

type NextToken:

string

param NextToken:

Pagination token from a previous response.

type MarketplaceRevenueShareRevision:

string

param MarketplaceRevenueShareRevision:

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

rtype:

dict

returns:

Response Syntax

{
    'MarketplaceRevenueShareAllocationSummaries': [
        {
            'MarketplaceRevenueShareAllocationId': 'string',
            'ProductId': 'string',
            'ProductName': 'string',
            'Arn': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'RevenueSharePercent': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MarketplaceRevenueShareAllocationSummaries (list) --

      The list of allocation summaries for the current page.

      • (dict) --

        Summary information about a marketplace revenue share allocation.

        • MarketplaceRevenueShareAllocationId (string) --

          The unique identifier of the allocation.

        • ProductId (string) --

          The AWS Marketplace product identifier.

        • ProductName (string) --

          The display name of the AWS Marketplace product.

        • Arn (string) --

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

        • EffectiveFrom (string) --

          The effective start date of the allocation.

        • EffectiveUntil (string) --

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

        • RevenueSharePercent (string) --

          The revenue share percentage.

        • Status (string) --

          The status of the allocation.

        • CreatedDate (datetime) --

          The date when the allocation was created.

        • LastModifiedDate (datetime) --

          The date when the allocation was last modified.

    • NextToken (string) --

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