ListMarketplaceRevenueShareAllocations
Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range. Supports historical reads at a specific share revision.
Request Parameters
- Catalog
-
The catalog containing the allocations.
Type: String
Valid Values:
AWS | SandboxRequired: 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
- AfterEffectiveFrom
-
Inclusive lower bound for EffectiveFrom date filter.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2}Required: No
- BeforeEffectiveFrom
-
Exclusive upper bound for EffectiveFrom date filter (half-open range).
Type: String
Length Constraints: Fixed length of 10.
Pattern:
\d{4}-\d{2}-\d{2}Required: No
- MarketplaceRevenueShareRevision
-
Optional share revision for historical list. Returns allocations as they existed at this revision.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 19.
Pattern:
[1-9][0-9]*Required: No
- MaxResults
-
Maximum number of results per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Pagination token from a previous response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\S]+Required: No
- SortBy
-
The field to sort marketplace revenue share allocations by.
Type: String
Valid Values:
EffectiveFromRequired: No
- SortOrder
-
The direction to sort results. Defaults to DESCENDING.
Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
- Status
-
Filter by allocation status.
Type: String
Valid Values:
ACTIVE | INACTIVERequired: No
Response Elements
The following elements are returned by the service.
- MarketplaceRevenueShareAllocationSummaries
-
The list of allocation summaries for the current page.
Type: Array of MarketplaceRevenueShareAllocationSummary objects
- NextToken
-
Pagination token for the next page. Absent if no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\S]+
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
- 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: