Type annotations for boto3.Redshift 1.13.24 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-redshift
Type annotations for boto3.Redshift 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.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Redshift
service.
python -m pip install boto3-stubs[redshift]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_redshift
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_redshift import RedshiftClient
# Now mypy can check if your code is valid.
client: RedshiftClient = boto3.client("redshift")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: RedshiftClient = session.client("redshift")
# Waiters are also supported
import mypy_boto3_redshift.waiter as redshift_waiters
cluster_available_waiter: redshift_waiters.ClusterAvailableWaiter = client.get_waiter("cluster_available")
cluster_deleted_waiter: redshift_waiters.ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
cluster_restored_waiter: redshift_waiters.ClusterRestoredWaiter = client.get_waiter("cluster_restored")
snapshot_available_waiter: redshift_waiters.SnapshotAvailableWaiter = client.get_waiter("snapshot_available")
# Annotated paginators are included as well
import mypy_boto3_redshift.paginator as redshift_paginators
describe_cluster_db_revisions_paginator: redshift_paginators.DescribeClusterDbRevisionsPaginator = client.get_paginator("describe_cluster_db_revisions")
describe_cluster_parameter_groups_paginator: redshift_paginators.DescribeClusterParameterGroupsPaginator = client.get_paginator("describe_cluster_parameter_groups")
describe_cluster_parameters_paginator: redshift_paginators.DescribeClusterParametersPaginator = client.get_paginator("describe_cluster_parameters")
describe_cluster_security_groups_paginator: redshift_paginators.DescribeClusterSecurityGroupsPaginator = client.get_paginator("describe_cluster_security_groups")
describe_cluster_snapshots_paginator: redshift_paginators.DescribeClusterSnapshotsPaginator = client.get_paginator("describe_cluster_snapshots")
describe_cluster_subnet_groups_paginator: redshift_paginators.DescribeClusterSubnetGroupsPaginator = client.get_paginator("describe_cluster_subnet_groups")
describe_cluster_tracks_paginator: redshift_paginators.DescribeClusterTracksPaginator = client.get_paginator("describe_cluster_tracks")
describe_cluster_versions_paginator: redshift_paginators.DescribeClusterVersionsPaginator = client.get_paginator("describe_cluster_versions")
describe_clusters_paginator: redshift_paginators.DescribeClustersPaginator = client.get_paginator("describe_clusters")
describe_default_cluster_parameters_paginator: redshift_paginators.DescribeDefaultClusterParametersPaginator = client.get_paginator("describe_default_cluster_parameters")
describe_event_subscriptions_paginator: redshift_paginators.DescribeEventSubscriptionsPaginator = client.get_paginator("describe_event_subscriptions")
describe_events_paginator: redshift_paginators.DescribeEventsPaginator = client.get_paginator("describe_events")
describe_hsm_client_certificates_paginator: redshift_paginators.DescribeHsmClientCertificatesPaginator = client.get_paginator("describe_hsm_client_certificates")
describe_hsm_configurations_paginator: redshift_paginators.DescribeHsmConfigurationsPaginator = client.get_paginator("describe_hsm_configurations")
describe_node_configuration_options_paginator: redshift_paginators.DescribeNodeConfigurationOptionsPaginator = client.get_paginator("describe_node_configuration_options")
describe_orderable_cluster_options_paginator: redshift_paginators.DescribeOrderableClusterOptionsPaginator = client.get_paginator("describe_orderable_cluster_options")
describe_reserved_node_offerings_paginator: redshift_paginators.DescribeReservedNodeOfferingsPaginator = client.get_paginator("describe_reserved_node_offerings")
describe_reserved_nodes_paginator: redshift_paginators.DescribeReservedNodesPaginator = client.get_paginator("describe_reserved_nodes")
describe_scheduled_actions_paginator: redshift_paginators.DescribeScheduledActionsPaginator = client.get_paginator("describe_scheduled_actions")
describe_snapshot_copy_grants_paginator: redshift_paginators.DescribeSnapshotCopyGrantsPaginator = client.get_paginator("describe_snapshot_copy_grants")
describe_snapshot_schedules_paginator: redshift_paginators.DescribeSnapshotSchedulesPaginator = client.get_paginator("describe_snapshot_schedules")
describe_table_restore_status_paginator: redshift_paginators.DescribeTableRestoreStatusPaginator = client.get_paginator("describe_table_restore_status")
describe_tags_paginator: redshift_paginators.DescribeTagsPaginator = client.get_paginator("describe_tags")
describe_usage_limits_paginator: redshift_paginators.DescribeUsageLimitsPaginator = client.get_paginator("describe_usage_limits")
get_reserved_node_exchange_offerings_paginator: redshift_paginators.GetReservedNodeExchangeOfferingsPaginator = client.get_paginator("get_reserved_node_exchange_offerings")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_redshift
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 expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_redshift as redshift
from mypy_boto3_redshift import RedshiftClient
# with these
from mypy_boto3 import redshift
from mypy_boto3.redshift import RedshiftClient
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
Built Distribution
Hashes for mypy-boto3-redshift-1.13.24.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03abb2b658c819f12269172f9680f63c20c8455a8f3169d7b280609756331980 |
|
MD5 | fbe0bf3c9aad50e2929e73b8fe8ffda9 |
|
BLAKE2b-256 | ca534b50a23b82fdab48f68ff0c2b3a0d0747849adbe1c3c9f7f420a0f37a54f |
Hashes for mypy_boto3_redshift-1.13.24.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f391bd36d26f9a5ad186137b335127384ce1ac0619e545ebbc201e8aebeb63be |
|
MD5 | 381a7854211f8aba1ad95b22f8f264f3 |
|
BLAKE2b-256 | f22f84adcf1c54bf92dde193c6cb0773e35ef3422737274a535135f8ecf98ebf |