PartnerCentralRevenueMeasurementAPI / Client / list_marketplace_revenue_shares

list_marketplace_revenue_shares

PartnerCentralRevenueMeasurementAPI.Client.list_marketplace_revenue_shares(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = 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)
)
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) –

  • MaxResults (integer) – The maximum number of results to return in a single call.

  • NextToken (string) – Token for pagination. Use the value returned in the previous response to retrieve the next page.

  • 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.

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

Exceptions