Skip to content

AgreementServiceClient#

Index > AgreementService > AgreementServiceClient

Auto-generated documentation for AgreementService type annotations stubs module mypy-boto3-marketplace-agreement.

AgreementServiceClient#

Type annotations and code completion for boto3.client("marketplace-agreement"). boto3 documentation

# AgreementServiceClient usage example

from boto3.session import Session
from mypy_boto3_marketplace_agreement.client import AgreementServiceClient

def get_marketplace-agreement_client() -> AgreementServiceClient:
    return Session().client("marketplace-agreement")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("marketplace-agreement").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("marketplace-agreement")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_marketplace_agreement.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("marketplace-agreement").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("marketplace-agreement").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

accept_agreement_cancellation_request#

Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status.

Type annotations and code completion for boto3.client("marketplace-agreement").accept_agreement_cancellation_request method. boto3 documentation

# accept_agreement_cancellation_request method definition

def accept_agreement_cancellation_request(
    self,
    *,
    agreementId: str,
    agreementCancellationRequestId: str,
) -> AcceptAgreementCancellationRequestOutputTypeDef:  # (1)
    ...
  1. See AcceptAgreementCancellationRequestOutputTypeDef
# accept_agreement_cancellation_request method usage example with argument unpacking

kwargs: AcceptAgreementCancellationRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "agreementCancellationRequestId": ...,
}

parent.accept_agreement_cancellation_request(**kwargs)
  1. See AcceptAgreementCancellationRequestInputTypeDef

accept_agreement_payment_request#

Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status.

Type annotations and code completion for boto3.client("marketplace-agreement").accept_agreement_payment_request method. boto3 documentation

# accept_agreement_payment_request method definition

def accept_agreement_payment_request(
    self,
    *,
    paymentRequestId: str,
    agreementId: str,
    purchaseOrderReference: str = ...,
) -> AcceptAgreementPaymentRequestOutputTypeDef:  # (1)
    ...
  1. See AcceptAgreementPaymentRequestOutputTypeDef
# accept_agreement_payment_request method usage example with argument unpacking

kwargs: AcceptAgreementPaymentRequestInputTypeDef = {  # (1)
    "paymentRequestId": ...,
    "agreementId": ...,
}

parent.accept_agreement_payment_request(**kwargs)
  1. See AcceptAgreementPaymentRequestInputTypeDef

accept_agreement_request#

Accepts an agreement request to finalize the agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").accept_agreement_request method. boto3 documentation

# accept_agreement_request method definition

def accept_agreement_request(
    self,
    *,
    agreementRequestId: str,
    purchaseOrders: Sequence[PurchaseOrderTypeDef] = ...,  # (1)
) -> AcceptAgreementRequestOutputTypeDef:  # (2)
    ...
  1. See Sequence[PurchaseOrderTypeDef]
  2. See AcceptAgreementRequestOutputTypeDef
# accept_agreement_request method usage example with argument unpacking

kwargs: AcceptAgreementRequestInputTypeDef = {  # (1)
    "agreementRequestId": ...,
}

parent.accept_agreement_request(**kwargs)
  1. See AcceptAgreementRequestInputTypeDef

batch_create_billing_adjustment_request#

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").batch_create_billing_adjustment_request method. boto3 documentation

# batch_create_billing_adjustment_request method definition

def batch_create_billing_adjustment_request(
    self,
    *,
    billingAdjustmentRequestEntries: Sequence[BatchCreateBillingAdjustmentRequestEntryTypeDef],  # (1)
) -> BatchCreateBillingAdjustmentRequestOutputTypeDef:  # (2)
    ...
  1. See Sequence[BatchCreateBillingAdjustmentRequestEntryTypeDef]
  2. See BatchCreateBillingAdjustmentRequestOutputTypeDef
# batch_create_billing_adjustment_request method usage example with argument unpacking

kwargs: BatchCreateBillingAdjustmentRequestInputTypeDef = {  # (1)
    "billingAdjustmentRequestEntries": ...,
}

parent.batch_create_billing_adjustment_request(**kwargs)
  1. See BatchCreateBillingAdjustmentRequestInputTypeDef

cancel_agreement#

Allows an acceptor to cancel an active agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").cancel_agreement method. boto3 documentation

# cancel_agreement method definition

