Skip to content

Examples#

Index > CloudFront > Examples

Auto-generated documentation for CloudFront type annotations stubs module types-aiobotocore-cloudfront.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[cloudfront] package installed.

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

# CloudFrontClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("cloudfront") as client:  # (1)
    result = await client.associate_alias()  # (2)
  1. client: CloudFrontClient
  2. result: EmptyResponseMetadataTypeDef
# ListCloudFrontOriginAccessIdentitiesPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("cloudfront") as client:  # (1)
    paginator = client.get_paginator("list_cloud_front_origin_access_identities")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CloudFrontClient
  2. paginator: ListCloudFrontOriginAccessIdentitiesPaginator
  3. item: ListCloudFrontOriginAccessIdentitiesResultTypeDef
# DistributionDeployedWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("cloudfront") as client:  # (1)
    waiter = client.get_waiter("distribution_deployed")  # (2)
    await waiter.wait()
  1. client: CloudFrontClient
  2. waiter: DistributionDeployedWaiter

Explicit type annotations#

With types-aiobotocore-lite[cloudfront] or a standalone types_aiobotocore_cloudfront package, you have to explicitly specify client: CloudFrontClient 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.

# CloudFrontClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_cloudfront.client import CloudFrontClient
from types_aiobotocore_cloudfront.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_cloudfront.type_defs import AssociateAliasRequestRequestTypeDef


session = get_session()

async with session.create_client("cloudfront") as client:
    client: CloudFrontClient
    kwargs: AssociateAliasRequestRequestTypeDef = {...}
    result: EmptyResponseMetadataTypeDef = await client.associate_alias(**kwargs)
# ListCloudFrontOriginAccessIdentitiesPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_cloudfront.client import CloudFrontClient
from types_aiobotocore_cloudfront.paginator import ListCloudFrontOriginAccessIdentitiesPaginator
from types_aiobotocore_cloudfront.type_defs import ListCloudFrontOriginAccessIdentitiesResultTypeDef


session = get_session()

async with session.create_client("cloudfront") as client:
    client: CloudFrontClient
    paginator: ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator("list_cloud_front_origin_access_identities")
    async for item in paginator.paginate(...):
        item: ListCloudFrontOriginAccessIdentitiesResultTypeDef
        print(item)
# DistributionDeployedWaiter usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_cloudfront.client import CloudFrontClient
from types_aiobotocore_cloudfront.waiter import DistributionDeployedWaiter


session = get_session()

async with session.create_client("cloudfront") as client:
    client: CloudFrontClient
    waiter: DistributionDeployedWaiter = client.get_waiter("distribution_deployed")
    await waiter.wait()