Skip to content

Paginators#

Index > AgreementService > Paginators

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

GetAgreementEntitlementsPaginator#

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

# GetAgreementEntitlementsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import GetAgreementEntitlementsPaginator

def get_get_agreement_entitlements_paginator() -> GetAgreementEntitlementsPaginator:
    return Session().client("marketplace-agreement").get_paginator("get_agreement_entitlements")
# GetAgreementEntitlementsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import GetAgreementEntitlementsPaginator

session = Session()

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

paginate#

Type annotations and code completion for GetAgreementEntitlementsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    agreementId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetAgreementEntitlementsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetAgreementEntitlementsOutputTypeDef]
# paginate method usage example with argument unpacking

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

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

GetAgreementTermsPaginator#

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

# GetAgreementTermsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import GetAgreementTermsPaginator

def get_get_agreement_terms_paginator() -> GetAgreementTermsPaginator:
    return Session().client("marketplace-agreement").get_paginator("get_agreement_terms")
# GetAgreementTermsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import GetAgreementTermsPaginator

session = Session()

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

paginate#

Type annotations and code completion for GetAgreementTermsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    agreementId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[GetAgreementTermsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[GetAgreementTermsOutputTypeDef]
# paginate method usage example with argument unpacking

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

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

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

ListAgreementChargesPaginator#

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

# ListAgreementChargesPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementChargesPaginator

def get_list_agreement_charges_paginator() -> ListAgreementChargesPaginator:
    return Session().client("marketplace-agreement").get_paginator("list_agreement_charges")
# ListAgreementChargesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import ListAgreementChargesPaginator

session = Session()

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

paginate#

Type annotations and code completion for ListAgreementChargesPaginator.paginate method.

# paginate method definition

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

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

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

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

SearchAgreementsPaginator#

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

# SearchAgreementsPaginator usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import SearchAgreementsPaginator

def get_search_agreements_paginator() -> SearchAgreementsPaginator:
    return Session().client("marketplace-agreement").get_paginator("search_agreements")
# SearchAgreementsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_marketplace_agreement.paginator import SearchAgreementsPaginator

session = Session()

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

paginate#

Type annotations and code completion for SearchAgreementsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    catalog: str = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    sort: SortTypeDef = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[SearchAgreementsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[FilterTypeDef]
  2. See SortTypeDef
  3. See PaginatorConfigTypeDef
  4. See PageIterator[SearchAgreementsOutputTypeDef]
# paginate method usage example with argument unpacking

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

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