PartnerCentralRevenueMeasurementAPI / Client / get_revenue_attribution_allocations_task

get_revenue_attribution_allocations_task

PartnerCentralRevenueMeasurementAPI.Client.get_revenue_attribution_allocations_task(**kwargs)

Retrieves the current status of a previously submitted allocations task. When COMPLETE, includes the latest revision. When FAILED, includes error details.

See also: AWS API Documentation

Request Syntax

response = client.get_revenue_attribution_allocations_task(
    Catalog='AWS'|'Sandbox',
    RevenueAttributionIdentifier='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    The catalog that contains the resource.

  • RevenueAttributionIdentifier (string) –

    [REQUIRED]

    The revenue attribution identifier.

Return type:

dict

Returns:

Response Syntax

{
    'TaskId': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'Catalog': 'AWS'|'Sandbox',
    'RevenueAttributionArn': 'string',
    'StartedAt': datetime(2015, 1, 1),
    'EndedAt': datetime(2015, 1, 1),
    'TotalRevenueAttributionAllocationRecords': 123,
    'Description': 'string',
    'RevenueAttributionLatestRevision': 'string',
    'ErrorDetailList': [
        {
            'RevenueAttributionAllocationId': 'string',
            'EntityType': 'OFFER'|'OPPORTUNITY',
            'EntityId': 'string',
            'CustomerAwsAccountId': 'string',
            'EffectiveFrom': 'string',
            'EffectiveUntil': 'string',
            'Action': 'CREATE'|'UPDATE',
            'ErrorCode': 'ALLOCATION_CAP_EXCEEDED'|'RESOURCE_NOT_FOUND'|'IMMUTABLE_ALLOCATION'|'ACCESS_DENIED'|'INVALID_VALUE'|'CONCURRENT_MODIFICATION'|'INTERNAL_ERROR',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • TaskId (string) –

      The unique identifier for the asynchronous task.

    • Status (string) –

      Current task status.

    • Catalog (string) –

      The catalog used for this task.

    • RevenueAttributionArn (string) –

      ARN of the revenue attribution resource.

    • StartedAt (datetime) –

      When processing started.

    • EndedAt (datetime) –

      When processing ended. Only present when COMPLETE or FAILED.

    • TotalRevenueAttributionAllocationRecords (integer) –

      Total revenue attribution allocation records in the batch.

    • Description (string) –

      Human-readable description, if provided at creation.

    • RevenueAttributionLatestRevision (string) –

      The revision number assigned to this batch. Only present when COMPLETE.

    • ErrorDetailList (list) –

      All errors discovered during async processing. Only present when FAILED.

      • (dict) –

        Details of a validation error for a single revenue attribution allocation record.

        • RevenueAttributionAllocationId (string) –

          The allocation identifier. Present for UPDATE actions; absent for CREATE actions.

        • EntityType (string) –

          The deal entity type of the failing record.

        • EntityId (string) –

          The deal entity identifier of the failing record.

        • CustomerAwsAccountId (string) –

          The customer AWS account ID of the failing record.

        • EffectiveFrom (string) –

          Effective start date of the failing record.

        • EffectiveUntil (string) –

          Effective end date of the failing record.

        • Action (string) –

          The action that was attempted.

        • ErrorCode (string) –

          Machine-readable error code.

        • ErrorMessage (string) –

          Human-readable error description.

Exceptions