PartnerCentralRevenueMeasurementAPI / Client / list_revenue_attribution_allocations

list_revenue_attribution_allocations

PartnerCentralRevenueMeasurementAPI.Client.list_revenue_attribution_allocations(**kwargs)

Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.

See also: AWS API Documentation

Request Syntax

response = client.list_revenue_attribution_allocations(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string',
    EntityTypeFilters=[
        'OFFER'|'OPPORTUNITY',
    ],
    EntityIdentifierFilters=[
        'string',
    ],
    CustomerAwsAccountIdFilters=[
        'string',
    ],
    StatusFilter='ACTIVE'|'INACTIVE',
    AfterEffectiveFrom='string',
    BeforeEffectiveFrom='string',
    AfterEffectiveUntil='string',
    BeforeEffectiveUntil='string',
    SortBy='EffectiveFrom',
    SortOrder='ASCENDING'|'DESCENDING',
    RevenueAttributionRevision='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    The catalog that contains the resource.

  • RevenueAttributionIdentifier (string) –

    [REQUIRED]

    The revenue attribution identifier to query.

  • EntityTypeFilters (list) –

    Filter by deal entity types.

    • (string) –

  • EntityIdentifierFilters (list) –

    Filter by deal entity identifiers.

    • (string) –

  • CustomerAwsAccountIdFilters (list) –

    Filter by customer AWS account IDs for associated deal entities.

    • (string) –

  • StatusFilter (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).

  • AfterEffectiveUntil (string) – Inclusive lower bound for EffectiveUntil date filter.

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

  • SortBy (string) – Field to sort by.

  • SortOrder (string) – Sort direction. Defaults to ASCENDING.

  • RevenueAttributionRevision (string) – Point-in-time revision number to query.

  • MaxResults (integer) – Maximum results per page.

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

Return type:

dict

Returns:

Response Syntax

{
    'RevenueAttributionAllocationSummaries': [
        {
            'RevenueAttributionAllocationId': 'string',
            'RevenueAttributionIdentifier': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityIdentifier': 'string',
            'EntityName': 'string',
            'CustomerAwsAccountId': 'string',
            'RevenueSharePercent': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Status': 'ACTIVE'|'INACTIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RevenueAttributionAllocationSummaries (list) –

      Paginated list of allocations matching filters.

      • (dict) –

        Summary information about a revenue attribution allocation.

        • RevenueAttributionAllocationId (string) –

          Unique allocation identifier.

        • RevenueAttributionIdentifier (string) –

          The revenue attribution identifier.

        • EntityType (string) –

          The type of the associated deal entity.

        • EntityIdentifier (string) –

          The unique identifier of the associated deal entity.

        • EntityName (string) –

          The display name of the associated deal entity.

        • CustomerAwsAccountId (string) –

          The customer AWS account ID for this associated deal entity.

        • RevenueSharePercent (string) –

          Revenue share percentage.

        • EffectiveFrom (string) –

          First day of the effective month.

        • EffectiveUntil (string) –

          Last day of the effective month.

        • Status (string) –

          Current allocation status.

    • NextToken (string) –

      Token for next page. Absent if no more results.

Exceptions