S3Outposts module#
Index > S3Outposts
Auto-generated documentation for S3Outposts type annotations stubs module types-aiobotocore-s3outposts.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.23.0' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
S3Outposts
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for S3Outposts
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[s3outposts]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[s3outposts]'
# standalone installation
python -m pip install types-aiobotocore-s3outposts
How to uninstall#
python -m pip uninstall -y types-aiobotocore-s3outposts
Usage#
Code samples can be found in Examples.
S3OutpostsClient#
Type annotations and code completion for session.create_client("s3outposts")
as S3OutpostsClient
boto3 documentation
# S3OutpostsClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_s3outposts.client import S3OutpostsClient
session = get_session()
async with session.create_client("s3outposts") as client:
client: S3OutpostsClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("s3outposts").get_paginator("...")
.
# ListEndpointsPaginator usage example
from types_aiobotocore_s3outposts.paginator import ListEndpointsPaginator
def get_list_endpoints_paginator() -> ListEndpointsPaginator:
return client.get_paginator("list_endpoints"))
Literals#
Type annotations for literals used in methods and schema.
# EndpointAccessTypeType usage example
from types_aiobotocore_s3outposts.literals import EndpointAccessTypeType
def get_value() -> EndpointAccessTypeType:
return "CustomerOwnedIp"
- EndpointAccessTypeType
- EndpointStatusType
- ListEndpointsPaginatorName
- ListOutpostsWithS3PaginatorName
- ListSharedEndpointsPaginatorName
- S3OutpostsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- CreateEndpointRequestTypeDef
- ResponseMetadataTypeDef
- DeleteEndpointRequestTypeDef
- FailedReasonTypeDef
- NetworkInterfaceTypeDef
- PaginatorConfigTypeDef
- ListEndpointsRequestTypeDef
- ListOutpostsWithS3RequestTypeDef
- OutpostTypeDef
- ListSharedEndpointsRequestTypeDef
- CreateEndpointResultTypeDef
- EmptyResponseMetadataTypeDef
- EndpointTypeDef
- ListEndpointsRequestPaginateTypeDef
- ListOutpostsWithS3RequestPaginateTypeDef
- ListSharedEndpointsRequestPaginateTypeDef
- ListOutpostsWithS3ResultTypeDef
- ListEndpointsResultTypeDef
- ListSharedEndpointsResultTypeDef