Skip to content

AgreementService module#

Index > AgreementService

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.43.7' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add AgreementService service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and AgreementService.

From PyPI with pip#

Install boto3-stubs for AgreementService service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[marketplace-agreement]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[marketplace-agreement]'

# standalone installation
python -m pip install mypy-boto3-marketplace-agreement

How to uninstall#

python -m pip uninstall -y mypy-boto3-marketplace-agreement

Usage#

Code samples can be found in Examples.

AgreementServiceClient#

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

# AgreementServiceClient usage example

from boto3.session import Session

from mypy_boto3_marketplace_agreement.client import AgreementServiceClient

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

Paginators#

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

# 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"))

Literals#

Type annotations for literals used in methods and schema.

# AgreementCancellationRequestReasonCodeType usage example

from mypy_boto3_marketplace_agreement.literals import AgreementCancellationRequestReasonCodeType

def get_value() -> AgreementCancellationRequestReasonCodeType:
    return "ALTERNATIVE_PROCUREMENT_CHANNEL"

Type definitions#

Type annotations for type definitions used in methods and schema.