%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-cloudfront
Version: 1.26.77
Release: 1
Summary: Type annotations for boto3.CloudFront 1.26.77 service generated with mypy-boto3-builder 7.12.4
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f4/f6/c8a5a178232be8c25b057a831917edd3d9d3b113e43039bc67a7dc2ba1ce/mypy-boto3-cloudfront-1.26.77.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-cloudfront
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-cloudfront)
Type annotations for
[boto3.CloudFront 1.26.77](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudfront docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudfront](#mypy-boto3-cloudfront)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
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.
```bash
# 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
```bash
python -m pip uninstall -y mypy-boto3-cloudfront
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudfront]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudfront]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFrontClient` provides annotations for `boto3.client("cloudfront")`.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
client: CloudFrontClient = Session().client("cloudfront")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudfront.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.paginator import (
ListCloudFrontOriginAccessIdentitiesPaginator,
ListDistributionsPaginator,
ListInvalidationsPaginator,
ListStreamingDistributionsPaginator,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_cloud_front_origin_access_identities_paginator: ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator(
"list_cloud_front_origin_access_identities"
)
list_distributions_paginator: ListDistributionsPaginator = client.get_paginator(
"list_distributions"
)
list_invalidations_paginator: ListInvalidationsPaginator = client.get_paginator(
"list_invalidations"
)
list_streaming_distributions_paginator: ListStreamingDistributionsPaginator = client.get_paginator(
"list_streaming_distributions"
)
```
### Waiters annotations
`mypy_boto3_cloudfront.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.waiter import (
DistributionDeployedWaiter,
InvalidationCompletedWaiter,
StreamingDistributionDeployedWaiter,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
distribution_deployed_waiter: DistributionDeployedWaiter = client.get_waiter(
"distribution_deployed"
)
invalidation_completed_waiter: InvalidationCompletedWaiter = client.get_waiter(
"invalidation_completed"
)
streaming_distribution_deployed_waiter: StreamingDistributionDeployedWaiter = client.get_waiter(
"streaming_distribution_deployed"
)
```
### Literals
`mypy_boto3_cloudfront.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_cloudfront.literals import (
CachePolicyCookieBehaviorType,
CachePolicyHeaderBehaviorType,
CachePolicyQueryStringBehaviorType,
CachePolicyTypeType,
CertificateSourceType,
ContinuousDeploymentPolicyTypeType,
DistributionDeployedWaiterName,
EventTypeType,
FormatType,
FrameOptionsListType,
FunctionRuntimeType,
FunctionStageType,
GeoRestrictionTypeType,
HttpVersionType,
ICPRecordalStatusType,
InvalidationCompletedWaiterName,
ItemSelectionType,
ListCloudFrontOriginAccessIdentitiesPaginatorName,
ListDistributionsPaginatorName,
ListInvalidationsPaginatorName,
ListStreamingDistributionsPaginatorName,
MethodType,
MinimumProtocolVersionType,
OriginAccessControlOriginTypesType,
OriginAccessControlSigningBehaviorsType,
OriginAccessControlSigningProtocolsType,
OriginProtocolPolicyType,
OriginRequestPolicyCookieBehaviorType,
OriginRequestPolicyHeaderBehaviorType,
OriginRequestPolicyQueryStringBehaviorType,
OriginRequestPolicyTypeType,
PriceClassType,
RealtimeMetricsSubscriptionStatusType,
ReferrerPolicyListType,
ResponseHeadersPolicyAccessControlAllowMethodsValuesType,
ResponseHeadersPolicyTypeType,
SSLSupportMethodType,
SslProtocolType,
StreamingDistributionDeployedWaiterName,
ViewerProtocolPolicyType,
CloudFrontServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
)
def check_value(value: CachePolicyCookieBehaviorType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudfront.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudfront.type_defs import (
AliasICPRecordalTypeDef,
AliasesTypeDef,
CachedMethodsTypeDef,
AssociateAliasRequestRequestTypeDef,
TrustedKeyGroupsTypeDef,
TrustedSignersTypeDef,
CookieNamesTypeDef,
HeadersTypeDef,
QueryStringNamesTypeDef,
CloudFrontOriginAccessIdentityConfigTypeDef,
CloudFrontOriginAccessIdentitySummaryTypeDef,
ConflictingAliasTypeDef,
ContentTypeProfileTypeDef,
StagingDistributionDnsNamesTypeDef,
ContinuousDeploymentSingleHeaderConfigTypeDef,
SessionStickinessConfigTypeDef,
CopyDistributionRequestRequestTypeDef,
ResponseMetadataTypeDef,
FunctionConfigTypeDef,
KeyGroupConfigTypeDef,
OriginAccessControlConfigTypeDef,
PublicKeyConfigTypeDef,
CustomErrorResponseTypeDef,
OriginCustomHeaderTypeDef,
OriginSslProtocolsTypeDef,
DeleteCachePolicyRequestRequestTypeDef,
DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef,
DeleteContinuousDeploymentPolicyRequestRequestTypeDef,
DeleteDistributionRequestRequestTypeDef,
DeleteFieldLevelEncryptionConfigRequestRequestTypeDef,
DeleteFieldLevelEncryptionProfileRequestRequestTypeDef,
DeleteFunctionRequestRequestTypeDef,
DeleteKeyGroupRequestRequestTypeDef,
DeleteMonitoringSubscriptionRequestRequestTypeDef,
DeleteOriginAccessControlRequestRequestTypeDef,
DeleteOriginRequestPolicyRequestRequestTypeDef,
DeletePublicKeyRequestRequestTypeDef,
DeleteRealtimeLogConfigRequestRequestTypeDef,
DeleteResponseHeadersPolicyRequestRequestTypeDef,
DeleteStreamingDistributionRequestRequestTypeDef,
DescribeFunctionRequestRequestTypeDef,
LoggingConfigTypeDef,
ViewerCertificateTypeDef,
DistributionIdListTypeDef,
FieldPatternsTypeDef,
KinesisStreamConfigTypeDef,
QueryStringCacheKeysTypeDef,
FunctionAssociationTypeDef,
FunctionMetadataTypeDef,
GeoRestrictionTypeDef,
GetCachePolicyConfigRequestRequestTypeDef,
GetCachePolicyRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigRequestRequestTypeDef,
GetContinuousDeploymentPolicyRequestRequestTypeDef,
GetDistributionConfigRequestRequestTypeDef,
WaiterConfigTypeDef,
GetDistributionRequestRequestTypeDef,
GetFieldLevelEncryptionConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileRequestRequestTypeDef,
GetFieldLevelEncryptionRequestRequestTypeDef,
GetFunctionRequestRequestTypeDef,
GetInvalidationRequestRequestTypeDef,
GetKeyGroupConfigRequestRequestTypeDef,
GetKeyGroupRequestRequestTypeDef,
GetMonitoringSubscriptionRequestRequestTypeDef,
GetOriginAccessControlConfigRequestRequestTypeDef,
GetOriginAccessControlRequestRequestTypeDef,
GetOriginRequestPolicyConfigRequestRequestTypeDef,
GetOriginRequestPolicyRequestRequestTypeDef,
GetPublicKeyConfigRequestRequestTypeDef,
GetPublicKeyRequestRequestTypeDef,
GetRealtimeLogConfigRequestRequestTypeDef,
GetResponseHeadersPolicyConfigRequestRequestTypeDef,
GetResponseHeadersPolicyRequestRequestTypeDef,
GetStreamingDistributionConfigRequestRequestTypeDef,
GetStreamingDistributionRequestRequestTypeDef,
PathsTypeDef,
InvalidationSummaryTypeDef,
KeyPairIdsTypeDef,
LambdaFunctionAssociationTypeDef,
ListCachePoliciesRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef,
ListConflictingAliasesRequestRequestTypeDef,
ListContinuousDeploymentPoliciesRequestRequestTypeDef,
ListDistributionsByCachePolicyIdRequestRequestTypeDef,
ListDistributionsByKeyGroupRequestRequestTypeDef,
ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef,
ListDistributionsByRealtimeLogConfigRequestRequestTypeDef,
ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef,
ListDistributionsByWebACLIdRequestRequestTypeDef,
ListDistributionsRequestRequestTypeDef,
ListFieldLevelEncryptionConfigsRequestRequestTypeDef,
ListFieldLevelEncryptionProfilesRequestRequestTypeDef,
ListFunctionsRequestRequestTypeDef,
ListInvalidationsRequestRequestTypeDef,
ListKeyGroupsRequestRequestTypeDef,
ListOriginAccessControlsRequestRequestTypeDef,
ListOriginRequestPoliciesRequestRequestTypeDef,
ListPublicKeysRequestRequestTypeDef,
ListRealtimeLogConfigsRequestRequestTypeDef,
ListResponseHeadersPoliciesRequestRequestTypeDef,
ListStreamingDistributionsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
RealtimeMetricsSubscriptionConfigTypeDef,
OriginAccessControlSummaryTypeDef,
StatusCodesTypeDef,
OriginGroupMemberTypeDef,
OriginShieldTypeDef,
S3OriginConfigTypeDef,
PublicKeySummaryTypeDef,
PublishFunctionRequestRequestTypeDef,
QueryArgProfileTypeDef,
ResponseHeadersPolicyAccessControlAllowHeadersTypeDef,
ResponseHeadersPolicyAccessControlAllowMethodsTypeDef,
ResponseHeadersPolicyAccessControlAllowOriginsTypeDef,
ResponseHeadersPolicyAccessControlExposeHeadersTypeDef,
ResponseHeadersPolicyServerTimingHeadersConfigTypeDef,
ResponseHeadersPolicyContentSecurityPolicyTypeDef,
ResponseHeadersPolicyContentTypeOptionsTypeDef,
ResponseHeadersPolicyCustomHeaderTypeDef,
ResponseHeadersPolicyFrameOptionsTypeDef,
ResponseHeadersPolicyReferrerPolicyTypeDef,
ResponseHeadersPolicyRemoveHeaderTypeDef,
ResponseHeadersPolicyStrictTransportSecurityTypeDef,
ResponseHeadersPolicyXSSProtectionTypeDef,
S3OriginTypeDef,
StreamingLoggingConfigTypeDef,
TagKeysTypeDef,
TagTypeDef,
TestFunctionRequestRequestTypeDef,
UpdateDistributionWithStagingConfigRequestRequestTypeDef,
AllowedMethodsTypeDef,
CachePolicyCookiesConfigTypeDef,
CookiePreferenceTypeDef,
OriginRequestPolicyCookiesConfigTypeDef,
CachePolicyHeadersConfigTypeDef,
OriginRequestPolicyHeadersConfigTypeDef,
CachePolicyQueryStringsConfigTypeDef,
OriginRequestPolicyQueryStringsConfigTypeDef,
CloudFrontOriginAccessIdentityTypeDef,
CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
CloudFrontOriginAccessIdentityListTypeDef,
ConflictingAliasesListTypeDef,
ContentTypeProfilesTypeDef,
ContinuousDeploymentSingleWeightConfigTypeDef,
EmptyResponseMetadataTypeDef,
GetCloudFrontOriginAccessIdentityConfigResultTypeDef,
GetFunctionResultTypeDef,
CreateFunctionRequestRequestTypeDef,
UpdateFunctionRequestRequestTypeDef,
CreateKeyGroupRequestRequestTypeDef,
GetKeyGroupConfigResultTypeDef,
KeyGroupTypeDef,
UpdateKeyGroupRequestRequestTypeDef,
CreateOriginAccessControlRequestRequestTypeDef,
GetOriginAccessControlConfigResultTypeDef,
OriginAccessControlTypeDef,
UpdateOriginAccessControlRequestRequestTypeDef,
CreatePublicKeyRequestRequestTypeDef,
GetPublicKeyConfigResultTypeDef,
PublicKeyTypeDef,
UpdatePublicKeyRequestRequestTypeDef,
CustomErrorResponsesTypeDef,
CustomHeadersTypeDef,
CustomOriginConfigTypeDef,
ListDistributionsByCachePolicyIdResultTypeDef,
ListDistributionsByKeyGroupResultTypeDef,
ListDistributionsByOriginRequestPolicyIdResultTypeDef,
ListDistributionsByResponseHeadersPolicyIdResultTypeDef,
EncryptionEntityTypeDef,
EndPointTypeDef,
FunctionAssociationsTypeDef,
FunctionSummaryTypeDef,
RestrictionsTypeDef,
GetDistributionRequestDistributionDeployedWaitTypeDef,
GetInvalidationRequestInvalidationCompletedWaitTypeDef,
GetStreamingDistributionRequestStreamingDistributionDeployedWaitTypeDef,
InvalidationBatchTypeDef,
InvalidationListTypeDef,
KGKeyPairIdsTypeDef,
SignerTypeDef,
LambdaFunctionAssociationsTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestListCloudFrontOriginAccessIdentitiesPaginateTypeDef,
ListDistributionsRequestListDistributionsPaginateTypeDef,
ListInvalidationsRequestListInvalidationsPaginateTypeDef,
ListStreamingDistributionsRequestListStreamingDistributionsPaginateTypeDef,
MonitoringSubscriptionTypeDef,
OriginAccessControlListTypeDef,
OriginGroupFailoverCriteriaTypeDef,
OriginGroupMembersTypeDef,
PublicKeyListTypeDef,
QueryArgProfilesTypeDef,
ResponseHeadersPolicyCorsConfigTypeDef,
ResponseHeadersPolicyCustomHeadersConfigTypeDef,
ResponseHeadersPolicyRemoveHeadersConfigTypeDef,
ResponseHeadersPolicySecurityHeadersConfigTypeDef,
StreamingDistributionSummaryTypeDef,
StreamingDistributionConfigTypeDef,
UntagResourceRequestRequestTypeDef,
TagsTypeDef,
ForwardedValuesTypeDef,
ParametersInCacheKeyAndForwardedToOriginTypeDef,
OriginRequestPolicyConfigTypeDef,
CreateCloudFrontOriginAccessIdentityResultTypeDef,
GetCloudFrontOriginAccessIdentityResultTypeDef,
UpdateCloudFrontOriginAccessIdentityResultTypeDef,
ListCloudFrontOriginAccessIdentitiesResultTypeDef,
ListConflictingAliasesResultTypeDef,
ContentTypeProfileConfigTypeDef,
TrafficConfigTypeDef,
CreateKeyGroupResultTypeDef,
GetKeyGroupResultTypeDef,
KeyGroupSummaryTypeDef,
UpdateKeyGroupResultTypeDef,
CreateOriginAccessControlResultTypeDef,
GetOriginAccessControlResultTypeDef,
UpdateOriginAccessControlResultTypeDef,
CreatePublicKeyResultTypeDef,
GetPublicKeyResultTypeDef,
UpdatePublicKeyResultTypeDef,
OriginTypeDef,
EncryptionEntitiesTypeDef,
CreateRealtimeLogConfigRequestRequestTypeDef,
RealtimeLogConfigTypeDef,
UpdateRealtimeLogConfigRequestRequestTypeDef,
CreateFunctionResultTypeDef,
DescribeFunctionResultTypeDef,
FunctionListTypeDef,
PublishFunctionResultTypeDef,
TestResultTypeDef,
UpdateFunctionResultTypeDef,
CreateInvalidationRequestRequestTypeDef,
InvalidationTypeDef,
ListInvalidationsResultTypeDef,
ActiveTrustedKeyGroupsTypeDef,
ActiveTrustedSignersTypeDef,
CreateMonitoringSubscriptionRequestRequestTypeDef,
CreateMonitoringSubscriptionResultTypeDef,
GetMonitoringSubscriptionResultTypeDef,
ListOriginAccessControlsResultTypeDef,
OriginGroupTypeDef,
ListPublicKeysResultTypeDef,
QueryArgProfileConfigTypeDef,
ResponseHeadersPolicyConfigTypeDef,
StreamingDistributionListTypeDef,
CreateStreamingDistributionRequestRequestTypeDef,
GetStreamingDistributionConfigResultTypeDef,
UpdateStreamingDistributionRequestRequestTypeDef,
ListTagsForResourceResultTypeDef,
StreamingDistributionConfigWithTagsTypeDef,
TagResourceRequestRequestTypeDef,
CacheBehaviorTypeDef,
DefaultCacheBehaviorTypeDef,
CachePolicyConfigTypeDef,
CreateOriginRequestPolicyRequestRequestTypeDef,
GetOriginRequestPolicyConfigResultTypeDef,
OriginRequestPolicyTypeDef,
UpdateOriginRequestPolicyRequestRequestTypeDef,
ContinuousDeploymentPolicyConfigTypeDef,
KeyGroupListTypeDef,
OriginsTypeDef,
FieldLevelEncryptionProfileConfigTypeDef,
FieldLevelEncryptionProfileSummaryTypeDef,
CreateRealtimeLogConfigResultTypeDef,
GetRealtimeLogConfigResultTypeDef,
RealtimeLogConfigsTypeDef,
UpdateRealtimeLogConfigResultTypeDef,
ListFunctionsResultTypeDef,
TestFunctionResultTypeDef,
CreateInvalidationResultTypeDef,
GetInvalidationResultTypeDef,
StreamingDistributionTypeDef,
OriginGroupsTypeDef,
FieldLevelEncryptionConfigTypeDef,
FieldLevelEncryptionSummaryTypeDef,
CreateResponseHeadersPolicyRequestRequestTypeDef,
GetResponseHeadersPolicyConfigResultTypeDef,
ResponseHeadersPolicyTypeDef,
UpdateResponseHeadersPolicyRequestRequestTypeDef,
ListStreamingDistributionsResultTypeDef,
CreateStreamingDistributionWithTagsRequestRequestTypeDef,
CacheBehaviorsTypeDef,
CachePolicyTypeDef,
CreateCachePolicyRequestRequestTypeDef,
GetCachePolicyConfigResultTypeDef,
UpdateCachePolicyRequestRequestTypeDef,
CreateOriginRequestPolicyResultTypeDef,
GetOriginRequestPolicyResultTypeDef,
OriginRequestPolicySummaryTypeDef,
UpdateOriginRequestPolicyResultTypeDef,
ContinuousDeploymentPolicyTypeDef,
CreateContinuousDeploymentPolicyRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigResultTypeDef,
UpdateContinuousDeploymentPolicyRequestRequestTypeDef,
ListKeyGroupsResultTypeDef,
CreateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileTypeDef,
GetFieldLevelEncryptionProfileConfigResultTypeDef,
UpdateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileListTypeDef,
ListRealtimeLogConfigsResultTypeDef,
CreateStreamingDistributionResultTypeDef,
CreateStreamingDistributionWithTagsResultTypeDef,
GetStreamingDistributionResultTypeDef,
UpdateStreamingDistributionResultTypeDef,
CreateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionTypeDef,
GetFieldLevelEncryptionConfigResultTypeDef,
UpdateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionListTypeDef,
CreateResponseHeadersPolicyResultTypeDef,
GetResponseHeadersPolicyResultTypeDef,
ResponseHeadersPolicySummaryTypeDef,
UpdateResponseHeadersPolicyResultTypeDef,
DistributionConfigTypeDef,
DistributionSummaryTypeDef,
CachePolicySummaryTypeDef,
CreateCachePolicyResultTypeDef,
GetCachePolicyResultTypeDef,
UpdateCachePolicyResultTypeDef,
OriginRequestPolicyListTypeDef,
ContinuousDeploymentPolicySummaryTypeDef,
CreateContinuousDeploymentPolicyResultTypeDef,
GetContinuousDeploymentPolicyResultTypeDef,
UpdateContinuousDeploymentPolicyResultTypeDef,
CreateFieldLevelEncryptionProfileResultTypeDef,
GetFieldLevelEncryptionProfileResultTypeDef,
UpdateFieldLevelEncryptionProfileResultTypeDef,
ListFieldLevelEncryptionProfilesResultTypeDef,
CreateFieldLevelEncryptionConfigResultTypeDef,
GetFieldLevelEncryptionResultTypeDef,
UpdateFieldLevelEncryptionConfigResultTypeDef,
ListFieldLevelEncryptionConfigsResultTypeDef,
ResponseHeadersPolicyListTypeDef,
CreateDistributionRequestRequestTypeDef,
DistributionConfigWithTagsTypeDef,
DistributionTypeDef,
GetDistributionConfigResultTypeDef,
UpdateDistributionRequestRequestTypeDef,
DistributionListTypeDef,
CachePolicyListTypeDef,
ListOriginRequestPoliciesResultTypeDef,
ContinuousDeploymentPolicyListTypeDef,
ListResponseHeadersPoliciesResultTypeDef,
CreateDistributionWithTagsRequestRequestTypeDef,
CopyDistributionResultTypeDef,
CreateDistributionResultTypeDef,
CreateDistributionWithTagsResultTypeDef,
GetDistributionResultTypeDef,
UpdateDistributionResultTypeDef,
UpdateDistributionWithStagingConfigResultTypeDef,
ListDistributionsByRealtimeLogConfigResultTypeDef,
ListDistributionsByWebACLIdResultTypeDef,
ListDistributionsResultTypeDef,
ListCachePoliciesResultTypeDef,
ListContinuousDeploymentPoliciesResultTypeDef,
)
def get_structure() -> AliasICPRecordalTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudfront` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package -n python3-mypy-boto3-cloudfront
Summary: Type annotations for boto3.CloudFront 1.26.77 service generated with mypy-boto3-builder 7.12.4
Provides: python-mypy-boto3-cloudfront
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-cloudfront
# mypy-boto3-cloudfront
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-cloudfront)
Type annotations for
[boto3.CloudFront 1.26.77](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudfront docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudfront](#mypy-boto3-cloudfront)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
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.
```bash
# 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
```bash
python -m pip uninstall -y mypy-boto3-cloudfront
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudfront]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudfront]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFrontClient` provides annotations for `boto3.client("cloudfront")`.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
client: CloudFrontClient = Session().client("cloudfront")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudfront.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.paginator import (
ListCloudFrontOriginAccessIdentitiesPaginator,
ListDistributionsPaginator,
ListInvalidationsPaginator,
ListStreamingDistributionsPaginator,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_cloud_front_origin_access_identities_paginator: ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator(
"list_cloud_front_origin_access_identities"
)
list_distributions_paginator: ListDistributionsPaginator = client.get_paginator(
"list_distributions"
)
list_invalidations_paginator: ListInvalidationsPaginator = client.get_paginator(
"list_invalidations"
)
list_streaming_distributions_paginator: ListStreamingDistributionsPaginator = client.get_paginator(
"list_streaming_distributions"
)
```
### Waiters annotations
`mypy_boto3_cloudfront.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.waiter import (
DistributionDeployedWaiter,
InvalidationCompletedWaiter,
StreamingDistributionDeployedWaiter,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
distribution_deployed_waiter: DistributionDeployedWaiter = client.get_waiter(
"distribution_deployed"
)
invalidation_completed_waiter: InvalidationCompletedWaiter = client.get_waiter(
"invalidation_completed"
)
streaming_distribution_deployed_waiter: StreamingDistributionDeployedWaiter = client.get_waiter(
"streaming_distribution_deployed"
)
```
### Literals
`mypy_boto3_cloudfront.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_cloudfront.literals import (
CachePolicyCookieBehaviorType,
CachePolicyHeaderBehaviorType,
CachePolicyQueryStringBehaviorType,
CachePolicyTypeType,
CertificateSourceType,
ContinuousDeploymentPolicyTypeType,
DistributionDeployedWaiterName,
EventTypeType,
FormatType,
FrameOptionsListType,
FunctionRuntimeType,
FunctionStageType,
GeoRestrictionTypeType,
HttpVersionType,
ICPRecordalStatusType,
InvalidationCompletedWaiterName,
ItemSelectionType,
ListCloudFrontOriginAccessIdentitiesPaginatorName,
ListDistributionsPaginatorName,
ListInvalidationsPaginatorName,
ListStreamingDistributionsPaginatorName,
MethodType,
MinimumProtocolVersionType,
OriginAccessControlOriginTypesType,
OriginAccessControlSigningBehaviorsType,
OriginAccessControlSigningProtocolsType,
OriginProtocolPolicyType,
OriginRequestPolicyCookieBehaviorType,
OriginRequestPolicyHeaderBehaviorType,
OriginRequestPolicyQueryStringBehaviorType,
OriginRequestPolicyTypeType,
PriceClassType,
RealtimeMetricsSubscriptionStatusType,
ReferrerPolicyListType,
ResponseHeadersPolicyAccessControlAllowMethodsValuesType,
ResponseHeadersPolicyTypeType,
SSLSupportMethodType,
SslProtocolType,
StreamingDistributionDeployedWaiterName,
ViewerProtocolPolicyType,
CloudFrontServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
)
def check_value(value: CachePolicyCookieBehaviorType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudfront.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudfront.type_defs import (
AliasICPRecordalTypeDef,
AliasesTypeDef,
CachedMethodsTypeDef,
AssociateAliasRequestRequestTypeDef,
TrustedKeyGroupsTypeDef,
TrustedSignersTypeDef,
CookieNamesTypeDef,
HeadersTypeDef,
QueryStringNamesTypeDef,
CloudFrontOriginAccessIdentityConfigTypeDef,
CloudFrontOriginAccessIdentitySummaryTypeDef,
ConflictingAliasTypeDef,
ContentTypeProfileTypeDef,
StagingDistributionDnsNamesTypeDef,
ContinuousDeploymentSingleHeaderConfigTypeDef,
SessionStickinessConfigTypeDef,
CopyDistributionRequestRequestTypeDef,
ResponseMetadataTypeDef,
FunctionConfigTypeDef,
KeyGroupConfigTypeDef,
OriginAccessControlConfigTypeDef,
PublicKeyConfigTypeDef,
CustomErrorResponseTypeDef,
OriginCustomHeaderTypeDef,
OriginSslProtocolsTypeDef,
DeleteCachePolicyRequestRequestTypeDef,
DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef,
DeleteContinuousDeploymentPolicyRequestRequestTypeDef,
DeleteDistributionRequestRequestTypeDef,
DeleteFieldLevelEncryptionConfigRequestRequestTypeDef,
DeleteFieldLevelEncryptionProfileRequestRequestTypeDef,
DeleteFunctionRequestRequestTypeDef,
DeleteKeyGroupRequestRequestTypeDef,
DeleteMonitoringSubscriptionRequestRequestTypeDef,
DeleteOriginAccessControlRequestRequestTypeDef,
DeleteOriginRequestPolicyRequestRequestTypeDef,
DeletePublicKeyRequestRequestTypeDef,
DeleteRealtimeLogConfigRequestRequestTypeDef,
DeleteResponseHeadersPolicyRequestRequestTypeDef,
DeleteStreamingDistributionRequestRequestTypeDef,
DescribeFunctionRequestRequestTypeDef,
LoggingConfigTypeDef,
ViewerCertificateTypeDef,
DistributionIdListTypeDef,
FieldPatternsTypeDef,
KinesisStreamConfigTypeDef,
QueryStringCacheKeysTypeDef,
FunctionAssociationTypeDef,
FunctionMetadataTypeDef,
GeoRestrictionTypeDef,
GetCachePolicyConfigRequestRequestTypeDef,
GetCachePolicyRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigRequestRequestTypeDef,
GetContinuousDeploymentPolicyRequestRequestTypeDef,
GetDistributionConfigRequestRequestTypeDef,
WaiterConfigTypeDef,
GetDistributionRequestRequestTypeDef,
GetFieldLevelEncryptionConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileRequestRequestTypeDef,
GetFieldLevelEncryptionRequestRequestTypeDef,
GetFunctionRequestRequestTypeDef,
GetInvalidationRequestRequestTypeDef,
GetKeyGroupConfigRequestRequestTypeDef,
GetKeyGroupRequestRequestTypeDef,
GetMonitoringSubscriptionRequestRequestTypeDef,
GetOriginAccessControlConfigRequestRequestTypeDef,
GetOriginAccessControlRequestRequestTypeDef,
GetOriginRequestPolicyConfigRequestRequestTypeDef,
GetOriginRequestPolicyRequestRequestTypeDef,
GetPublicKeyConfigRequestRequestTypeDef,
GetPublicKeyRequestRequestTypeDef,
GetRealtimeLogConfigRequestRequestTypeDef,
GetResponseHeadersPolicyConfigRequestRequestTypeDef,
GetResponseHeadersPolicyRequestRequestTypeDef,
GetStreamingDistributionConfigRequestRequestTypeDef,
GetStreamingDistributionRequestRequestTypeDef,
PathsTypeDef,
InvalidationSummaryTypeDef,
KeyPairIdsTypeDef,
LambdaFunctionAssociationTypeDef,
ListCachePoliciesRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef,
ListConflictingAliasesRequestRequestTypeDef,
ListContinuousDeploymentPoliciesRequestRequestTypeDef,
ListDistributionsByCachePolicyIdRequestRequestTypeDef,
ListDistributionsByKeyGroupRequestRequestTypeDef,
ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef,
ListDistributionsByRealtimeLogConfigRequestRequestTypeDef,
ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef,
ListDistributionsByWebACLIdRequestRequestTypeDef,
ListDistributionsRequestRequestTypeDef,
ListFieldLevelEncryptionConfigsRequestRequestTypeDef,
ListFieldLevelEncryptionProfilesRequestRequestTypeDef,
ListFunctionsRequestRequestTypeDef,
ListInvalidationsRequestRequestTypeDef,
ListKeyGroupsRequestRequestTypeDef,
ListOriginAccessControlsRequestRequestTypeDef,
ListOriginRequestPoliciesRequestRequestTypeDef,
ListPublicKeysRequestRequestTypeDef,
ListRealtimeLogConfigsRequestRequestTypeDef,
ListResponseHeadersPoliciesRequestRequestTypeDef,
ListStreamingDistributionsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
RealtimeMetricsSubscriptionConfigTypeDef,
OriginAccessControlSummaryTypeDef,
StatusCodesTypeDef,
OriginGroupMemberTypeDef,
OriginShieldTypeDef,
S3OriginConfigTypeDef,
PublicKeySummaryTypeDef,
PublishFunctionRequestRequestTypeDef,
QueryArgProfileTypeDef,
ResponseHeadersPolicyAccessControlAllowHeadersTypeDef,
ResponseHeadersPolicyAccessControlAllowMethodsTypeDef,
ResponseHeadersPolicyAccessControlAllowOriginsTypeDef,
ResponseHeadersPolicyAccessControlExposeHeadersTypeDef,
ResponseHeadersPolicyServerTimingHeadersConfigTypeDef,
ResponseHeadersPolicyContentSecurityPolicyTypeDef,
ResponseHeadersPolicyContentTypeOptionsTypeDef,
ResponseHeadersPolicyCustomHeaderTypeDef,
ResponseHeadersPolicyFrameOptionsTypeDef,
ResponseHeadersPolicyReferrerPolicyTypeDef,
ResponseHeadersPolicyRemoveHeaderTypeDef,
ResponseHeadersPolicyStrictTransportSecurityTypeDef,
ResponseHeadersPolicyXSSProtectionTypeDef,
S3OriginTypeDef,
StreamingLoggingConfigTypeDef,
TagKeysTypeDef,
TagTypeDef,
TestFunctionRequestRequestTypeDef,
UpdateDistributionWithStagingConfigRequestRequestTypeDef,
AllowedMethodsTypeDef,
CachePolicyCookiesConfigTypeDef,
CookiePreferenceTypeDef,
OriginRequestPolicyCookiesConfigTypeDef,
CachePolicyHeadersConfigTypeDef,
OriginRequestPolicyHeadersConfigTypeDef,
CachePolicyQueryStringsConfigTypeDef,
OriginRequestPolicyQueryStringsConfigTypeDef,
CloudFrontOriginAccessIdentityTypeDef,
CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
CloudFrontOriginAccessIdentityListTypeDef,
ConflictingAliasesListTypeDef,
ContentTypeProfilesTypeDef,
ContinuousDeploymentSingleWeightConfigTypeDef,
EmptyResponseMetadataTypeDef,
GetCloudFrontOriginAccessIdentityConfigResultTypeDef,
GetFunctionResultTypeDef,
CreateFunctionRequestRequestTypeDef,
UpdateFunctionRequestRequestTypeDef,
CreateKeyGroupRequestRequestTypeDef,
GetKeyGroupConfigResultTypeDef,
KeyGroupTypeDef,
UpdateKeyGroupRequestRequestTypeDef,
CreateOriginAccessControlRequestRequestTypeDef,
GetOriginAccessControlConfigResultTypeDef,
OriginAccessControlTypeDef,
UpdateOriginAccessControlRequestRequestTypeDef,
CreatePublicKeyRequestRequestTypeDef,
GetPublicKeyConfigResultTypeDef,
PublicKeyTypeDef,
UpdatePublicKeyRequestRequestTypeDef,
CustomErrorResponsesTypeDef,
CustomHeadersTypeDef,
CustomOriginConfigTypeDef,
ListDistributionsByCachePolicyIdResultTypeDef,
ListDistributionsByKeyGroupResultTypeDef,
ListDistributionsByOriginRequestPolicyIdResultTypeDef,
ListDistributionsByResponseHeadersPolicyIdResultTypeDef,
EncryptionEntityTypeDef,
EndPointTypeDef,
FunctionAssociationsTypeDef,
FunctionSummaryTypeDef,
RestrictionsTypeDef,
GetDistributionRequestDistributionDeployedWaitTypeDef,
GetInvalidationRequestInvalidationCompletedWaitTypeDef,
GetStreamingDistributionRequestStreamingDistributionDeployedWaitTypeDef,
InvalidationBatchTypeDef,
InvalidationListTypeDef,
KGKeyPairIdsTypeDef,
SignerTypeDef,
LambdaFunctionAssociationsTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestListCloudFrontOriginAccessIdentitiesPaginateTypeDef,
ListDistributionsRequestListDistributionsPaginateTypeDef,
ListInvalidationsRequestListInvalidationsPaginateTypeDef,
ListStreamingDistributionsRequestListStreamingDistributionsPaginateTypeDef,
MonitoringSubscriptionTypeDef,
OriginAccessControlListTypeDef,
OriginGroupFailoverCriteriaTypeDef,
OriginGroupMembersTypeDef,
PublicKeyListTypeDef,
QueryArgProfilesTypeDef,
ResponseHeadersPolicyCorsConfigTypeDef,
ResponseHeadersPolicyCustomHeadersConfigTypeDef,
ResponseHeadersPolicyRemoveHeadersConfigTypeDef,
ResponseHeadersPolicySecurityHeadersConfigTypeDef,
StreamingDistributionSummaryTypeDef,
StreamingDistributionConfigTypeDef,
UntagResourceRequestRequestTypeDef,
TagsTypeDef,
ForwardedValuesTypeDef,
ParametersInCacheKeyAndForwardedToOriginTypeDef,
OriginRequestPolicyConfigTypeDef,
CreateCloudFrontOriginAccessIdentityResultTypeDef,
GetCloudFrontOriginAccessIdentityResultTypeDef,
UpdateCloudFrontOriginAccessIdentityResultTypeDef,
ListCloudFrontOriginAccessIdentitiesResultTypeDef,
ListConflictingAliasesResultTypeDef,
ContentTypeProfileConfigTypeDef,
TrafficConfigTypeDef,
CreateKeyGroupResultTypeDef,
GetKeyGroupResultTypeDef,
KeyGroupSummaryTypeDef,
UpdateKeyGroupResultTypeDef,
CreateOriginAccessControlResultTypeDef,
GetOriginAccessControlResultTypeDef,
UpdateOriginAccessControlResultTypeDef,
CreatePublicKeyResultTypeDef,
GetPublicKeyResultTypeDef,
UpdatePublicKeyResultTypeDef,
OriginTypeDef,
EncryptionEntitiesTypeDef,
CreateRealtimeLogConfigRequestRequestTypeDef,
RealtimeLogConfigTypeDef,
UpdateRealtimeLogConfigRequestRequestTypeDef,
CreateFunctionResultTypeDef,
DescribeFunctionResultTypeDef,
FunctionListTypeDef,
PublishFunctionResultTypeDef,
TestResultTypeDef,
UpdateFunctionResultTypeDef,
CreateInvalidationRequestRequestTypeDef,
InvalidationTypeDef,
ListInvalidationsResultTypeDef,
ActiveTrustedKeyGroupsTypeDef,
ActiveTrustedSignersTypeDef,
CreateMonitoringSubscriptionRequestRequestTypeDef,
CreateMonitoringSubscriptionResultTypeDef,
GetMonitoringSubscriptionResultTypeDef,
ListOriginAccessControlsResultTypeDef,
OriginGroupTypeDef,
ListPublicKeysResultTypeDef,
QueryArgProfileConfigTypeDef,
ResponseHeadersPolicyConfigTypeDef,
StreamingDistributionListTypeDef,
CreateStreamingDistributionRequestRequestTypeDef,
GetStreamingDistributionConfigResultTypeDef,
UpdateStreamingDistributionRequestRequestTypeDef,
ListTagsForResourceResultTypeDef,
StreamingDistributionConfigWithTagsTypeDef,
TagResourceRequestRequestTypeDef,
CacheBehaviorTypeDef,
DefaultCacheBehaviorTypeDef,
CachePolicyConfigTypeDef,
CreateOriginRequestPolicyRequestRequestTypeDef,
GetOriginRequestPolicyConfigResultTypeDef,
OriginRequestPolicyTypeDef,
UpdateOriginRequestPolicyRequestRequestTypeDef,
ContinuousDeploymentPolicyConfigTypeDef,
KeyGroupListTypeDef,
OriginsTypeDef,
FieldLevelEncryptionProfileConfigTypeDef,
FieldLevelEncryptionProfileSummaryTypeDef,
CreateRealtimeLogConfigResultTypeDef,
GetRealtimeLogConfigResultTypeDef,
RealtimeLogConfigsTypeDef,
UpdateRealtimeLogConfigResultTypeDef,
ListFunctionsResultTypeDef,
TestFunctionResultTypeDef,
CreateInvalidationResultTypeDef,
GetInvalidationResultTypeDef,
StreamingDistributionTypeDef,
OriginGroupsTypeDef,
FieldLevelEncryptionConfigTypeDef,
FieldLevelEncryptionSummaryTypeDef,
CreateResponseHeadersPolicyRequestRequestTypeDef,
GetResponseHeadersPolicyConfigResultTypeDef,
ResponseHeadersPolicyTypeDef,
UpdateResponseHeadersPolicyRequestRequestTypeDef,
ListStreamingDistributionsResultTypeDef,
CreateStreamingDistributionWithTagsRequestRequestTypeDef,
CacheBehaviorsTypeDef,
CachePolicyTypeDef,
CreateCachePolicyRequestRequestTypeDef,
GetCachePolicyConfigResultTypeDef,
UpdateCachePolicyRequestRequestTypeDef,
CreateOriginRequestPolicyResultTypeDef,
GetOriginRequestPolicyResultTypeDef,
OriginRequestPolicySummaryTypeDef,
UpdateOriginRequestPolicyResultTypeDef,
ContinuousDeploymentPolicyTypeDef,
CreateContinuousDeploymentPolicyRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigResultTypeDef,
UpdateContinuousDeploymentPolicyRequestRequestTypeDef,
ListKeyGroupsResultTypeDef,
CreateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileTypeDef,
GetFieldLevelEncryptionProfileConfigResultTypeDef,
UpdateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileListTypeDef,
ListRealtimeLogConfigsResultTypeDef,
CreateStreamingDistributionResultTypeDef,
CreateStreamingDistributionWithTagsResultTypeDef,
GetStreamingDistributionResultTypeDef,
UpdateStreamingDistributionResultTypeDef,
CreateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionTypeDef,
GetFieldLevelEncryptionConfigResultTypeDef,
UpdateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionListTypeDef,
CreateResponseHeadersPolicyResultTypeDef,
GetResponseHeadersPolicyResultTypeDef,
ResponseHeadersPolicySummaryTypeDef,
UpdateResponseHeadersPolicyResultTypeDef,
DistributionConfigTypeDef,
DistributionSummaryTypeDef,
CachePolicySummaryTypeDef,
CreateCachePolicyResultTypeDef,
GetCachePolicyResultTypeDef,
UpdateCachePolicyResultTypeDef,
OriginRequestPolicyListTypeDef,
ContinuousDeploymentPolicySummaryTypeDef,
CreateContinuousDeploymentPolicyResultTypeDef,
GetContinuousDeploymentPolicyResultTypeDef,
UpdateContinuousDeploymentPolicyResultTypeDef,
CreateFieldLevelEncryptionProfileResultTypeDef,
GetFieldLevelEncryptionProfileResultTypeDef,
UpdateFieldLevelEncryptionProfileResultTypeDef,
ListFieldLevelEncryptionProfilesResultTypeDef,
CreateFieldLevelEncryptionConfigResultTypeDef,
GetFieldLevelEncryptionResultTypeDef,
UpdateFieldLevelEncryptionConfigResultTypeDef,
ListFieldLevelEncryptionConfigsResultTypeDef,
ResponseHeadersPolicyListTypeDef,
CreateDistributionRequestRequestTypeDef,
DistributionConfigWithTagsTypeDef,
DistributionTypeDef,
GetDistributionConfigResultTypeDef,
UpdateDistributionRequestRequestTypeDef,
DistributionListTypeDef,
CachePolicyListTypeDef,
ListOriginRequestPoliciesResultTypeDef,
ContinuousDeploymentPolicyListTypeDef,
ListResponseHeadersPoliciesResultTypeDef,
CreateDistributionWithTagsRequestRequestTypeDef,
CopyDistributionResultTypeDef,
CreateDistributionResultTypeDef,
CreateDistributionWithTagsResultTypeDef,
GetDistributionResultTypeDef,
UpdateDistributionResultTypeDef,
UpdateDistributionWithStagingConfigResultTypeDef,
ListDistributionsByRealtimeLogConfigResultTypeDef,
ListDistributionsByWebACLIdResultTypeDef,
ListDistributionsResultTypeDef,
ListCachePoliciesResultTypeDef,
ListContinuousDeploymentPoliciesResultTypeDef,
)
def get_structure() -> AliasICPRecordalTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudfront` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package help
Summary: Development documents and examples for mypy-boto3-cloudfront
Provides: python3-mypy-boto3-cloudfront-doc
%description help
# mypy-boto3-cloudfront
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://pypi.org/project/mypy-boto3-cloudfront)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-cloudfront)
Type annotations for
[boto3.CloudFront 1.26.77](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront.html#CloudFront)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudfront docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudfront](#mypy-boto3-cloudfront)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
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.
```bash
# 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
```bash
python -m pip uninstall -y mypy-boto3-cloudfront
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudfront]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudfront]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudfront]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudfront]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFrontClient` provides annotations for `boto3.client("cloudfront")`.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
client: CloudFrontClient = Session().client("cloudfront")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudfront.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.paginator import (
ListCloudFrontOriginAccessIdentitiesPaginator,
ListDistributionsPaginator,
ListInvalidationsPaginator,
ListStreamingDistributionsPaginator,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_cloud_front_origin_access_identities_paginator: ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator(
"list_cloud_front_origin_access_identities"
)
list_distributions_paginator: ListDistributionsPaginator = client.get_paginator(
"list_distributions"
)
list_invalidations_paginator: ListInvalidationsPaginator = client.get_paginator(
"list_invalidations"
)
list_streaming_distributions_paginator: ListStreamingDistributionsPaginator = client.get_paginator(
"list_streaming_distributions"
)
```
### Waiters annotations
`mypy_boto3_cloudfront.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.waiter import (
DistributionDeployedWaiter,
InvalidationCompletedWaiter,
StreamingDistributionDeployedWaiter,
)
client: CloudFrontClient = Session().client("cloudfront")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
distribution_deployed_waiter: DistributionDeployedWaiter = client.get_waiter(
"distribution_deployed"
)
invalidation_completed_waiter: InvalidationCompletedWaiter = client.get_waiter(
"invalidation_completed"
)
streaming_distribution_deployed_waiter: StreamingDistributionDeployedWaiter = client.get_waiter(
"streaming_distribution_deployed"
)
```
### Literals
`mypy_boto3_cloudfront.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_cloudfront.literals import (
CachePolicyCookieBehaviorType,
CachePolicyHeaderBehaviorType,
CachePolicyQueryStringBehaviorType,
CachePolicyTypeType,
CertificateSourceType,
ContinuousDeploymentPolicyTypeType,
DistributionDeployedWaiterName,
EventTypeType,
FormatType,
FrameOptionsListType,
FunctionRuntimeType,
FunctionStageType,
GeoRestrictionTypeType,
HttpVersionType,
ICPRecordalStatusType,
InvalidationCompletedWaiterName,
ItemSelectionType,
ListCloudFrontOriginAccessIdentitiesPaginatorName,
ListDistributionsPaginatorName,
ListInvalidationsPaginatorName,
ListStreamingDistributionsPaginatorName,
MethodType,
MinimumProtocolVersionType,
OriginAccessControlOriginTypesType,
OriginAccessControlSigningBehaviorsType,
OriginAccessControlSigningProtocolsType,
OriginProtocolPolicyType,
OriginRequestPolicyCookieBehaviorType,
OriginRequestPolicyHeaderBehaviorType,
OriginRequestPolicyQueryStringBehaviorType,
OriginRequestPolicyTypeType,
PriceClassType,
RealtimeMetricsSubscriptionStatusType,
ReferrerPolicyListType,
ResponseHeadersPolicyAccessControlAllowMethodsValuesType,
ResponseHeadersPolicyTypeType,
SSLSupportMethodType,
SslProtocolType,
StreamingDistributionDeployedWaiterName,
ViewerProtocolPolicyType,
CloudFrontServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
)
def check_value(value: CachePolicyCookieBehaviorType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudfront.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudfront.type_defs import (
AliasICPRecordalTypeDef,
AliasesTypeDef,
CachedMethodsTypeDef,
AssociateAliasRequestRequestTypeDef,
TrustedKeyGroupsTypeDef,
TrustedSignersTypeDef,
CookieNamesTypeDef,
HeadersTypeDef,
QueryStringNamesTypeDef,
CloudFrontOriginAccessIdentityConfigTypeDef,
CloudFrontOriginAccessIdentitySummaryTypeDef,
ConflictingAliasTypeDef,
ContentTypeProfileTypeDef,
StagingDistributionDnsNamesTypeDef,
ContinuousDeploymentSingleHeaderConfigTypeDef,
SessionStickinessConfigTypeDef,
CopyDistributionRequestRequestTypeDef,
ResponseMetadataTypeDef,
FunctionConfigTypeDef,
KeyGroupConfigTypeDef,
OriginAccessControlConfigTypeDef,
PublicKeyConfigTypeDef,
CustomErrorResponseTypeDef,
OriginCustomHeaderTypeDef,
OriginSslProtocolsTypeDef,
DeleteCachePolicyRequestRequestTypeDef,
DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef,
DeleteContinuousDeploymentPolicyRequestRequestTypeDef,
DeleteDistributionRequestRequestTypeDef,
DeleteFieldLevelEncryptionConfigRequestRequestTypeDef,
DeleteFieldLevelEncryptionProfileRequestRequestTypeDef,
DeleteFunctionRequestRequestTypeDef,
DeleteKeyGroupRequestRequestTypeDef,
DeleteMonitoringSubscriptionRequestRequestTypeDef,
DeleteOriginAccessControlRequestRequestTypeDef,
DeleteOriginRequestPolicyRequestRequestTypeDef,
DeletePublicKeyRequestRequestTypeDef,
DeleteRealtimeLogConfigRequestRequestTypeDef,
DeleteResponseHeadersPolicyRequestRequestTypeDef,
DeleteStreamingDistributionRequestRequestTypeDef,
DescribeFunctionRequestRequestTypeDef,
LoggingConfigTypeDef,
ViewerCertificateTypeDef,
DistributionIdListTypeDef,
FieldPatternsTypeDef,
KinesisStreamConfigTypeDef,
QueryStringCacheKeysTypeDef,
FunctionAssociationTypeDef,
FunctionMetadataTypeDef,
GeoRestrictionTypeDef,
GetCachePolicyConfigRequestRequestTypeDef,
GetCachePolicyRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef,
GetCloudFrontOriginAccessIdentityRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigRequestRequestTypeDef,
GetContinuousDeploymentPolicyRequestRequestTypeDef,
GetDistributionConfigRequestRequestTypeDef,
WaiterConfigTypeDef,
GetDistributionRequestRequestTypeDef,
GetFieldLevelEncryptionConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef,
GetFieldLevelEncryptionProfileRequestRequestTypeDef,
GetFieldLevelEncryptionRequestRequestTypeDef,
GetFunctionRequestRequestTypeDef,
GetInvalidationRequestRequestTypeDef,
GetKeyGroupConfigRequestRequestTypeDef,
GetKeyGroupRequestRequestTypeDef,
GetMonitoringSubscriptionRequestRequestTypeDef,
GetOriginAccessControlConfigRequestRequestTypeDef,
GetOriginAccessControlRequestRequestTypeDef,
GetOriginRequestPolicyConfigRequestRequestTypeDef,
GetOriginRequestPolicyRequestRequestTypeDef,
GetPublicKeyConfigRequestRequestTypeDef,
GetPublicKeyRequestRequestTypeDef,
GetRealtimeLogConfigRequestRequestTypeDef,
GetResponseHeadersPolicyConfigRequestRequestTypeDef,
GetResponseHeadersPolicyRequestRequestTypeDef,
GetStreamingDistributionConfigRequestRequestTypeDef,
GetStreamingDistributionRequestRequestTypeDef,
PathsTypeDef,
InvalidationSummaryTypeDef,
KeyPairIdsTypeDef,
LambdaFunctionAssociationTypeDef,
ListCachePoliciesRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef,
ListConflictingAliasesRequestRequestTypeDef,
ListContinuousDeploymentPoliciesRequestRequestTypeDef,
ListDistributionsByCachePolicyIdRequestRequestTypeDef,
ListDistributionsByKeyGroupRequestRequestTypeDef,
ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef,
ListDistributionsByRealtimeLogConfigRequestRequestTypeDef,
ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef,
ListDistributionsByWebACLIdRequestRequestTypeDef,
ListDistributionsRequestRequestTypeDef,
ListFieldLevelEncryptionConfigsRequestRequestTypeDef,
ListFieldLevelEncryptionProfilesRequestRequestTypeDef,
ListFunctionsRequestRequestTypeDef,
ListInvalidationsRequestRequestTypeDef,
ListKeyGroupsRequestRequestTypeDef,
ListOriginAccessControlsRequestRequestTypeDef,
ListOriginRequestPoliciesRequestRequestTypeDef,
ListPublicKeysRequestRequestTypeDef,
ListRealtimeLogConfigsRequestRequestTypeDef,
ListResponseHeadersPoliciesRequestRequestTypeDef,
ListStreamingDistributionsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
RealtimeMetricsSubscriptionConfigTypeDef,
OriginAccessControlSummaryTypeDef,
StatusCodesTypeDef,
OriginGroupMemberTypeDef,
OriginShieldTypeDef,
S3OriginConfigTypeDef,
PublicKeySummaryTypeDef,
PublishFunctionRequestRequestTypeDef,
QueryArgProfileTypeDef,
ResponseHeadersPolicyAccessControlAllowHeadersTypeDef,
ResponseHeadersPolicyAccessControlAllowMethodsTypeDef,
ResponseHeadersPolicyAccessControlAllowOriginsTypeDef,
ResponseHeadersPolicyAccessControlExposeHeadersTypeDef,
ResponseHeadersPolicyServerTimingHeadersConfigTypeDef,
ResponseHeadersPolicyContentSecurityPolicyTypeDef,
ResponseHeadersPolicyContentTypeOptionsTypeDef,
ResponseHeadersPolicyCustomHeaderTypeDef,
ResponseHeadersPolicyFrameOptionsTypeDef,
ResponseHeadersPolicyReferrerPolicyTypeDef,
ResponseHeadersPolicyRemoveHeaderTypeDef,
ResponseHeadersPolicyStrictTransportSecurityTypeDef,
ResponseHeadersPolicyXSSProtectionTypeDef,
S3OriginTypeDef,
StreamingLoggingConfigTypeDef,
TagKeysTypeDef,
TagTypeDef,
TestFunctionRequestRequestTypeDef,
UpdateDistributionWithStagingConfigRequestRequestTypeDef,
AllowedMethodsTypeDef,
CachePolicyCookiesConfigTypeDef,
CookiePreferenceTypeDef,
OriginRequestPolicyCookiesConfigTypeDef,
CachePolicyHeadersConfigTypeDef,
OriginRequestPolicyHeadersConfigTypeDef,
CachePolicyQueryStringsConfigTypeDef,
OriginRequestPolicyQueryStringsConfigTypeDef,
CloudFrontOriginAccessIdentityTypeDef,
CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef,
CloudFrontOriginAccessIdentityListTypeDef,
ConflictingAliasesListTypeDef,
ContentTypeProfilesTypeDef,
ContinuousDeploymentSingleWeightConfigTypeDef,
EmptyResponseMetadataTypeDef,
GetCloudFrontOriginAccessIdentityConfigResultTypeDef,
GetFunctionResultTypeDef,
CreateFunctionRequestRequestTypeDef,
UpdateFunctionRequestRequestTypeDef,
CreateKeyGroupRequestRequestTypeDef,
GetKeyGroupConfigResultTypeDef,
KeyGroupTypeDef,
UpdateKeyGroupRequestRequestTypeDef,
CreateOriginAccessControlRequestRequestTypeDef,
GetOriginAccessControlConfigResultTypeDef,
OriginAccessControlTypeDef,
UpdateOriginAccessControlRequestRequestTypeDef,
CreatePublicKeyRequestRequestTypeDef,
GetPublicKeyConfigResultTypeDef,
PublicKeyTypeDef,
UpdatePublicKeyRequestRequestTypeDef,
CustomErrorResponsesTypeDef,
CustomHeadersTypeDef,
CustomOriginConfigTypeDef,
ListDistributionsByCachePolicyIdResultTypeDef,
ListDistributionsByKeyGroupResultTypeDef,
ListDistributionsByOriginRequestPolicyIdResultTypeDef,
ListDistributionsByResponseHeadersPolicyIdResultTypeDef,
EncryptionEntityTypeDef,
EndPointTypeDef,
FunctionAssociationsTypeDef,
FunctionSummaryTypeDef,
RestrictionsTypeDef,
GetDistributionRequestDistributionDeployedWaitTypeDef,
GetInvalidationRequestInvalidationCompletedWaitTypeDef,
GetStreamingDistributionRequestStreamingDistributionDeployedWaitTypeDef,
InvalidationBatchTypeDef,
InvalidationListTypeDef,
KGKeyPairIdsTypeDef,
SignerTypeDef,
LambdaFunctionAssociationsTypeDef,
ListCloudFrontOriginAccessIdentitiesRequestListCloudFrontOriginAccessIdentitiesPaginateTypeDef,
ListDistributionsRequestListDistributionsPaginateTypeDef,
ListInvalidationsRequestListInvalidationsPaginateTypeDef,
ListStreamingDistributionsRequestListStreamingDistributionsPaginateTypeDef,
MonitoringSubscriptionTypeDef,
OriginAccessControlListTypeDef,
OriginGroupFailoverCriteriaTypeDef,
OriginGroupMembersTypeDef,
PublicKeyListTypeDef,
QueryArgProfilesTypeDef,
ResponseHeadersPolicyCorsConfigTypeDef,
ResponseHeadersPolicyCustomHeadersConfigTypeDef,
ResponseHeadersPolicyRemoveHeadersConfigTypeDef,
ResponseHeadersPolicySecurityHeadersConfigTypeDef,
StreamingDistributionSummaryTypeDef,
StreamingDistributionConfigTypeDef,
UntagResourceRequestRequestTypeDef,
TagsTypeDef,
ForwardedValuesTypeDef,
ParametersInCacheKeyAndForwardedToOriginTypeDef,
OriginRequestPolicyConfigTypeDef,
CreateCloudFrontOriginAccessIdentityResultTypeDef,
GetCloudFrontOriginAccessIdentityResultTypeDef,
UpdateCloudFrontOriginAccessIdentityResultTypeDef,
ListCloudFrontOriginAccessIdentitiesResultTypeDef,
ListConflictingAliasesResultTypeDef,
ContentTypeProfileConfigTypeDef,
TrafficConfigTypeDef,
CreateKeyGroupResultTypeDef,
GetKeyGroupResultTypeDef,
KeyGroupSummaryTypeDef,
UpdateKeyGroupResultTypeDef,
CreateOriginAccessControlResultTypeDef,
GetOriginAccessControlResultTypeDef,
UpdateOriginAccessControlResultTypeDef,
CreatePublicKeyResultTypeDef,
GetPublicKeyResultTypeDef,
UpdatePublicKeyResultTypeDef,
OriginTypeDef,
EncryptionEntitiesTypeDef,
CreateRealtimeLogConfigRequestRequestTypeDef,
RealtimeLogConfigTypeDef,
UpdateRealtimeLogConfigRequestRequestTypeDef,
CreateFunctionResultTypeDef,
DescribeFunctionResultTypeDef,
FunctionListTypeDef,
PublishFunctionResultTypeDef,
TestResultTypeDef,
UpdateFunctionResultTypeDef,
CreateInvalidationRequestRequestTypeDef,
InvalidationTypeDef,
ListInvalidationsResultTypeDef,
ActiveTrustedKeyGroupsTypeDef,
ActiveTrustedSignersTypeDef,
CreateMonitoringSubscriptionRequestRequestTypeDef,
CreateMonitoringSubscriptionResultTypeDef,
GetMonitoringSubscriptionResultTypeDef,
ListOriginAccessControlsResultTypeDef,
OriginGroupTypeDef,
ListPublicKeysResultTypeDef,
QueryArgProfileConfigTypeDef,
ResponseHeadersPolicyConfigTypeDef,
StreamingDistributionListTypeDef,
CreateStreamingDistributionRequestRequestTypeDef,
GetStreamingDistributionConfigResultTypeDef,
UpdateStreamingDistributionRequestRequestTypeDef,
ListTagsForResourceResultTypeDef,
StreamingDistributionConfigWithTagsTypeDef,
TagResourceRequestRequestTypeDef,
CacheBehaviorTypeDef,
DefaultCacheBehaviorTypeDef,
CachePolicyConfigTypeDef,
CreateOriginRequestPolicyRequestRequestTypeDef,
GetOriginRequestPolicyConfigResultTypeDef,
OriginRequestPolicyTypeDef,
UpdateOriginRequestPolicyRequestRequestTypeDef,
ContinuousDeploymentPolicyConfigTypeDef,
KeyGroupListTypeDef,
OriginsTypeDef,
FieldLevelEncryptionProfileConfigTypeDef,
FieldLevelEncryptionProfileSummaryTypeDef,
CreateRealtimeLogConfigResultTypeDef,
GetRealtimeLogConfigResultTypeDef,
RealtimeLogConfigsTypeDef,
UpdateRealtimeLogConfigResultTypeDef,
ListFunctionsResultTypeDef,
TestFunctionResultTypeDef,
CreateInvalidationResultTypeDef,
GetInvalidationResultTypeDef,
StreamingDistributionTypeDef,
OriginGroupsTypeDef,
FieldLevelEncryptionConfigTypeDef,
FieldLevelEncryptionSummaryTypeDef,
CreateResponseHeadersPolicyRequestRequestTypeDef,
GetResponseHeadersPolicyConfigResultTypeDef,
ResponseHeadersPolicyTypeDef,
UpdateResponseHeadersPolicyRequestRequestTypeDef,
ListStreamingDistributionsResultTypeDef,
CreateStreamingDistributionWithTagsRequestRequestTypeDef,
CacheBehaviorsTypeDef,
CachePolicyTypeDef,
CreateCachePolicyRequestRequestTypeDef,
GetCachePolicyConfigResultTypeDef,
UpdateCachePolicyRequestRequestTypeDef,
CreateOriginRequestPolicyResultTypeDef,
GetOriginRequestPolicyResultTypeDef,
OriginRequestPolicySummaryTypeDef,
UpdateOriginRequestPolicyResultTypeDef,
ContinuousDeploymentPolicyTypeDef,
CreateContinuousDeploymentPolicyRequestRequestTypeDef,
GetContinuousDeploymentPolicyConfigResultTypeDef,
UpdateContinuousDeploymentPolicyRequestRequestTypeDef,
ListKeyGroupsResultTypeDef,
CreateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileTypeDef,
GetFieldLevelEncryptionProfileConfigResultTypeDef,
UpdateFieldLevelEncryptionProfileRequestRequestTypeDef,
FieldLevelEncryptionProfileListTypeDef,
ListRealtimeLogConfigsResultTypeDef,
CreateStreamingDistributionResultTypeDef,
CreateStreamingDistributionWithTagsResultTypeDef,
GetStreamingDistributionResultTypeDef,
UpdateStreamingDistributionResultTypeDef,
CreateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionTypeDef,
GetFieldLevelEncryptionConfigResultTypeDef,
UpdateFieldLevelEncryptionConfigRequestRequestTypeDef,
FieldLevelEncryptionListTypeDef,
CreateResponseHeadersPolicyResultTypeDef,
GetResponseHeadersPolicyResultTypeDef,
ResponseHeadersPolicySummaryTypeDef,
UpdateResponseHeadersPolicyResultTypeDef,
DistributionConfigTypeDef,
DistributionSummaryTypeDef,
CachePolicySummaryTypeDef,
CreateCachePolicyResultTypeDef,
GetCachePolicyResultTypeDef,
UpdateCachePolicyResultTypeDef,
OriginRequestPolicyListTypeDef,
ContinuousDeploymentPolicySummaryTypeDef,
CreateContinuousDeploymentPolicyResultTypeDef,
GetContinuousDeploymentPolicyResultTypeDef,
UpdateContinuousDeploymentPolicyResultTypeDef,
CreateFieldLevelEncryptionProfileResultTypeDef,
GetFieldLevelEncryptionProfileResultTypeDef,
UpdateFieldLevelEncryptionProfileResultTypeDef,
ListFieldLevelEncryptionProfilesResultTypeDef,
CreateFieldLevelEncryptionConfigResultTypeDef,
GetFieldLevelEncryptionResultTypeDef,
UpdateFieldLevelEncryptionConfigResultTypeDef,
ListFieldLevelEncryptionConfigsResultTypeDef,
ResponseHeadersPolicyListTypeDef,
CreateDistributionRequestRequestTypeDef,
DistributionConfigWithTagsTypeDef,
DistributionTypeDef,
GetDistributionConfigResultTypeDef,
UpdateDistributionRequestRequestTypeDef,
DistributionListTypeDef,
CachePolicyListTypeDef,
ListOriginRequestPoliciesResultTypeDef,
ContinuousDeploymentPolicyListTypeDef,
ListResponseHeadersPoliciesResultTypeDef,
CreateDistributionWithTagsRequestRequestTypeDef,
CopyDistributionResultTypeDef,
CreateDistributionResultTypeDef,
CreateDistributionWithTagsResultTypeDef,
GetDistributionResultTypeDef,
UpdateDistributionResultTypeDef,
UpdateDistributionWithStagingConfigResultTypeDef,
ListDistributionsByRealtimeLogConfigResultTypeDef,
ListDistributionsByWebACLIdResultTypeDef,
ListDistributionsResultTypeDef,
ListCachePoliciesResultTypeDef,
ListContinuousDeploymentPoliciesResultTypeDef,
)
def get_structure() -> AliasICPRecordalTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudfront` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudfront/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%prep
%autosetup -n mypy-boto3-cloudfront-1.26.77
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-mypy-boto3-cloudfront -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.77-1
- Package Spec generated