Skip to main content

Type annotations for aiobotocore.S3Outposts 2.3.3 service generated with mypy-boto3-builder 7.6.1

Project description

types-aiobotocore-s3outposts

PyPI - types-aiobotocore-s3outposts PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore.S3Outposts 2.3.3 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.6.1.

More information can be found on types-aiobotocore page and in types-aiobotocore-s3outposts docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

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 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

VSCode

python -m pip install 'types-aiobotocore[s3outposts]'

Both type checking and code completion should now work. No explicit type annotations required, write your aiobotocore code as usual.

PyCharm

Install types-aiobotocore-lite[s3outposts] in your environment:

python -m pip install 'types-aiobotocore-lite[s3outposts]'`

Both type checking and code completion should now work. Explicit type annotations are required.

Use types-aiobotocore package instead for implicit type discovery.

Emacs

  • Install types-aiobotocore with services you use in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed types-aiobotocore

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Sublime Text

  • Install types-aiobotocore[s3outposts] with services you use in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install types-aiobotocore[s3outposts] in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'`

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install types-aiobotocore[s3outposts] in your environment:
python -m pip install 'types-aiobotocore[s3outposts]'

Optionally, you can install types-aiobotocore to typings folder.

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Explicit type annotations

Client annotations

S3OutpostsClient provides annotations for session.create_client("s3outposts").

from aiobotocore.session import get_session

from types_aiobotocore_s3outposts import S3OutpostsClient

session = get_session()
async with session.create_client("s3outposts") as client:
    client: S3OutpostsClient
    # now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

types_aiobotocore_s3outposts.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_s3outposts import S3OutpostsClient
from types_aiobotocore_s3outposts.paginator import (
    ListEndpointsPaginator,
    ListSharedEndpointsPaginator,
)

session = get_session()
async with session.create_client("s3outposts") as client:
    client: S3OutpostsClient

    # Explicit type annotations are optional here
    # Type should be correctly discovered by mypy and IDEs
    # VSCode requires explicit type annotations
        list_endpoints_paginator: ListEndpointsPaginator = client.get_paginator("list_endpoints")
        list_shared_endpoints_paginator: ListSharedEndpointsPaginator = client.get_paginator("list_shared_endpoints")
    ```







### Literals

`types_aiobotocore_s3outposts.literals` module contains literals extracted from shapes
that can be used in user code for type checking.

```python
from types_aiobotocore_s3outposts.literals import (
    EndpointAccessTypeType,
    EndpointStatusType,
    ListEndpointsPaginatorName,
    ListSharedEndpointsPaginatorName,
    S3OutpostsServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)

def check_value(value: EndpointAccessTypeType) -> bool:
    ...

Typed dictionaries

types_aiobotocore_s3outposts.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from types_aiobotocore_s3outposts.type_defs import (
    CreateEndpointRequestRequestTypeDef,
    ResponseMetadataTypeDef,
    DeleteEndpointRequestRequestTypeDef,
    NetworkInterfaceTypeDef,
    PaginatorConfigTypeDef,
    ListEndpointsRequestRequestTypeDef,
    ListSharedEndpointsRequestRequestTypeDef,
    CreateEndpointResultTypeDef,
    EmptyResponseMetadataTypeDef,
    EndpointTypeDef,
    ListEndpointsRequestListEndpointsPaginateTypeDef,
    ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef,
    ListEndpointsResultTypeDef,
    ListSharedEndpointsResultTypeDef,
)

def get_structure() -> CreateEndpointRequestRequestTypeDef:
    return {
      ...
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers a drop-in type annotations for you and makes sure that:

  • All available aiobotocore services are covered.
  • Each public class and method of every aiobotocore service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by black and isort for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore and aiobotocore libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.session calls
  • Auto discovery of types for session.client and session.session calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

types-aiobotocore-s3outposts version is the same as related aiobotocore version and follows PEP 440 format.

Thank you

Documentation

All services type annotations can be found in aiobotocore docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

types-aiobotocore-s3outposts-2.3.3.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file types-aiobotocore-s3outposts-2.3.3.tar.gz.

File metadata

File hashes

Hashes for types-aiobotocore-s3outposts-2.3.3.tar.gz
Algorithm Hash digest
SHA256 0e1580b3f92a36ae988176d58d450117b93af53066926952a528afb5a69f1bdf
MD5 d71babbf9f0c27c5e3ec8a97b24b4938
BLAKE2b-256 fa4ee5028547f58e8ee908b89db8bbd899a6e9939d89bfe246ae1f6f5c900201

See more details on using hashes here.

File details

Details for the file types_aiobotocore_s3outposts-2.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_s3outposts-2.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a25beb91414671a6bdc485b4883eae76e460fc41d5693a472bcf0f97fbe2c42b
MD5 edf15fed6103892622653c51269a503f
BLAKE2b-256 e047642df5cdf2b36d9caf2af43887b5a552799165e170df1e7fc3a11c9422e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page