list_revenue_attribution_allocations ¶

def list_revenue_attribution_allocations(
    self,
    catalog: "capo_partnercentral_revenue_measurement.types.catalog_name.CatalogName",
    revenue_attribution_identifier: "capo_partnercentral_revenue_measurement.types.revenue_attribution_identifier.RevenueAttributionIdentifier",
    *,
    config_overrides: Optional[PartnerCentralRevenueMeasurementClientConfig] = None,
    entity_type_filters: Optional[
        "capo_partnercentral_revenue_measurement.types.entity_type_filter_list.EntityTypeFilterList"
    ] = None,
    entity_identifier_filters: Optional[
        "capo_partnercentral_revenue_measurement.types.entity_identifier_filter_list.EntityIdentifierFilterList"
    ] = None,
    customer_aws_account_id_filters: Optional[
        "capo_partnercentral_revenue_measurement.types.customer_aws_account_id_filter_list.CustomerAwsAccountIdFilterList"
    ] = None,
    status_filter: 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,
    after_effective_until: Optional[
        "capo_partnercentral_revenue_measurement.types.allocation_effective_date_string.AllocationEffectiveDateString"
    ] = None,
    before_effective_until: Optional[
        "capo_partnercentral_revenue_measurement.types.allocation_effective_date_string.AllocationEffectiveDateString"
    ] = None,
    sort_by: Optional[
        "capo_partnercentral_revenue_measurement.types.revenue_attribution_allocation_sort_field.RevenueAttributionAllocationSortField"
    ] = None,
    sort_order: Optional[
        "capo_partnercentral_revenue_measurement.types.sort_order.SortOrder"
    ] = None,
    revenue_attribution_revision: Optional[
        "capo_partnercentral_revenue_measurement.types.revision_token.RevisionToken"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional[
        "capo_partnercentral_revenue_measurement.types.next_token.NextToken"
    ] = None,
) -> "capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_output.ListRevenueAttributionAllocationsOutput":
    """<p>Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.</p>

    Args:
        catalog: <p>The catalog that contains the resource.</p>
        revenue_attribution_identifier: <p>The revenue attribution identifier to query.</p>
        entity_type_filters: <p>Filter by deal entity types.</p>
        entity_identifier_filters: <p>Filter by deal entity identifiers.</p>
        customer_aws_account_id_filters: <p>Filter by customer AWS account IDs for associated deal entities.</p>
        status_filter: <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>
        after_effective_until: <p>Inclusive lower bound for EffectiveUntil date filter.</p>
        before_effective_until: <p>Exclusive upper bound for EffectiveUntil date filter (half-open range).</p>
        sort_by: <p>Field to sort by.</p>
        sort_order: <p>Sort direction. Defaults to ASCENDING.</p>
        revenue_attribution_revision: <p>Point-in-time revision number to query.</p>
        max_results: <p>Maximum results per page.</p>
        next_token: <p>Pagination token from previous response.</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 ListRevenueAttributionAllocations

        >>> client.list_revenue_attribution_allocations(catalog='AWS', revenue_attribution_identifier='ra-0a1b2c3d4e5f6')
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_input.ListRevenueAttributionAllocationsInput]",
    ) -> OperationResponse[
        "capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_output.ListRevenueAttributionAllocationsOutput"
    ]:
        import capo_partnercentral_revenue_measurement._operations.partner_central_revenue_measurement.list_revenue_attribution_allocations

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

    def _redact_input(
        input_: "capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_input.ListRevenueAttributionAllocationsInput",
    ) -> dict[str, Any]:
        import capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_input

        return capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_output.ListRevenueAttributionAllocationsOutput",
    ) -> dict[str, Any]:
        import capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_output

        return capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListRevenueAttributionAllocations",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_partnercentral_revenue_measurement.types.list_revenue_attribution_allocations_input.ListRevenueAttributionAllocationsInput = {
        "catalog": catalog,
        "revenue_attribution_identifier": revenue_attribution_identifier,
    }
    if entity_type_filters is not None:
        input_["entity_type_filters"] = entity_type_filters
    if entity_identifier_filters is not None:
        input_["entity_identifier_filters"] = entity_identifier_filters
    if customer_aws_account_id_filters is not None:
        input_["customer_aws_account_id_filters"] = customer_aws_account_id_filters
    if status_filter is not None:
        input_["status_filter"] = status_filter
    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 after_effective_until is not None:
        input_["after_effective_until"] = after_effective_until
    if before_effective_until is not None:
        input_["before_effective_until"] = before_effective_until
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if revenue_attribution_revision is not None:
        input_["revenue_attribution_revision"] = revenue_attribution_revision
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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