list_marketplace_revenue_share_allocations ¶

def list_marketplace_revenue_share_allocations(
    self,
    catalog: "capo_partnercentral_revenue_measurement.types.catalog_name.CatalogName",
    product_id: "capo_partnercentral_revenue_measurement.types.marketplace_product_id.MarketplaceProductId",
    *,
    config_overrides: Optional[PartnerCentralRevenueMeasurementClientConfig] = None,
    status: Optional[
        "capo_partnercentral_revenue_measurement.types.allocation_status.AllocationStatus"
    ] = None,
    after_effective_from: Optional[
        "capo_partnercentral_revenue_measurement.types.allocation_effective_date_string.AllocationEffectiveDateString"
    ] = None,
    before_effective_from: Optional[
        "capo_partnercentral_revenue_measurement.types.allocation_effective_date_string.AllocationEffectiveDateString"
    ] = None,
    sort_by: Optional[
        "capo_partnercentral_revenue_measurement.types.marketplace_revenue_share_allocation_sort_field.MarketplaceRevenueShareAllocationSortField"
    ] = None,
    sort_order: Optional[
        "capo_partnercentral_revenue_measurement.types.sort_order.SortOrder"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional[
        "capo_partnercentral_revenue_measurement.types.next_token.NextToken"
    ] = None,
    marketplace_revenue_share_revision: Optional[
        "capo_partnercentral_revenue_measurement.types.revision_token.RevisionToken"
    ] = None,
) -> "capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_share_allocations_output.ListMarketplaceRevenueShareAllocationsOutput":
    """<p>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.</p>

    Args:
        catalog: <p>The catalog containing the allocations.</p>
        product_id: <p>The AWS Marketplace product identifier for the parent revenue share.</p>
        status: <p>Filter by allocation status.</p>
        after_effective_from: <p>Inclusive lower bound for EffectiveFrom date filter.</p>
        before_effective_from: <p>Exclusive upper bound for EffectiveFrom date filter (half-open range).</p>
        sort_by: <p>The field to sort marketplace revenue share allocations by.</p>
        sort_order: <p>The direction to sort results. Defaults to DESCENDING.</p>
        max_results: <p>Maximum number of results per page.</p>
        next_token: <p>Pagination token from a previous response.</p>
        marketplace_revenue_share_revision: <p>Optional share revision for historical list. Returns allocations as they existed at this revision.</p>

    Raises:
        capo_partnercentral_revenue_measurement.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions.</p>
        capo_partnercentral_revenue_measurement.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_partnercentral_revenue_measurement.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_partnercentral_revenue_measurement.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Retry your request.</p>
        capo_partnercentral_revenue_measurement.errors.validation_exception.ValidationException: <p>The request failed validation due to invalid input parameters.</p>
        capo_partnercentral_revenue_measurement.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example for ListMarketplaceRevenueShareAllocations

        >>> client.list_marketplace_revenue_share_allocations(catalog='AWS', product_id='prod-abc123def4567')
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_share_allocations_input.ListMarketplaceRevenueShareAllocationsInput]",
    ) -> OperationResponse[
        "capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_share_allocations_output.ListMarketplaceRevenueShareAllocationsOutput"
    ]:
        import capo_partnercentral_revenue_measurement._operations.partner_central_revenue_measurement.list_marketplace_revenue_share_allocations

        output, http_response = (
            capo_partnercentral_revenue_measurement._operations.partner_central_revenue_measurement.list_marketplace_revenue_share_allocations.list_marketplace_revenue_share_allocations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMarketplaceRevenueShareAllocations")
    )
    input_: capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_share_allocations_input.ListMarketplaceRevenueShareAllocationsInput = {
        "catalog": catalog,
        "product_id": product_id,
    }
    if status is not None:
        input_["status"] = status
    if after_effective_from is not None:
        input_["after_effective_from"] = after_effective_from
    if before_effective_from is not None:
        input_["before_effective_from"] = before_effective_from
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if marketplace_revenue_share_revision is not None:
        input_["marketplace_revenue_share_revision"] = (
            marketplace_revenue_share_revision
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output