mypy-boto3-lightsail 1.13.24.3

Type annotations for boto3.Lightsail 1.13.24 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-lightsail

• mypy-boto3-lightsail
  • How to use
  • Automated type discovery

Type annotations for boto3.Lightsail 1.13.24 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

• mypy-boto3-lightsail
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for Lightsail service.

python -m pip install boto3-stubs[lightsail]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_lightsail in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_lightsail import LightsailClient

# Now mypy can check if your code is valid.
client: LightsailClient = boto3.client("lightsail")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: LightsailClient = session.client("lightsail")



# Annotated paginators are included as well

import mypy_boto3_lightsail.paginator as lightsail_paginators

get_active_names_paginator: lightsail_paginators.GetActiveNamesPaginator = client.get_paginator("get_active_names")
get_blueprints_paginator: lightsail_paginators.GetBlueprintsPaginator = client.get_paginator("get_blueprints")
get_bundles_paginator: lightsail_paginators.GetBundlesPaginator = client.get_paginator("get_bundles")
get_cloud_formation_stack_records_paginator: lightsail_paginators.GetCloudFormationStackRecordsPaginator = client.get_paginator("get_cloud_formation_stack_records")
get_disk_snapshots_paginator: lightsail_paginators.GetDiskSnapshotsPaginator = client.get_paginator("get_disk_snapshots")
get_disks_paginator: lightsail_paginators.GetDisksPaginator = client.get_paginator("get_disks")
get_domains_paginator: lightsail_paginators.GetDomainsPaginator = client.get_paginator("get_domains")
get_export_snapshot_records_paginator: lightsail_paginators.GetExportSnapshotRecordsPaginator = client.get_paginator("get_export_snapshot_records")
get_instance_snapshots_paginator: lightsail_paginators.GetInstanceSnapshotsPaginator = client.get_paginator("get_instance_snapshots")
get_instances_paginator: lightsail_paginators.GetInstancesPaginator = client.get_paginator("get_instances")
get_key_pairs_paginator: lightsail_paginators.GetKeyPairsPaginator = client.get_paginator("get_key_pairs")
get_load_balancers_paginator: lightsail_paginators.GetLoadBalancersPaginator = client.get_paginator("get_load_balancers")
get_operations_paginator: lightsail_paginators.GetOperationsPaginator = client.get_paginator("get_operations")
get_relational_database_blueprints_paginator: lightsail_paginators.GetRelationalDatabaseBlueprintsPaginator = client.get_paginator("get_relational_database_blueprints")
get_relational_database_bundles_paginator: lightsail_paginators.GetRelationalDatabaseBundlesPaginator = client.get_paginator("get_relational_database_bundles")
get_relational_database_events_paginator: lightsail_paginators.GetRelationalDatabaseEventsPaginator = client.get_paginator("get_relational_database_events")
get_relational_database_parameters_paginator: lightsail_paginators.GetRelationalDatabaseParametersPaginator = client.get_paginator("get_relational_database_parameters")
get_relational_database_snapshots_paginator: lightsail_paginators.GetRelationalDatabaseSnapshotsPaginator = client.get_paginator("get_relational_database_snapshots")
get_relational_databases_paginator: lightsail_paginators.GetRelationalDatabasesPaginator = client.get_paginator("get_relational_databases")
get_static_ips_paginator: lightsail_paginators.GetStaticIpsPaginator = client.get_paginator("get_static_ips")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_lightsail and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_lightsail as lightsail
from mypy_boto3_lightsail import LightsailClient

# with these
from mypy_boto3 import lightsail
from mypy_boto3.lightsail import LightsailClient