def cancel_agreement(
    self,
    *,
    agreementId: str,
) -> dict[str, Any]:
    ...
# cancel_agreement method usage example with argument unpacking

kwargs: CancelAgreementInputTypeDef = {  # (1)
    "agreementId": ...,
}

parent.cancel_agreement(**kwargs)
  1. See CancelAgreementInputTypeDef

cancel_agreement_cancellation_request#

Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.

Type annotations and code completion for boto3.client("marketplace-agreement").cancel_agreement_cancellation_request method. boto3 documentation

# cancel_agreement_cancellation_request method definition

def cancel_agreement_cancellation_request(
    self,
    *,
    agreementId: str,
    agreementCancellationRequestId: str,
    cancellationReason: str,
) -> CancelAgreementCancellationRequestOutputTypeDef:  # (1)
    ...
  1. See CancelAgreementCancellationRequestOutputTypeDef
# cancel_agreement_cancellation_request method usage example with argument unpacking

kwargs: CancelAgreementCancellationRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "agreementCancellationRequestId": ...,
    "cancellationReason": ...,
}

parent.cancel_agreement_cancellation_request(**kwargs)
  1. See CancelAgreementCancellationRequestInputTypeDef

cancel_agreement_payment_request#

Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status.

Type annotations and code completion for boto3.client("marketplace-agreement").cancel_agreement_payment_request method. boto3 documentation

# cancel_agreement_payment_request method definition

def cancel_agreement_payment_request(
    self,
    *,
    paymentRequestId: str,
    agreementId: str,
) -> CancelAgreementPaymentRequestOutputTypeDef:  # (1)
    ...
  1. See CancelAgreementPaymentRequestOutputTypeDef
# cancel_agreement_payment_request method usage example with argument unpacking

kwargs: CancelAgreementPaymentRequestInputTypeDef = {  # (1)
    "paymentRequestId": ...,
    "agreementId": ...,
}

parent.cancel_agreement_payment_request(**kwargs)
  1. See CancelAgreementPaymentRequestInputTypeDef

create_agreement_request#

Creates an agreement request that acts as a quote for the terms you want to accept.

Type annotations and code completion for boto3.client("marketplace-agreement").create_agreement_request method. boto3 documentation

# create_agreement_request method definition

def create_agreement_request(
    self,
    *,
    intent: IntentType,  # (1)
    requestedTerms: Sequence[RequestedTermTypeDef],  # (2)
    clientToken: str = ...,
    sourceAgreementIdentifier: str = ...,
    agreementProposalIdentifier: str = ...,
    taxConfiguration: TaxConfigurationTypeDef = ...,  # (3)
) -> CreateAgreementRequestOutputTypeDef:  # (4)
    ...
  1. See IntentType
  2. See Sequence[RequestedTermTypeDef]
  3. See TaxConfigurationTypeDef
  4. See CreateAgreementRequestOutputTypeDef
# create_agreement_request method usage example with argument unpacking

kwargs: CreateAgreementRequestInputTypeDef = {  # (1)
    "intent": ...,
    "requestedTerms": ...,
}

parent.create_agreement_request(**kwargs)
  1. See CreateAgreementRequestInputTypeDef

describe_agreement#

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Type annotations and code completion for boto3.client("marketplace-agreement").describe_agreement method. boto3 documentation

# describe_agreement method definition

def describe_agreement(
    self,
    *,
    agreementId: str,
) -> DescribeAgreementOutputTypeDef:  # (1)
    ...
  1. See DescribeAgreementOutputTypeDef
# describe_agreement method usage example with argument unpacking

kwargs: DescribeAgreementInputTypeDef = {  # (1)
    "agreementId": ...,
}

parent.describe_agreement(**kwargs)
  1. See DescribeAgreementInputTypeDef

get_agreement_cancellation_request#

Retrieves detailed information about a specific agreement cancellation request.

Type annotations and code completion for boto3.client("marketplace-agreement").get_agreement_cancellation_request method. boto3 documentation

# get_agreement_cancellation_request method definition

def get_agreement_cancellation_request(
    self,
    *,
    agreementCancellationRequestId: str,
    agreementId: str,
) -> GetAgreementCancellationRequestOutputTypeDef:  # (1)
    ...
  1. See GetAgreementCancellationRequestOutputTypeDef
# get_agreement_cancellation_request method usage example with argument unpacking

