Skip to main content

Type annotations for aiobotocore FIS 3.5.0 service generated with mypy-boto3-builder 8.12.0

Project description

types-aiobotocore-fis

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

boto3.typed

Type annotations for aiobotocore FIS 3.5.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

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

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==3.5.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add FIS service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for FIS service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[fis]'

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

# standalone installation
python -m pip install types-aiobotocore-fis

How to uninstall

python -m pip uninstall -y types-aiobotocore-fis

Usage

VSCode

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

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[fis] in your environment:

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

Both type checking and code completion should now work.

Emacs

  • Install types-aiobotocore with services you use in your environment:
python -m pip install 'types-aiobotocore[fis]'
(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[fis] with services you use in your environment:
python -m pip install 'types-aiobotocore[fis]'

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[fis] in your environment:
python -m pip install 'types-aiobotocore[fis]'

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[fis] in your environment:
python -m pip install 'types-aiobotocore[fis]'

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

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

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-fis dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

FISClient provides annotations for session.create_client("fis").

from aiobotocore.session import get_session

from types_aiobotocore_fis import FISClient

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

Paginators annotations

types_aiobotocore_fis.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_fis import FISClient
from types_aiobotocore_fis.paginator import (
    ListActionsPaginator,
    ListExperimentResolvedTargetsPaginator,
    ListExperimentTemplatesPaginator,
    ListExperimentsPaginator,
    ListTargetAccountConfigurationsPaginator,
    ListTargetResourceTypesPaginator,
)

session = get_session()
async with session.create_client("fis") as client:
    client: FISClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_actions_paginator: ListActionsPaginator = client.get_paginator("list_actions")
    list_experiment_resolved_targets_paginator: ListExperimentResolvedTargetsPaginator = (
        client.get_paginator("list_experiment_resolved_targets")
    )
    list_experiment_templates_paginator: ListExperimentTemplatesPaginator = client.get_paginator(
        "list_experiment_templates"
    )
    list_experiments_paginator: ListExperimentsPaginator = client.get_paginator("list_experiments")
    list_target_account_configurations_paginator: ListTargetAccountConfigurationsPaginator = (
        client.get_paginator("list_target_account_configurations")
    )
    list_target_resource_types_paginator: ListTargetResourceTypesPaginator = client.get_paginator(
        "list_target_resource_types"
    )

Literals

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

Full list of FIS Literals can be found in docs.

from types_aiobotocore_fis.literals import AccountTargetingType


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

Type definitions

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

Full list of FIS TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_fis.type_defs import ActionParameterTypeDef


def get_value() -> ActionParameterTypeDef:
    return {
        "description": ...,
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers 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 botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 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.resource calls
  • Auto discovery of types for session.client and session.resource 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-fis version is the same as related aiobotocore version and follows Python Packaging version specifiers.

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


Release history Release notifications | RSS feed

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_fis-3.5.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

types_aiobotocore_fis-3.5.0-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file types_aiobotocore_fis-3.5.0.tar.gz.

File metadata

  • Download URL: types_aiobotocore_fis-3.5.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for types_aiobotocore_fis-3.5.0.tar.gz
Algorithm Hash digest
SHA256 dd3e20b87f383e93420a38b6632d58cb012ced8ed07a40f33e98e8f1de60c2de
MD5 3e5df5364aba8b04b5051313747571b7
BLAKE2b-256 31ac501e3f1c01392764e05c6430c4ad0e156edb0ceaa6dc4ef0c3417b3e3428

See more details on using hashes here.

File details

Details for the file types_aiobotocore_fis-3.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_fis-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 364fee1a1341538d345a927cd5ee8775f289a210c4af3ed1d2dcfcbe8588aff0
MD5 cd9dcec1316fd88babe30003dae584e3
BLAKE2b-256 11b371b2c2352f72011ed151d1f58c58a45b6f97b530392e01bfa7b34c92fe71

See more details on using hashes here.

Supported by

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