Skip to content

Paginators#

Index > AgreementService > Paginators

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

ListAgreementCancellationRequestsPaginator#

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

# ListAgreementCancellationRequestsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementCancellationRequestsPaginator

def get_list_agreement_cancellation_requests_paginator() -> ListAgreementCancellationRequestsPaginator:
    return Session().client("marketplace-agreement").get_paginator("list_agreement_cancellation_requests")
# ListAgreementCancellationRequestsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementCancellationRequestsPaginator

session = Session()

client = Session().client("marketplace-agreement")  # (1)
paginator: ListAgreementCancellationRequestsPaginator = client.get_paginator("list_agreement_cancellation_requests")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgreementServiceClient
  2. paginator: ListAgreementCancellationRequestsPaginator
  3. item: PageIterator[ListAgreementCancellationRequestsOutputTypeDef]

paginate#

Type annotations and code completion for ListAgreementCancellationRequestsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    partyType: str,
    agreementId: str = ...,
    status: AgreementCancellationRequestStatusType = ...,  # (1)
    agreementType: str = ...,
    catalog: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListAgreementCancellationRequestsOutputTypeDef]:  # (3)
    ...
  1. See AgreementCancellationRequestStatusType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListAgreementCancellationRequestsOutputTypeDef]
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListAgreementCancellationRequestsInputPaginateTypeDef

ListAgreementInvoiceLineItemsPaginator#

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

# ListAgreementInvoiceLineItemsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementInvoiceLineItemsPaginator

def get_list_agreement_invoice_line_items_paginator() -> ListAgreementInvoiceLineItemsPaginator:
    return Session().client("marketplace-agreement").get_paginator("list_agreement_invoice_line_items")
# ListAgreementInvoiceLineItemsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementInvoiceLineItemsPaginator

session = Session()

client = Session().client("marketplace-agreement")  # (1)
paginator: ListAgreementInvoiceLineItemsPaginator = client.get_paginator("list_agreement_invoice_line_items")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgreementServiceClient
  2. paginator: ListAgreementInvoiceLineItemsPaginator
  3. item: PageIterator[ListAgreementInvoiceLineItemsOutputTypeDef]

paginate#

Type annotations and code completion for ListAgreementInvoiceLineItemsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    agreementId: str,
    groupBy: LineItemGroupByType,  # (1)
    invoiceId: str = ...,
    invoiceType: InvoiceTypeType = ...,  # (2)
    invoiceBillingPeriod: InvoiceBillingPeriodTypeDef = ...,  # (3)
    beforeIssuedTime: TimestampTypeDef = ...,
    afterIssuedTime: TimestampTypeDef = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[ListAgreementInvoiceLineItemsOutputTypeDef]:  # (5)
    ...
  1. See LineItemGroupByType
  2. See InvoiceTypeType
  3. See InvoiceBillingPeriodTypeDef
  4. See PaginatorConfigTypeDef
  5. See PageIterator[ListAgreementInvoiceLineItemsOutputTypeDef]
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListAgreementInvoiceLineItemsInputPaginateTypeDef

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

ListBillingAdjustmentRequestsPaginator#

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

# ListBillingAdjustmentRequestsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListBillingAdjustmentRequestsPaginator

def get_list_billing_adjustment_requests_paginator() -> ListBillingAdjustmentRequestsPaginator:
    return Session().client("marketplace-agreement").get_paginator("list_billing_adjustment_requests")
# ListBillingAdjustmentRequestsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListBillingAdjustmentRequestsPaginator

session = Session()

client = Session().client("marketplace-agreement")  # (1)
paginator: ListBillingAdjustmentRequestsPaginator = client.get_paginator("list_billing_adjustment_requests")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgreementServiceClient
  2. paginator: ListBillingAdjustmentRequestsPaginator
  3. item: PageIterator[ListBillingAdjustmentRequestsOutputTypeDef]

paginate#

Type annotations and code completion for ListBillingAdjustmentRequestsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    agreementId: str = ...,
    status: BillingAdjustmentStatusType = ...,  # (1)
    createdAfter: TimestampTypeDef = ...,
    createdBefore: TimestampTypeDef = ...,
    catalog: str = ...,
    agreementType: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListBillingAdjustmentRequestsOutputTypeDef]:  # (3)
    ...
  1. See BillingAdjustmentStatusType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListBillingAdjustmentRequestsOutputTypeDef]
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListBillingAdjustmentRequestsInputPaginateTypeDef