PartnerCentralRevenueMeasurementAPI / Paginator / ListMarketplaceRevenueShares

ListMarketplaceRevenueShares

class PartnerCentralRevenueMeasurementAPI.Paginator.ListMarketplaceRevenueShares

paginator = client.get_paginator('list_marketplace_revenue_shares')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='AWS'|'Sandbox',
    ProductIds=[
        'string',
    ],
    ProductCodes=[
        'string',
    ],
    SortBy='LastModifiedDate',
    SortOrder='ASCENDING'|'DESCENDING',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog to list marketplace revenue shares from.

• ProductIds (list) –

  Filter results to only include shares with these product identifiers.

  • (string) –

• ProductCodes (list) –

  Filter results to only include shares with these product codes.

  • (string) –

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

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

• CreatedAfter (datetime) – Filter results to only include marketplace revenue shares created after this timestamp.

• CreatedBefore (datetime) – Filter results to only include marketplace revenue shares created before this timestamp.

• 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

{
    '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
        },
    ],

}

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.