PartnerCentralRevenueMeasurementAPI / Client / start_revenue_attribution_allocations_task

start_revenue_attribution_allocations_task

PartnerCentralRevenueMeasurementAPI.Client.start_revenue_attribution_allocations_task(**kwargs)

Submits a batch of up to 250 allocation changes (CREATE and/or UPDATE) for asynchronous processing. Returns a TaskId for tracking.

See also: AWS API Documentation

Request Syntax

response = client.start_revenue_attribution_allocations_task(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string',
    RevenueAttributionRevision='string',
    RevenueShareAllocations=[
        {
            'Action': 'CREATE'|'UPDATE',
            'RevenueAttributionAllocationId': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityIdentifier': 'string',
            'CustomerAwsAccountId': 'string',
            'RevenueSharePercent': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Status': 'ACTIVE'|'INACTIVE'
        },
    ],
    ClientToken='string',
    Description='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    The catalog context for this operation.

  • RevenueAttributionIdentifier (string) –

    [REQUIRED]

    The revenue attribution identifier.

  • RevenueAttributionRevision (string) –

    [REQUIRED]

    Current revision of the revenue attribution for optimistic locking.

  • RevenueShareAllocations (list) –

    [REQUIRED]

    The list of allocation changes to process in this batch.

    • (dict) –

      A single allocation change within a batch request.

      • Action (string) – [REQUIRED]

        The operation type: CREATE or UPDATE.

      • RevenueAttributionAllocationId (string) –

        The allocation to update. Required when Action is UPDATE.

      • EntityType (string) – [REQUIRED]

        The type of the associated deal entity.

      • EntityIdentifier (string) – [REQUIRED]

        The unique identifier of the associated deal entity.

      • CustomerAwsAccountId (string) – [REQUIRED]

        The customer AWS account ID for this associated deal entity.

      • RevenueSharePercent (string) – [REQUIRED]

        Revenue share percentage.

      • EffectiveFrom (string) – [REQUIRED]

        The effective start date for this allocation.

      • EffectiveUntil (string) – [REQUIRED]

        The effective end date for this allocation.

      • Status (string) –

        Allocation status. Defaults to ACTIVE on CREATE.

  • ClientToken (string) –

    Idempotency token for deduplication and retry.

    This field is autopopulated if not provided.

  • Description (string) – Human-readable description of the batch.

Return type:

dict

Returns:

Response Syntax

{
    'TaskId': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'Catalog': 'AWS'|'Sandbox',
    'RevenueAttributionArn': 'string',
    'StartedAt': datetime(2015, 1, 1),
    'TotalRevenueAttributionAllocationRecords': 123
}

Response Structure

  • (dict) –

    • TaskId (string) –

      Unique identifier for the submitted task.

    • Status (string) –

      Initial task status. Always IN_PROGRESS on successful submission.

    • Catalog (string) –

      The catalog used for this task.

    • RevenueAttributionArn (string) –

      ARN of the revenue attribution resource.

    • StartedAt (datetime) –

      When processing started.

    • TotalRevenueAttributionAllocationRecords (integer) –

      Total revenue attribution allocation records in the batch.

Exceptions