PartnerCentralRevenueMeasurementAPI / Client / list_marketplace_revenue_share_allocations

list_marketplace_revenue_share_allocations

PartnerCentralRevenueMeasurementAPI.Client.list_marketplace_revenue_share_allocations(**kwargs)

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

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

  • Catalog (string) –

    [REQUIRED]

    The catalog containing the allocations.

  • ProductId (string) –

    [REQUIRED]

    The AWS Marketplace product identifier for the parent revenue share.

  • Status (string) – Filter by allocation status.

  • AfterEffectiveFrom (string) – Inclusive lower bound for EffectiveFrom date filter.

  • BeforeEffectiveFrom (string) – Exclusive upper bound for EffectiveFrom date filter (half-open range).

  • SortBy (string) – The field to sort marketplace revenue share allocations by.

  • SortOrder (string) – The direction to sort results. Defaults to DESCENDING.

  • MaxResults (integer) – Maximum number of results per page.

  • NextToken (string) – Pagination token from a previous response.

  • MarketplaceRevenueShareRevision (string) – Optional share revision for historical list. Returns allocations as they existed at this revision.

Return type:

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.

Exceptions