kwargs: GetAgreementCancellationRequestInputTypeDef = {  # (1)
    "agreementCancellationRequestId": ...,
    "agreementId": ...,
}

parent.get_agreement_cancellation_request(**kwargs)
  1. See GetAgreementCancellationRequestInputTypeDef

get_agreement_entitlements#

Obtains details about the entitlements of an agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").get_agreement_entitlements method. boto3 documentation

# get_agreement_entitlements method definition

def get_agreement_entitlements(
    self,
    *,
    agreementId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetAgreementEntitlementsOutputTypeDef:  # (1)
    ...
  1. See GetAgreementEntitlementsOutputTypeDef
# get_agreement_entitlements method usage example with argument unpacking

kwargs: GetAgreementEntitlementsInputTypeDef = {  # (1)
    "agreementId": ...,
}

parent.get_agreement_entitlements(**kwargs)
  1. See GetAgreementEntitlementsInputTypeDef

get_agreement_payment_request#

Retrieves detailed information about a specific payment request.

Type annotations and code completion for boto3.client("marketplace-agreement").get_agreement_payment_request method. boto3 documentation

# get_agreement_payment_request method definition

def get_agreement_payment_request(
    self,
    *,
    paymentRequestId: str,
    agreementId: str,
) -> GetAgreementPaymentRequestOutputTypeDef:  # (1)
    ...
  1. See GetAgreementPaymentRequestOutputTypeDef
# get_agreement_payment_request method usage example with argument unpacking

kwargs: GetAgreementPaymentRequestInputTypeDef = {  # (1)
    "paymentRequestId": ...,
    "agreementId": ...,
}

parent.get_agreement_payment_request(**kwargs)
  1. See GetAgreementPaymentRequestInputTypeDef

get_agreement_terms#

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

Type annotations and code completion for boto3.client("marketplace-agreement").get_agreement_terms method. boto3 documentation

# get_agreement_terms method definition

def get_agreement_terms(
    self,
    *,
    agreementId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetAgreementTermsOutputTypeDef:  # (1)
    ...
  1. See GetAgreementTermsOutputTypeDef
# get_agreement_terms method usage example with argument unpacking

kwargs: GetAgreementTermsInputTypeDef = {  # (1)
    "agreementId": ...,
}

parent.get_agreement_terms(**kwargs)
  1. See GetAgreementTermsInputTypeDef

get_billing_adjustment_request#

Retrieves detailed information about a specific billing adjustment request.

Type annotations and code completion for boto3.client("marketplace-agreement").get_billing_adjustment_request method. boto3 documentation

# get_billing_adjustment_request method definition

def get_billing_adjustment_request(
    self,
    *,
    agreementId: str,
    billingAdjustmentRequestId: str,
) -> GetBillingAdjustmentRequestOutputTypeDef:  # (1)
    ...
  1. See GetBillingAdjustmentRequestOutputTypeDef
# get_billing_adjustment_request method usage example with argument unpacking

kwargs: GetBillingAdjustmentRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "billingAdjustmentRequestId": ...,
}

parent.get_billing_adjustment_request(**kwargs)
  1. See GetBillingAdjustmentRequestInputTypeDef

list_agreement_cancellation_requests#

Lists agreement cancellation requests available to you as a seller or buyer.

Type annotations and code completion for boto3.client("marketplace-agreement").list_agreement_cancellation_requests method. boto3 documentation

# list_agreement_cancellation_requests method definition

def list_agreement_cancellation_requests(
    self,
    *,
    partyType: str,
    agreementId: str = ...,
    status: AgreementCancellationRequestStatusType = ...,  # (1)
    agreementType: str = ...,
    catalog: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgreementCancellationRequestsOutputTypeDef:  # (2)
    ...
  1. See AgreementCancellationRequestStatusType
  2. See ListAgreementCancellationRequestsOutputTypeDef
# list_agreement_cancellation_requests method usage example with argument unpacking

kwargs: ListAgreementCancellationRequestsInputTypeDef = {  # (1)
    "partyType": ...,
}

parent.list_agreement_cancellation_requests(**kwargs)
  1. See ListAgreementCancellationRequestsInputTypeDef

list_agreement_charges#

Allows acceptors to view charges and purchase orders that are associated with an agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").list_agreement_charges method. boto3 documentation

# list_agreement_charges method definition

def list_agreement_charges(
    self,
    *,
    catalog: str = ...,
    agreementId: str = ...,
    agreementType: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgreementChargesOutputTypeDef:  # (1)
    ...
  1. See ListAgreementChargesOutputTypeDef
# list_agreement_charges method usage example with argument unpacking

kwargs: ListAgreementChargesInputTypeDef = {  # (1)
    "catalog": ...,
}

parent.list_agreement_charges(**kwargs)
  1. See ListAgreementChargesInputTypeDef

list_agreement_invoice_line_items#

Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.

Type annotations and code completion for boto3.client("marketplace-agreement").list_agreement_invoice_line_items method. boto3 documentation

# list_agreement_invoice_line_items method definition

def list_agreement_invoice_line_items(
    self,
    *,
    agreementId: str,
    groupBy: LineItemGroupByType,  # (1)
    invoiceId: str = ...,
    invoiceType: InvoiceTypeType = ...,  # (2)
    invoiceBillingPeriod: InvoiceBillingPeriodTypeDef = ...,  # (3)
    beforeIssuedTime: TimestampTypeDef = ...,
    afterIssuedTime: TimestampTypeDef = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgreementInvoiceLineItemsOutputTypeDef:  # (4)
    ...
  1. See LineItemGroupByType
  2. See InvoiceTypeType
  3. See InvoiceBillingPeriodTypeDef
  4. See ListAgreementInvoiceLineItemsOutputTypeDef
# list_agreement_invoice_line_items method usage example with argument unpacking

kwargs: ListAgreementInvoiceLineItemsInputTypeDef = {  # (1)
    "agreementId": ...,
    "groupBy": ...,
}

parent.list_agreement_invoice_line_items(**kwargs)
  1. See ListAgreementInvoiceLineItemsInputTypeDef

list_agreement_payment_requests#

Lists payment requests available to you as a seller or buyer.

Type annotations and code completion for boto3.client("marketplace-agreement").list_agreement_payment_requests method. boto3 documentation

# list_agreement_payment_requests method definition

def list_agreement_payment_requests(
    self,
    *,
    partyType: str,
    agreementType: str = ...,
    catalog: str = ...,
    agreementId: str = ...,
    status: PaymentRequestStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgreementPaymentRequestsOutputTypeDef:  # (2)
    ...
  1. See PaymentRequestStatusType
  2. See ListAgreementPaymentRequestsOutputTypeDef
# list_agreement_payment_requests method usage example with argument unpacking

kwargs: ListAgreementPaymentRequestsInputTypeDef = {  # (1)
    "partyType": ...,
}

parent.list_agreement_payment_requests(**kwargs)
  1. See ListAgreementPaymentRequestsInputTypeDef

list_billing_adjustment_requests#

Lists billing adjustment requests for a specific agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").list_billing_adjustment_requests method. boto3 documentation

# list_billing_adjustment_requests method definition

def list_billing_adjustment_requests(
    self,
    *,
    agreementId: str = ...,
    status: BillingAdjustmentStatusType = ...,  # (1)
    createdAfter: TimestampTypeDef = ...,
    createdBefore: TimestampTypeDef = ...,
    maxResults: int = ...,
    catalog: str = ...,
    agreementType: str = ...,
    nextToken: str = ...,
) -> ListBillingAdjustmentRequestsOutputTypeDef:  # (2)
    ...
  1. See BillingAdjustmentStatusType
  2. See ListBillingAdjustmentRequestsOutputTypeDef
# list_billing_adjustment_requests method usage example with argument unpacking

kwargs: ListBillingAdjustmentRequestsInputTypeDef = {  # (1)
    "agreementId": ...,
}

parent.list_billing_adjustment_requests(**kwargs)
  1. See ListBillingAdjustmentRequestsInputTypeDef

reject_agreement_cancellation_request#

Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status.

Type annotations and code completion for boto3.client("marketplace-agreement").reject_agreement_cancellation_request method. boto3 documentation

# reject_agreement_cancellation_request method definition

def reject_agreement_cancellation_request(
    self,
    *,
    agreementId: str,
    agreementCancellationRequestId: str,
    rejectionReason: str,
) -> RejectAgreementCancellationRequestOutputTypeDef:  # (1)
    ...
  1. See RejectAgreementCancellationRequestOutputTypeDef
# reject_agreement_cancellation_request method usage example with argument unpacking

kwargs: RejectAgreementCancellationRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "agreementCancellationRequestId": ...,
    "rejectionReason": ...,
}

parent.reject_agreement_cancellation_request(**kwargs)
  1. See RejectAgreementCancellationRequestInputTypeDef

reject_agreement_payment_request#

Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status.

Type annotations and code completion for boto3.client("marketplace-agreement").reject_agreement_payment_request method. boto3 documentation

# reject_agreement_payment_request method definition

def reject_agreement_payment_request(
    self,
    *,
    paymentRequestId: str,
    agreementId: str,
    rejectionReason: str = ...,
) -> RejectAgreementPaymentRequestOutputTypeDef:  # (1)
    ...
  1. See RejectAgreementPaymentRequestOutputTypeDef
# reject_agreement_payment_request method usage example with argument unpacking

kwargs: RejectAgreementPaymentRequestInputTypeDef = {  # (1)
    "paymentRequestId": ...,
    "agreementId": ...,
}

parent.reject_agreement_payment_request(**kwargs)
  1. See RejectAgreementPaymentRequestInputTypeDef

search_agreements#

Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.

Type annotations and code completion for boto3.client("marketplace-agreement").search_agreements method. boto3 documentation

# search_agreements method definition

def search_agreements(
    self,
    *,
    catalog: str = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    sort: SortTypeDef = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchAgreementsOutputTypeDef:  # (3)
    ...
  1. See Sequence[FilterTypeDef]
  2. See SortTypeDef
  3. See SearchAgreementsOutputTypeDef
# search_agreements method usage example with argument unpacking

kwargs: SearchAgreementsInputTypeDef = {  # (1)
    "catalog": ...,
}

parent.search_agreements(**kwargs)
  1. See SearchAgreementsInputTypeDef

send_agreement_cancellation_request#

Allows sellers (proposers) to submit a cancellation request for an active agreement.

Type annotations and code completion for boto3.client("marketplace-agreement").send_agreement_cancellation_request method. boto3 documentation

# send_agreement_cancellation_request method definition

def send_agreement_cancellation_request(
    self,
    *,
    agreementId: str,
    reasonCode: AgreementCancellationRequestReasonCodeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
) -> SendAgreementCancellationRequestOutputTypeDef:  # (2)
    ...
  1. See AgreementCancellationRequestReasonCodeType
  2. See SendAgreementCancellationRequestOutputTypeDef
# send_agreement_cancellation_request method usage example with argument unpacking

kwargs: SendAgreementCancellationRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "reasonCode": ...,
}

parent.send_agreement_cancellation_request(**kwargs)
  1. See SendAgreementCancellationRequestInputTypeDef

send_agreement_payment_request#

Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a VariablePaymentTerm.

Type annotations and code completion for boto3.client("marketplace-agreement").send_agreement_payment_request method. boto3 documentation

# send_agreement_payment_request method definition

def send_agreement_payment_request(
    self,
    *,
    agreementId: str,
    termId: str,
    name: str,
    chargeAmount: str,
    clientToken: str = ...,
    description: str = ...,
) -> SendAgreementPaymentRequestOutputTypeDef:  # (1)
    ...
  1. See SendAgreementPaymentRequestOutputTypeDef
# send_agreement_payment_request method usage example with argument unpacking

kwargs: SendAgreementPaymentRequestInputTypeDef = {  # (1)
    "agreementId": ...,
    "termId": ...,
    "name": ...,
    "chargeAmount": ...,
}

parent.send_agreement_payment_request(**kwargs)
  1. See SendAgreementPaymentRequestInputTypeDef

update_purchase_orders#

Allows acceptors to associate purchase orders with agreement charges after an agreement is created.

Type annotations and code completion for boto3.client("marketplace-agreement").update_purchase_orders method. boto3 documentation

# update_purchase_orders method definition

def update_purchase_orders(
    self,
    *,
    purchaseOrders: Sequence[PurchaseOrderTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See Sequence[PurchaseOrderTypeDef]
# update_purchase_orders method usage example with argument unpacking

kwargs: UpdatePurchaseOrdersInputTypeDef = {  # (1)
    "purchaseOrders": ...,
}

parent.update_purchase_orders(**kwargs)
  1. See UpdatePurchaseOrdersInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("marketplace-agreement").get_paginator method with overloads.