Skip to content

Outposts module#

Index > Outposts

Auto-generated documentation for Outposts type annotations stubs module mypy-boto3-outposts.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Outposts 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 Outposts.

From PyPI with pip#

Install boto3-stubs for Outposts service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

OutpostsClient#

Type annotations and code completion for boto3.client("outposts") as OutpostsClient boto3 documentation

# OutpostsClient usage example

from boto3.session import Session

from mypy_boto3_outposts.client import OutpostsClient

def get_client() -> OutpostsClient:
    return Session().client("outposts")

Paginators#

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

# GetOutpostInstanceTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_outposts.paginator import GetOutpostInstanceTypesPaginator

def get_get_outpost_instance_types_paginator() -> GetOutpostInstanceTypesPaginator:
    return Session().client("outposts").get_paginator("get_outpost_instance_types"))

Literals#

Type annotations for literals used in methods and schema.

# AWSServiceNameType usage example

from mypy_boto3_outposts.literals import AWSServiceNameType

def get_value() -> AWSServiceNameType:
    return "AWS"

Type definitions#

Type annotations for type definitions used in methods and schema.