PartnerCentralRevenueMeasurementAPI / Paginator / ListMarketplaceRevenueShareAllocations

ListMarketplaceRevenueShareAllocations

class PartnerCentralRevenueMeasurementAPI.Paginator.ListMarketplaceRevenueShareAllocations

paginator = client.get_paginator('list_marketplace_revenue_share_allocations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PartnerCentralRevenueMeasurementAPI.Client.list_marketplace_revenue_share_allocations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='AWS'|'Sandbox',
    ProductId='string',
    Status='ACTIVE'|'INACTIVE',
    AfterEffectiveFrom='string',
    BeforeEffectiveFrom='string',
    SortBy='EffectiveFrom',
    SortOrder='ASCENDING'|'DESCENDING',
    MarketplaceRevenueShareRevision='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.