CreateMarketplaceRevenueShareAllocation
Creates a new marketplace revenue share allocation for the specified product.
Request Parameters
- Catalog
-
The catalog in which to create the allocation.
Type: String
Valid Values:
AWS | SandboxRequired: Yes
- EffectiveFrom
-
The effective start date for the allocation. Must be the first day of a month.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2}Required: Yes
- ProductId
-
The AWS Marketplace product identifier for the parent revenue share.
Type: String
Length Constraints: Fixed length of 18.
Pattern:
prod-[a-z0-9]{13}Required: Yes
- RevenueSharePercent
-
The revenue share percentage for this allocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6.
Pattern:
\d{1,3}(\.\d{1,2})?Required: Yes
- ClientToken
-
A unique token to ensure idempotency of the create request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[!-~]{1,64}Required: No
- EffectiveUntil
-
The effective end date for the allocation. Must be the last day of a month (YYYY-MM-DD). Omit for open-ended allocations.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2}Required: No
Response Elements
The following elements are returned by the service.
- Arn
-
The Amazon Resource Name (ARN) of the allocation.
Type: String
- EffectiveFrom
-
The effective start date of the allocation.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2} - MarketplaceRevenueShareAllocationId
-
The unique identifier of the newly created allocation.
Type: String
Length Constraints: Fixed length of 18.
Pattern:
mrsa-[A-Za-z0-9]{13} - ProductId
-
The AWS Marketplace product identifier.
Type: String
Length Constraints: Fixed length of 18.
Pattern:
prod-[a-z0-9]{13} - RevenueSharePercent
-
The revenue share percentage.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6.
Pattern:
\d{1,3}(\.\d{1,2})? - Status
-
The status of the allocation.
Type: String
Valid Values:
ACTIVE | INACTIVE - CreatedDate
-
The date when the allocation was created.
Type: Timestamp
- EffectiveUntil
-
The effective end date of the allocation, or null if open-ended.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2} - LastModifiedDate
-
The date when the allocation was last modified.
Type: Timestamp
- LatestMarketplaceRevenueShareRevision
-
The latest revision of the parent marketplace revenue share.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 19.
Pattern:
[1-9][0-9]* - ProductName
-
The display name of the AWS Marketplace product.
Type: String
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: