Skip to content

Examples#

Index > ACMPCA > Examples

Auto-generated documentation for ACMPCA type annotations stubs module mypy-boto3-acm-pca.

Client#

Implicit type annotations#

Can be used with boto3-stubs[acm-pca] package installed.

Write your ACMPCA code as usual, type checking and code completion should work out of the box.

# ACMPCAClient usage example

from boto3.session import Session


session = Session()

client = session.client("acm-pca")  # (1)
result = client.create_certificate_authority()  # (2)
  1. client: ACMPCAClient
  2. result: CreateCertificateAuthorityResponseTypeDef
# ListCertificateAuthoritiesPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("acm-pca")  # (1)

paginator = client.get_paginator("list_certificate_authorities")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ACMPCAClient
  2. paginator: ListCertificateAuthoritiesPaginator
  3. item: ListCertificateAuthoritiesResponsePaginatorTypeDef
# AuditReportCreatedWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("acm-pca")  # (1)

waiter = client.get_waiter("audit_report_created")  # (2)
waiter.wait()
  1. client: ACMPCAClient
  2. waiter: AuditReportCreatedWaiter

Explicit type annotations#

With boto3-stubs-lite[acm-pca] or a standalone mypy_boto3_acm_pca package, you have to explicitly specify client: ACMPCAClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# ACMPCAClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_acm_pca.client import ACMPCAClient
from mypy_boto3_acm_pca.type_defs import CreateCertificateAuthorityResponseTypeDef
from mypy_boto3_acm_pca.type_defs import CreateCertificateAuthorityRequestRequestTypeDef


session = Session()

client: ACMPCAClient = session.client("acm-pca")

kwargs: CreateCertificateAuthorityRequestRequestTypeDef = {...}
result: CreateCertificateAuthorityResponseTypeDef = client.create_certificate_authority(**kwargs)
# ListCertificateAuthoritiesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_acm_pca.client import ACMPCAClient
from mypy_boto3_acm_pca.paginator import ListCertificateAuthoritiesPaginator
from mypy_boto3_acm_pca.type_defs import ListCertificateAuthoritiesResponsePaginatorTypeDef


session = Session()
client: ACMPCAClient = session.client("acm-pca")

paginator: ListCertificateAuthoritiesPaginator = client.get_paginator("list_certificate_authorities")
for item in paginator.paginate(...):
    item: ListCertificateAuthoritiesResponsePaginatorTypeDef
    print(item)
# AuditReportCreatedWaiter usage example with type annotations

from boto3.session import Session

from mypy_boto3_acm_pca.client import ACMPCAClient
from mypy_boto3_acm_pca.waiter import AuditReportCreatedWaiter

session = Session()
client: ACMPCAClient = session.client("acm-pca")

waiter: AuditReportCreatedWaiter = client.get_waiter("audit_report_created")
waiter.wait()