list_marketplace_revenue_shares ¶

def list_marketplace_revenue_shares(
    self,
    catalog: "capo_partnercentral_revenue_measurement.types.catalog_name.CatalogName",
    *,
    config_overrides: Optional[PartnerCentralRevenueMeasurementClientConfig] = None,
    product_ids: Optional[
        "capo_partnercentral_revenue_measurement.types.marketplace_product_id_list.MarketplaceProductIdList"
    ] = None,
    product_codes: Optional[
        "capo_partnercentral_revenue_measurement.types.product_code_list.ProductCodeList"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional[
        "capo_partnercentral_revenue_measurement.types.next_token.NextToken"
    ] = None,
    sort_by: Optional[
        "capo_partnercentral_revenue_measurement.types.marketplace_revenue_share_sort_by.MarketplaceRevenueShareSortBy"
    ] = None,
    sort_order: Optional[
        "capo_partnercentral_revenue_measurement.types.sort_order.SortOrder"
    ] = None,
    created_after: Optional[datetime.datetime] = None,
    created_before: Optional[datetime.datetime] = None,
) -> "capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_shares_output.ListMarketplaceRevenueSharesOutput":
    """<p>Returns a paginated list of marketplace revenue shares with optional filters.</p>

    Args:
        catalog: <p>The catalog to list marketplace revenue shares from.</p>
        product_ids: <p>Filter results to only include shares with these product identifiers.</p>
        product_codes: <p>Filter results to only include shares with these product codes.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>Token for pagination. Use the value returned in the previous response to retrieve the next page.</p>
        sort_by: <p>The field to sort marketplace revenue shares by.</p>
        sort_order: <p>The direction to sort results.</p>
        created_after: <p>Filter results to only include marketplace revenue shares created after this timestamp.</p>
        created_before: <p>Filter results to only include marketplace revenue shares created before this timestamp.</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.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 ListMarketplaceRevenueShares

        >>> client.list_marketplace_revenue_shares(catalog='AWS', max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_shares_input.ListMarketplaceRevenueSharesInput]",
    ) -> OperationResponse[
        "capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_shares_output.ListMarketplaceRevenueSharesOutput"
    ]:
        import capo_partnercentral_revenue_measurement._operations.partner_central_revenue_measurement.list_marketplace_revenue_shares

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMarketplaceRevenueShares")
    )
    input_: capo_partnercentral_revenue_measurement.types.list_marketplace_revenue_shares_input.ListMarketplaceRevenueSharesInput = {
        "catalog": catalog
    }
    if product_ids is not None:
        input_["product_ids"] = product_ids
    if product_codes is not None:
        input_["product_codes"] = product_codes
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before

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