Paginators

Index > AgreementService > Paginators

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

ListAgreementPaymentRequestsPaginator

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

# ListAgreementPaymentRequestsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementPaymentRequestsPaginator

def get_list_agreement_payment_requests_paginator() -> ListAgreementPaymentRequestsPaginator:
    return Session().client("marketplace-agreement").get_paginator("list_agreement_payment_requests")

# ListAgreementPaymentRequestsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementPaymentRequestsPaginator

session = Session()

client = Session().client("marketplace-agreement")  # (1)
paginator: ListAgreementPaymentRequestsPaginator = client.get_paginator("list_agreement_payment_requests")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: AgreementServiceClient
2. paginator: ListAgreementPaymentRequestsPaginator
3. item: PageIterator[ListAgreementPaymentRequestsOutputTypeDef]

paginate

Type annotations and code completion for ListAgreementPaymentRequestsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    partyType: str,
    agreementType: str = ...,
    catalog: str = ...,
    agreementId: str = ...,
    status: PaymentRequestStatusType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListAgreementPaymentRequestsOutputTypeDef]:  # (3)
    ...

1. See PaymentRequestStatusType
2. See PaginatorConfigTypeDef
3. See PageIterator[ListAgreementPaymentRequestsOutputTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListAgreementPaymentRequestsInputPaginateTypeDef