PartnerCentralRevenueMeasurementAPI / Client / update_marketplace_revenue_share_allocation

update_marketplace_revenue_share_allocation

PartnerCentralRevenueMeasurementAPI.Client.update_marketplace_revenue_share_allocation(**kwargs)

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

response = 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'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    The catalog containing the allocation.

  • ProductId (string) –

    [REQUIRED]

    The AWS Marketplace product identifier for the parent revenue share.

  • MarketplaceRevenueShareAllocationId (string) –

    [REQUIRED]

    The identifier of the allocation to update.

  • MarketplaceRevenueShareRevision (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    A unique token to ensure idempotency of the update request.

    This field is autopopulated if not provided.

  • EffectiveFrom (string) – The new effective start date. Must be the first day of a month. Only modifiable on future-dated allocations.

  • EffectiveUntil (string) – The new effective end date. Must be the last day of a month and on or after today.

  • RevenueSharePercent (string) – The new revenue share percentage. Only modifiable on future-dated allocations.

  • Status (string) – The new status. Set to INACTIVE for soft-delete. Only modifiable on future-dated allocations.

Return type:

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.

Exceptions