Skip to content

EventBridgePipes module#

Index > EventBridgePipes

Auto-generated documentation for EventBridgePipes type annotations stubs module mypy-boto3-pipes.

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

From PyPI with pip#

Install boto3-stubs for EventBridgePipes service.

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

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

# standalone installation
python -m pip install mypy-boto3-pipes

How to uninstall#

python -m pip uninstall -y mypy-boto3-pipes

Usage#

Code samples can be found in Examples.

EventBridgePipesClient#

Type annotations and code completion for boto3.client("pipes") as EventBridgePipesClient boto3 documentation

# EventBridgePipesClient usage example

from boto3.session import Session

from mypy_boto3_pipes.client import EventBridgePipesClient

def get_client() -> EventBridgePipesClient:
    return Session().client("pipes")

Paginators#

Type annotations and code completion for paginators from boto3.client("pipes").get_paginator("...").

# ListPipesPaginator usage example

from boto3.session import Session

from mypy_boto3_pipes.paginator import ListPipesPaginator

def get_list_pipes_paginator() -> ListPipesPaginator:
    return Session().client("pipes").get_paginator("list_pipes"))

Literals#

Type annotations for literals used in methods and schema.

# AssignPublicIpType usage example

from mypy_boto3_pipes.literals import AssignPublicIpType

def get_value() -> AssignPublicIpType:
    return "DISABLED"

Type definitions#

Type annotations for type definitions used in methods and schema.