Skip to content

CloudFront module#

Index > CloudFront

Auto-generated documentation for CloudFront type annotations stubs module mypy-boto3-cloudfront.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.13' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add CloudFront service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CloudFront.

From PyPI with pip#

Install boto3-stubs for CloudFront service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudfront]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudfront]'

# standalone installation
python -m pip install mypy-boto3-cloudfront

How to uninstall#

python -m pip uninstall -y mypy-boto3-cloudfront

Usage#

Code samples can be found in Examples.

CloudFrontClient#

Type annotations and code completion for boto3.client("cloudfront") as CloudFrontClient boto3 documentation

# CloudFrontClient usage example

from boto3.session import Session

from mypy_boto3_cloudfront.client import CloudFrontClient

def get_client() -> CloudFrontClient:
    return Session().client("cloudfront")

Paginators#

Type annotations and code completion for paginators from boto3.client("cloudfront").get_paginator("...").

# ListCloudFrontOriginAccessIdentitiesPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudfront.paginator import ListCloudFrontOriginAccessIdentitiesPaginator

def get_list_cloud_front_origin_access_identities_paginator() -> ListCloudFrontOriginAccessIdentitiesPaginator:
    return Session().client("cloudfront").get_paginator("list_cloud_front_origin_access_identities"))

Waiters#

Type annotations and code completion for waiters from boto3.client("cloudfront").get_waiter("...").

# DistributionDeployedWaiter usage example

from boto3.session import Session

from mypy_boto3_cloudfront.waiter import DistributionDeployedWaiter

def get_distribution_deployed_waiter() -> DistributionDeployedWaiter:
    return Session().client("cloudfront").get_waiter("distribution_deployed")

Literals#

Type annotations for literals used in methods and schema.

# CachePolicyCookieBehaviorType usage example

from mypy_boto3_cloudfront.literals import CachePolicyCookieBehaviorType

def get_value() -> CachePolicyCookieBehaviorType:
    return "all"

Type definitions#

Type annotations for type definitions used in methods and schema.