Skip to content

list_billing_adjustment_requests async

list_billing_adjustment_requests(
    *,
    config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
    agreement_id: Optional[AgreementId] = None,
    status: Optional[BillingAdjustmentStatus] = None,
    created_after: Optional[Timestamp] = None,
    created_before: Optional[Timestamp] = None,
    max_results: Optional[MaxResults] = None,
    catalog: Optional[Catalog] = None,
    agreement_type: Optional[AgreementType] = None,
    next_token: Optional[NextToken] = None,
) -> ListBillingAdjustmentRequestsOutput

Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.

Parameters:

  • agreement_id (Optional[AgreementId], default: None ) –

    The unique identifier of the agreement to list billing adjustment requests for.

  • status (Optional[BillingAdjustmentStatus], default: None ) –

    An optional filter to return billing adjustment requests with the specified status.

  • created_after (Optional[Timestamp], default: None ) –

    An optional filter to return billing adjustment requests created after the specified timestamp.

  • created_before (Optional[Timestamp], default: None ) –

    An optional filter to return billing adjustment requests created before the specified timestamp.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of billing adjustment requests to return in the response.

  • catalog (Optional[Catalog], default: None ) –

    An optional filter to return billing adjustment requests by catalog (e.g., AWSMarketplace).

  • agreement_type (Optional[AgreementType], default: None ) –

    An optional filter to return billing adjustment requests by agreement type (e.g., PurchaseAgreement).

  • next_token (Optional[NextToken], default: None ) –

    A token to specify where to start pagination.

Raises:

Examples:

List billing adjustment requests

>>> await client.list_billing_adjustment_requests(agreement_id='agmt-SvIzsqYMyQwI3GWgJAe17URx')
Source code in docs_src/capo_marketplace_agreement/_services/async_marketplace_agreement.py
async def list_billing_adjustment_requests(
    self,
    *,
    config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
    agreement_id: Optional[
        "capo_marketplace_agreement.types.agreement_id.AgreementId"
    ] = None,
    status: Optional[
        "capo_marketplace_agreement.types.billing_adjustment_status.BillingAdjustmentStatus"
    ] = None,
    created_after: Optional[
        "capo_marketplace_agreement.types.timestamp.Timestamp"
    ] = None,
    created_before: Optional[
        "capo_marketplace_agreement.types.timestamp.Timestamp"
    ] = None,
    max_results: Optional[
        "capo_marketplace_agreement.types.max_results.MaxResults"
    ] = None,
    catalog: Optional["capo_marketplace_agreement.types.catalog.Catalog"] = None,
    agreement_type: Optional[
        "capo_marketplace_agreement.types.agreement_type.AgreementType"
    ] = None,
    next_token: Optional[
        "capo_marketplace_agreement.types.next_token.NextToken"
    ] = None,
) -> "capo_marketplace_agreement.types.list_billing_adjustment_requests_output.ListBillingAdjustmentRequestsOutput":
    """<p>Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.</p>

    Args:
        agreement_id: <p>The unique identifier of the agreement to list billing adjustment requests for.</p>
        status: <p>An optional filter to return billing adjustment requests with the specified status.</p>
        created_after: <p>An optional filter to return billing adjustment requests created after the specified timestamp.</p>
        created_before: <p>An optional filter to return billing adjustment requests created before the specified timestamp.</p>
        max_results: <p>The maximum number of billing adjustment requests to return in the response.</p>
        catalog: <p>An optional filter to return billing adjustment requests by catalog (e.g., <code>AWSMarketplace</code>).</p>
        agreement_type: <p>An optional filter to return billing adjustment requests by agreement type (e.g., <code>PurchaseAgreement</code>).</p>
        next_token: <p>A token to specify where to start pagination.</p>

    Raises:
        capo_marketplace_agreement.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_marketplace_agreement.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_marketplace_agreement.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_marketplace_agreement.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_marketplace_agreement.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List billing adjustment requests

        >>> await client.list_billing_adjustment_requests(agreement_id='agmt-SvIzsqYMyQwI3GWgJAe17URx')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_marketplace_agreement.types.list_billing_adjustment_requests_input.ListBillingAdjustmentRequestsInput]",
    ) -> AsyncOperationResponse[
        "capo_marketplace_agreement.types.list_billing_adjustment_requests_output.ListBillingAdjustmentRequestsOutput"
    ]:
        import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.list_billing_adjustment_requests

        (
            output,
            http_response,
        ) = await capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.list_billing_adjustment_requests.async_list_billing_adjustment_requests(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBillingAdjustmentRequests")
    )
    input_: capo_marketplace_agreement.types.list_billing_adjustment_requests_input.ListBillingAdjustmentRequestsInput = {}
    if agreement_id is not None:
        input_["agreement_id"] = agreement_id
    if status is not None:
        input_["status"] = status
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if max_results is not None:
        input_["max_results"] = max_results
    if catalog is not None:
        input_["catalog"] = catalog
    if agreement_type is not None:
        input_["agreement_type"] = agreement_type
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output