Skip to content

S3Outposts module#

Index > S3Outposts

Auto-generated documentation for S3Outposts type annotations stubs module mypy-boto3-s3outposts.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and S3Outposts.

From PyPI with pip#

Install boto3-stubs for S3Outposts service.

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

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

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("s3outposts") as S3OutpostsClient boto3 documentation

# S3OutpostsClient usage example

from boto3.session import Session

from mypy_boto3_s3outposts.client import S3OutpostsClient

def get_client() -> S3OutpostsClient:
    return Session().client("s3outposts")


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

# ListEndpointsPaginator usage example

from boto3.session import Session

from mypy_boto3_s3outposts.paginator import ListEndpointsPaginator

def get_list_endpoints_paginator() -> ListEndpointsPaginator:
    return Session().client("s3outposts").get_paginator("list_endpoints"))


Type annotations for literals used in methods and schemas.

# EndpointAccessTypeType usage example

from mypy_boto3_s3outposts.literals import EndpointAccessTypeType

def get_value() -> EndpointAccessTypeType:
    return "CustomerOwnedIp"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# CreateEndpointRequestRequestTypeDef usage example

from mypy_boto3_s3outposts.type_defs import CreateEndpointRequestRequestTypeDef

def get_value() -> CreateEndpointRequestRequestTypeDef:
    return {
        "OutpostId": ...,
        "SubnetId": ...,
        "SecurityGroupId": ...,