View a markdown version of this page

StartRevenueAttributionAllocationsTask - AWS Partner Central

StartRevenueAttributionAllocationsTask

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

Request Parameters

Catalog

The catalog context for this operation.

Type: String

Valid Values: AWS | Sandbox

Required: Yes

RevenueAttributionIdentifier

The revenue attribution identifier.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 1011.

Pattern: (arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/revenue-attribution/ra-[a-z0-9]{13}|ra-[a-z0-9]{13})

Required: Yes

RevenueAttributionRevision

Current revision of the revenue attribution for optimistic locking.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 19.

Pattern: [1-9][0-9]*

Required: Yes

RevenueShareAllocations

The list of allocation changes to process in this batch.

Type: Array of RevenueShareAllocation objects

Array Members: Minimum number of 1 item. Maximum number of 250 items.

Required: Yes

ClientToken

Idempotency token for deduplication and retry.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]{1,64}

Required: No

Description

Human-readable description of the batch.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\x20-\x7E]*

Required: No

Response Elements

The following elements are returned by the service.

Catalog

The catalog used for this task.

Type: String

Valid Values: AWS | Sandbox

RevenueAttributionArn

ARN of the revenue attribution resource.

Type: String

StartedAt

When processing started.

Type: Timestamp

Status

Initial task status. Always IN_PROGRESS on successful submission.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | FAILED

TaskId

Unique identifier for the submitted task.

Type: String

Length Constraints: Fixed length of 21.

Pattern: raatask-[a-z0-9]{13}

TotalRevenueAttributionAllocationRecords

Total revenue attribution allocation records in the batch.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request was denied due to insufficient permissions.

Reason

The reason for the access denial.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

Reason

The reason for the conflict.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

Reason

The reason the resource was not found.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to too many requests. Retry your request.

QuotaCode

The quota code associated with the throttling error.

ServiceCode

The service code associated with the throttling error.

HTTP Status Code: 429

ValidationException

The request failed validation due to invalid input parameters.

FieldList

A list of fields that failed validation.

Reason

The reason for the validation failure.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: