PartnerCentralRevenueMeasurementAPI / Paginator / ListRevenueAttributions

ListRevenueAttributions

class PartnerCentralRevenueMeasurementAPI.Paginator.ListRevenueAttributions

paginator = client.get_paginator('list_revenue_attributions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog to list revenue attributions from.

• Identifiers (list) –

  Filter results to only include revenue attributions with the specified identifiers.

  • (string) –

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

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

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

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

• 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

{
    'RevenueAttributionSummaries': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Catalog': 'AWS'|'Sandbox',
            'Name': 'string',
            'TenancyModel': 'MULTI_TENANT'|'SINGLE_TENANT',
            'MarketplaceProduct': {
                'ProductId': 'string',
                'ProductCode': 'string',
                'ProductName': 'string'
            },
            'CreatedDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1),
            'LatestRevision': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'TotalActiveRevenueAttributionAllocationCount': 123,
            'TotalRevenueAttributionAllocationCount': 123
        },
    ],

}

Response Structure

• (dict) –

  • RevenueAttributionSummaries (list) –

    The list of revenue attribution summaries.

    • (dict) –

      Summary representation of a revenue attribution returned in list operations.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the revenue attribution.

      • Id (string) –

        The unique identifier of the revenue attribution.

      • Catalog (string) –

        The catalog that the revenue attribution belongs to.

      • Name (string) –

        The display name of the revenue attribution.

      • TenancyModel (string) –

        The tenancy model for this revenue attribution.

      • MarketplaceProduct (dict) –

        The AWS Marketplace product attributes associated with this attribution, if set.

        • ProductId (string) –

          The product identifier provided at attribution creation.

        • ProductCode (string) –

          The AWS Marketplace product code resolved using the product identifier.

        • ProductName (string) –

          The display name of the AWS Marketplace product.

      • CreatedDate (datetime) –

        The date when the revenue attribution was created.

      • LastModifiedDate (datetime) –

        The date when the revenue attribution was last modified.

      • LatestRevision (string) –

        The latest revision of the revenue attribution resource.

      • EffectiveFrom (string) –

        The date from which this revenue attribution is effective, derived from the earliest allocation start date (YYYY-MM-DD).

      • EffectiveUntil (string) –

        The date until which this revenue attribution is effective, derived from the latest allocation end date (YYYY-MM-DD).

      • TotalActiveRevenueAttributionAllocationCount (integer) –

        The total number of allocations under this revenue attribution whose Status is ACTIVE.

      • TotalRevenueAttributionAllocationCount (integer) –

        The total number of allocations under this revenue attribution, counting both ACTIVE and INACTIVE.