Type annotations for boto3.ACMPCA 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-acm-pca
Type annotations for boto3.ACMPCA 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ACMPCA
service.
python -m pip install boto3-stubs[acm-pca]
How to use
Client annotations
ACMPCAClient
provides annotations for boto3.client("acm-pca")
.
import boto3
from mypy_boto3_acm_pca import ACMPCAClient
client: ACMPCAClient = boto3.client("acm-pca")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ACMPCAClient = session.client("acm-pca")
Paginators annotations
mypy_boto3_acm_pca.paginator
module contains type annotations for all paginators.
from mypy_boto3_acm_pca import ACMPCAClient
from mypy_boto3_acm_pca.paginator import (
ListCertificateAuthoritiesPaginator,
ListPermissionsPaginator,
ListTagsPaginator,
)
client: ACMPCAClient = boto3.client("acm-pca")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_certificate_authorities_paginator: ListCertificateAuthoritiesPaginator = client.get_paginator("list_certificate_authorities")
list_permissions_paginator: ListPermissionsPaginator = client.get_paginator("list_permissions")
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
Waiters annotations
mypy_boto3_acm_pca.waiter
module contains type annotations for all waiters.
from mypy_boto3_acm_pca import ACMPCAClient
from mypy_boto3_acm_pca.waiter import (
AuditReportCreatedWaiter,
CertificateAuthorityCSRCreatedWaiter,
CertificateIssuedWaiter,
)
client: ACMPCAClient = boto3.client("acm-pca")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
audit_report_created_waiter: AuditReportCreatedWaiter = client.get_waiter("audit_report_created")
certificate_authority_csr_created_waiter: CertificateAuthorityCSRCreatedWaiter = client.get_waiter("certificate_authority_csr_created")
certificate_issued_waiter: CertificateIssuedWaiter = client.get_waiter("certificate_issued")
Typed dictionations
mypy_boto3_acm_pca.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_acm_pca.type_defs import ASN1SubjectTypeDef, ...
def get_structure() -> ASN1SubjectTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_acm_pca
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
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 carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("acm-pca")
session_client = boto3.Session().client("acm-pca")
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-acm-pca-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ececc149111c1615a3b0de6ae0d25400620a4600527c88fb3f9c6a8edebe2962 |
|
MD5 | 6a83cf52554934f80689ebde3c6fde2b |
|
BLAKE2b-256 | 16333e0ce555bf412c44860a1f934e80e22244834deed39ac44e5a7a8b9b8d06 |
Hashes for mypy_boto3_acm_pca-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8418127e30289bfbe3c80d5257aa00d5f877af43b58728ef09c25f86d7b596f2 |
|
MD5 | 78014e49032e5aabfef2368f729b199f |
|
BLAKE2b-256 | 8c43be2f5decc880fdce4998a8b8453db54a200c2fdbc1c7a2cb465343e0f624 |