Skip to content

PartnerCentralBenefits module#

Index > PartnerCentralBenefits

Auto-generated documentation for PartnerCentralBenefits type annotations stubs module mypy-boto3-partnercentral-benefits.

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.42.1' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add PartnerCentralBenefits 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 PartnerCentralBenefits.

From PyPI with pip#

Install boto3-stubs for PartnerCentralBenefits service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[partnercentral-benefits]'

# 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[partnercentral-benefits]'

# standalone installation
python -m pip install mypy-boto3-partnercentral-benefits

How to uninstall#

python -m pip uninstall -y mypy-boto3-partnercentral-benefits

Usage#

Code samples can be found in Examples.

PartnerCentralBenefitsClient#

Type annotations and code completion for boto3.client("partnercentral-benefits") as PartnerCentralBenefitsClient boto3 documentation

# PartnerCentralBenefitsClient usage example

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.client import PartnerCentralBenefitsClient

def get_client() -> PartnerCentralBenefitsClient:
    return Session().client("partnercentral-benefits")

Paginators#

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

# ListBenefitAllocationsPaginator usage example

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitAllocationsPaginator

def get_list_benefit_allocations_paginator() -> ListBenefitAllocationsPaginator:
    return Session().client("partnercentral-benefits").get_paginator("list_benefit_allocations"))

Literals#

Type annotations for literals used in methods and schema.

# BenefitAllocationStatusType usage example

from mypy_boto3_partnercentral_benefits.literals import BenefitAllocationStatusType

def get_value() -> BenefitAllocationStatusType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.