%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-clouddirectory
Version: 1.26.60
Release: 1
Summary: Type annotations for boto3.CloudDirectory 1.26.60 service generated with mypy-boto3-builder 7.12.3
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/1e/04/4c5f91b0c91c9f2b1bfe19000d39a489bbca941311b8e8a7af9680a03289/mypy-boto3-clouddirectory-1.26.60.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-clouddirectory
[![PyPI - mypy-boto3-clouddirectory](https://img.shields.io/pypi/v/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-clouddirectory?color=blue)](https://pypistats.org/packages/mypy-boto3-clouddirectory)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.CloudDirectory 1.26.60](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/clouddirectory.html#CloudDirectory)
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.3](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-clouddirectory docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_clouddirectory/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-clouddirectory](#mypy-boto3-clouddirectory)
- [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)
- [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 `CloudDirectory`.
### From PyPI with pip
Install `boto3-stubs` for `CloudDirectory` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[clouddirectory]'
# 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[clouddirectory]'
# standalone installation
python -m pip install mypy-boto3-clouddirectory
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-clouddirectory
```
## 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[clouddirectory]'`
```
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[clouddirectory]'
```
- 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[clouddirectory]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
- 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'`
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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
`CloudDirectoryClient` provides annotations for
`boto3.client("clouddirectory")`.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
client: CloudDirectoryClient = Session().client("clouddirectory")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_clouddirectory.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
from mypy_boto3_clouddirectory.paginator import (
ListAppliedSchemaArnsPaginator,
ListAttachedIndicesPaginator,
ListDevelopmentSchemaArnsPaginator,
ListDirectoriesPaginator,
ListFacetAttributesPaginator,
ListFacetNamesPaginator,
ListIncomingTypedLinksPaginator,
ListIndexPaginator,
ListManagedSchemaArnsPaginator,
ListObjectAttributesPaginator,
ListObjectParentPathsPaginator,
ListObjectPoliciesPaginator,
ListOutgoingTypedLinksPaginator,
ListPolicyAttachmentsPaginator,
ListPublishedSchemaArnsPaginator,
ListTagsForResourcePaginator,
ListTypedLinkFacetAttributesPaginator,
ListTypedLinkFacetNamesPaginator,
LookupPolicyPaginator,
)
client: CloudDirectoryClient = Session().client("clouddirectory")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_applied_schema_arns_paginator: ListAppliedSchemaArnsPaginator = client.get_paginator(
"list_applied_schema_arns"
)
list_attached_indices_paginator: ListAttachedIndicesPaginator = client.get_paginator(
"list_attached_indices"
)
list_development_schema_arns_paginator: ListDevelopmentSchemaArnsPaginator = client.get_paginator(
"list_development_schema_arns"
)
list_directories_paginator: ListDirectoriesPaginator = client.get_paginator("list_directories")
list_facet_attributes_paginator: ListFacetAttributesPaginator = client.get_paginator(
"list_facet_attributes"
)
list_facet_names_paginator: ListFacetNamesPaginator = client.get_paginator("list_facet_names")
list_incoming_typed_links_paginator: ListIncomingTypedLinksPaginator = client.get_paginator(
"list_incoming_typed_links"
)
list_index_paginator: ListIndexPaginator = client.get_paginator("list_index")
list_managed_schema_arns_paginator: ListManagedSchemaArnsPaginator = client.get_paginator(
"list_managed_schema_arns"
)
list_object_attributes_paginator: ListObjectAttributesPaginator = client.get_paginator(
"list_object_attributes"
)
list_object_parent_paths_paginator: ListObjectParentPathsPaginator = client.get_paginator(
"list_object_parent_paths"
)
list_object_policies_paginator: ListObjectPoliciesPaginator = client.get_paginator(
"list_object_policies"
)
list_outgoing_typed_links_paginator: ListOutgoingTypedLinksPaginator = client.get_paginator(
"list_outgoing_typed_links"
)
list_policy_attachments_paginator: ListPolicyAttachmentsPaginator = client.get_paginator(
"list_policy_attachments"
)
list_published_schema_arns_paginator: ListPublishedSchemaArnsPaginator = client.get_paginator(
"list_published_schema_arns"
)
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
list_typed_link_facet_attributes_paginator: ListTypedLinkFacetAttributesPaginator = (
client.get_paginator("list_typed_link_facet_attributes")
)
list_typed_link_facet_names_paginator: ListTypedLinkFacetNamesPaginator = client.get_paginator(
"list_typed_link_facet_names"
)
lookup_policy_paginator: LookupPolicyPaginator = client.get_paginator("lookup_policy")
```
### Literals
`mypy_boto3_clouddirectory.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_clouddirectory.literals import (
BatchReadExceptionTypeType,
ConsistencyLevelType,
DirectoryStateType,
FacetAttributeTypeType,
FacetStyleType,
ListAppliedSchemaArnsPaginatorName,
ListAttachedIndicesPaginatorName,
ListDevelopmentSchemaArnsPaginatorName,
ListDirectoriesPaginatorName,
ListFacetAttributesPaginatorName,
ListFacetNamesPaginatorName,
ListIncomingTypedLinksPaginatorName,
ListIndexPaginatorName,
ListManagedSchemaArnsPaginatorName,
ListObjectAttributesPaginatorName,
ListObjectParentPathsPaginatorName,
ListObjectPoliciesPaginatorName,
ListOutgoingTypedLinksPaginatorName,
ListPolicyAttachmentsPaginatorName,
ListPublishedSchemaArnsPaginatorName,
ListTagsForResourcePaginatorName,
ListTypedLinkFacetAttributesPaginatorName,
ListTypedLinkFacetNamesPaginatorName,
LookupPolicyPaginatorName,
ObjectTypeType,
RangeModeType,
RequiredAttributeBehaviorType,
RuleTypeType,
UpdateActionTypeType,
CloudDirectoryServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: BatchReadExceptionTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_clouddirectory.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_clouddirectory.type_defs import (
ObjectReferenceTypeDef,
SchemaFacetTypeDef,
ApplySchemaRequestRequestTypeDef,
ResponseMetadataTypeDef,
TypedLinkSchemaAndFacetNameTypeDef,
AttributeKeyTypeDef,
TypedAttributeValueTypeDef,
BatchAttachObjectResponseTypeDef,
BatchAttachToIndexResponseTypeDef,
BatchCreateIndexResponseTypeDef,
BatchCreateObjectResponseTypeDef,
BatchDetachFromIndexResponseTypeDef,
BatchDetachObjectResponseTypeDef,
BatchListObjectChildrenResponseTypeDef,
PathToObjectIdentifiersTypeDef,
ObjectIdentifierAndLinkNameTupleTypeDef,
BatchListObjectPoliciesResponseTypeDef,
BatchListPolicyAttachmentsResponseTypeDef,
BatchReadExceptionTypeDef,
BatchUpdateObjectAttributesResponseTypeDef,
CreateDirectoryRequestRequestTypeDef,
CreateSchemaRequestRequestTypeDef,
DeleteDirectoryRequestRequestTypeDef,
DeleteFacetRequestRequestTypeDef,
DeleteSchemaRequestRequestTypeDef,
DeleteTypedLinkFacetRequestRequestTypeDef,
DirectoryTypeDef,
DisableDirectoryRequestRequestTypeDef,
EnableDirectoryRequestRequestTypeDef,
RuleTypeDef,
FacetAttributeReferenceTypeDef,
FacetTypeDef,
GetAppliedSchemaVersionRequestRequestTypeDef,
GetDirectoryRequestRequestTypeDef,
GetFacetRequestRequestTypeDef,
GetSchemaAsJsonRequestRequestTypeDef,
GetTypedLinkFacetInformationRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListAppliedSchemaArnsRequestRequestTypeDef,
ListDevelopmentSchemaArnsRequestRequestTypeDef,
ListDirectoriesRequestRequestTypeDef,
ListFacetAttributesRequestRequestTypeDef,
ListFacetNamesRequestRequestTypeDef,
ListManagedSchemaArnsRequestRequestTypeDef,
ListPublishedSchemaArnsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
TagTypeDef,
ListTypedLinkFacetAttributesRequestRequestTypeDef,
ListTypedLinkFacetNamesRequestRequestTypeDef,
PolicyAttachmentTypeDef,
PublishSchemaRequestRequestTypeDef,
PutSchemaFromJsonRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateSchemaRequestRequestTypeDef,
UpgradeAppliedSchemaRequestRequestTypeDef,
UpgradePublishedSchemaRequestRequestTypeDef,
AttachObjectRequestRequestTypeDef,
AttachPolicyRequestRequestTypeDef,
AttachToIndexRequestRequestTypeDef,
BatchAttachObjectTypeDef,
BatchAttachPolicyTypeDef,
BatchAttachToIndexTypeDef,
BatchDeleteObjectTypeDef,
BatchDetachFromIndexTypeDef,
BatchDetachObjectTypeDef,
BatchDetachPolicyTypeDef,
BatchGetObjectInformationTypeDef,
BatchListAttachedIndicesTypeDef,
BatchListObjectChildrenTypeDef,
BatchListObjectParentPathsTypeDef,
BatchListObjectParentsTypeDef,
BatchListObjectPoliciesTypeDef,
BatchListPolicyAttachmentsTypeDef,
BatchLookupPolicyTypeDef,
DeleteObjectRequestRequestTypeDef,
DetachFromIndexRequestRequestTypeDef,
DetachObjectRequestRequestTypeDef,
DetachPolicyRequestRequestTypeDef,
GetObjectInformationRequestRequestTypeDef,
ListAttachedIndicesRequestRequestTypeDef,
ListObjectChildrenRequestRequestTypeDef,
ListObjectParentPathsRequestRequestTypeDef,
ListObjectParentsRequestRequestTypeDef,
ListObjectPoliciesRequestRequestTypeDef,
ListPolicyAttachmentsRequestRequestTypeDef,
LookupPolicyRequestRequestTypeDef,
BatchGetObjectAttributesTypeDef,
BatchGetObjectInformationResponseTypeDef,
BatchListObjectAttributesTypeDef,
BatchRemoveFacetFromObjectTypeDef,
GetObjectAttributesRequestRequestTypeDef,
ListObjectAttributesRequestRequestTypeDef,
RemoveFacetFromObjectRequestRequestTypeDef,
ApplySchemaResponseTypeDef,
AttachObjectResponseTypeDef,
AttachToIndexResponseTypeDef,
CreateDirectoryResponseTypeDef,
CreateIndexResponseTypeDef,
CreateObjectResponseTypeDef,
CreateSchemaResponseTypeDef,
DeleteDirectoryResponseTypeDef,
DeleteSchemaResponseTypeDef,
DetachFromIndexResponseTypeDef,
DetachObjectResponseTypeDef,
DisableDirectoryResponseTypeDef,
EmptyResponseMetadataTypeDef,
EnableDirectoryResponseTypeDef,
GetAppliedSchemaVersionResponseTypeDef,
GetObjectInformationResponseTypeDef,
GetSchemaAsJsonResponseTypeDef,
GetTypedLinkFacetInformationResponseTypeDef,
ListAppliedSchemaArnsResponseTypeDef,
ListDevelopmentSchemaArnsResponseTypeDef,
ListFacetNamesResponseTypeDef,
ListManagedSchemaArnsResponseTypeDef,
ListObjectChildrenResponseTypeDef,
ListObjectPoliciesResponseTypeDef,
ListPolicyAttachmentsResponseTypeDef,
ListPublishedSchemaArnsResponseTypeDef,
ListTypedLinkFacetNamesResponseTypeDef,
PublishSchemaResponseTypeDef,
PutSchemaFromJsonResponseTypeDef,
UpdateObjectAttributesResponseTypeDef,
UpdateSchemaResponseTypeDef,
UpgradeAppliedSchemaResponseTypeDef,
UpgradePublishedSchemaResponseTypeDef,
BatchCreateIndexTypeDef,
CreateIndexRequestRequestTypeDef,
AttributeKeyAndValueTypeDef,
AttributeNameAndValueTypeDef,
LinkAttributeActionTypeDef,
ObjectAttributeActionTypeDef,
TypedAttributeValueRangeTypeDef,
BatchListObjectParentPathsResponseTypeDef,
ListObjectParentPathsResponseTypeDef,
BatchListObjectParentsResponseTypeDef,
ListObjectParentsResponseTypeDef,
GetDirectoryResponseTypeDef,
ListDirectoriesResponseTypeDef,
FacetAttributeDefinitionTypeDef,
TypedLinkAttributeDefinitionTypeDef,
GetFacetResponseTypeDef,
ListAppliedSchemaArnsRequestListAppliedSchemaArnsPaginateTypeDef,
ListAttachedIndicesRequestListAttachedIndicesPaginateTypeDef,
ListDevelopmentSchemaArnsRequestListDevelopmentSchemaArnsPaginateTypeDef,
ListDirectoriesRequestListDirectoriesPaginateTypeDef,
ListFacetAttributesRequestListFacetAttributesPaginateTypeDef,
ListFacetNamesRequestListFacetNamesPaginateTypeDef,
ListManagedSchemaArnsRequestListManagedSchemaArnsPaginateTypeDef,
ListObjectAttributesRequestListObjectAttributesPaginateTypeDef,
ListObjectParentPathsRequestListObjectParentPathsPaginateTypeDef,
ListObjectPoliciesRequestListObjectPoliciesPaginateTypeDef,
ListPolicyAttachmentsRequestListPolicyAttachmentsPaginateTypeDef,
ListPublishedSchemaArnsRequestListPublishedSchemaArnsPaginateTypeDef,
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef,
ListTypedLinkFacetAttributesRequestListTypedLinkFacetAttributesPaginateTypeDef,
ListTypedLinkFacetNamesRequestListTypedLinkFacetNamesPaginateTypeDef,
LookupPolicyRequestLookupPolicyPaginateTypeDef,
ListTagsForResourceResponseTypeDef,
TagResourceRequestRequestTypeDef,
PolicyToPathTypeDef,
AddFacetToObjectRequestRequestTypeDef,
BatchAddFacetToObjectTypeDef,
BatchCreateObjectTypeDef,
BatchGetLinkAttributesResponseTypeDef,
BatchGetObjectAttributesResponseTypeDef,
BatchListObjectAttributesResponseTypeDef,
CreateObjectRequestRequestTypeDef,
GetLinkAttributesResponseTypeDef,
GetObjectAttributesResponseTypeDef,
IndexAttachmentTypeDef,
ListObjectAttributesResponseTypeDef,
AttachTypedLinkRequestRequestTypeDef,
BatchAttachTypedLinkTypeDef,
TypedLinkSpecifierTypeDef,
LinkAttributeUpdateTypeDef,
ObjectAttributeUpdateTypeDef,
ObjectAttributeRangeTypeDef,
TypedLinkAttributeRangeTypeDef,
FacetAttributeTypeDef,
ListTypedLinkFacetAttributesResponseTypeDef,
TypedLinkFacetAttributeUpdateTypeDef,
TypedLinkFacetTypeDef,
BatchLookupPolicyResponseTypeDef,
LookupPolicyResponseTypeDef,
BatchListAttachedIndicesResponseTypeDef,
BatchListIndexResponseTypeDef,
ListAttachedIndicesResponseTypeDef,
ListIndexResponseTypeDef,
AttachTypedLinkResponseTypeDef,
BatchAttachTypedLinkResponseTypeDef,
BatchDetachTypedLinkTypeDef,
BatchGetLinkAttributesTypeDef,
BatchListIncomingTypedLinksResponseTypeDef,
BatchListOutgoingTypedLinksResponseTypeDef,
DetachTypedLinkRequestRequestTypeDef,
GetLinkAttributesRequestRequestTypeDef,
ListIncomingTypedLinksResponseTypeDef,
ListOutgoingTypedLinksResponseTypeDef,
BatchUpdateLinkAttributesTypeDef,
UpdateLinkAttributesRequestRequestTypeDef,
BatchUpdateObjectAttributesTypeDef,
UpdateObjectAttributesRequestRequestTypeDef,
BatchListIndexTypeDef,
ListIndexRequestListIndexPaginateTypeDef,
ListIndexRequestRequestTypeDef,
BatchListIncomingTypedLinksTypeDef,
BatchListOutgoingTypedLinksTypeDef,
ListIncomingTypedLinksRequestListIncomingTypedLinksPaginateTypeDef,
ListIncomingTypedLinksRequestRequestTypeDef,
ListOutgoingTypedLinksRequestListOutgoingTypedLinksPaginateTypeDef,
ListOutgoingTypedLinksRequestRequestTypeDef,
CreateFacetRequestRequestTypeDef,
FacetAttributeUpdateTypeDef,
ListFacetAttributesResponseTypeDef,
UpdateTypedLinkFacetRequestRequestTypeDef,
CreateTypedLinkFacetRequestRequestTypeDef,
BatchWriteOperationResponseTypeDef,
BatchReadSuccessfulResponseTypeDef,
BatchWriteOperationTypeDef,
BatchReadOperationTypeDef,
UpdateFacetRequestRequestTypeDef,
BatchWriteResponseTypeDef,
BatchReadOperationResponseTypeDef,
BatchWriteRequestRequestTypeDef,
BatchReadRequestRequestTypeDef,
BatchReadResponseTypeDef,
)
def get_structure() -> ObjectReferenceTypeDef:
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-clouddirectory` 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_clouddirectory/)
## 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-clouddirectory
Summary: Type annotations for boto3.CloudDirectory 1.26.60 service generated with mypy-boto3-builder 7.12.3
Provides: python-mypy-boto3-clouddirectory
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-clouddirectory
# mypy-boto3-clouddirectory
[![PyPI - mypy-boto3-clouddirectory](https://img.shields.io/pypi/v/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-clouddirectory?color=blue)](https://pypistats.org/packages/mypy-boto3-clouddirectory)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.CloudDirectory 1.26.60](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/clouddirectory.html#CloudDirectory)
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.3](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-clouddirectory docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_clouddirectory/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-clouddirectory](#mypy-boto3-clouddirectory)
- [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)
- [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 `CloudDirectory`.
### From PyPI with pip
Install `boto3-stubs` for `CloudDirectory` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[clouddirectory]'
# 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[clouddirectory]'
# standalone installation
python -m pip install mypy-boto3-clouddirectory
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-clouddirectory
```
## 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[clouddirectory]'`
```
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[clouddirectory]'
```
- 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[clouddirectory]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
- 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'`
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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
`CloudDirectoryClient` provides annotations for
`boto3.client("clouddirectory")`.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
client: CloudDirectoryClient = Session().client("clouddirectory")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_clouddirectory.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
from mypy_boto3_clouddirectory.paginator import (
ListAppliedSchemaArnsPaginator,
ListAttachedIndicesPaginator,
ListDevelopmentSchemaArnsPaginator,
ListDirectoriesPaginator,
ListFacetAttributesPaginator,
ListFacetNamesPaginator,
ListIncomingTypedLinksPaginator,
ListIndexPaginator,
ListManagedSchemaArnsPaginator,
ListObjectAttributesPaginator,
ListObjectParentPathsPaginator,
ListObjectPoliciesPaginator,
ListOutgoingTypedLinksPaginator,
ListPolicyAttachmentsPaginator,
ListPublishedSchemaArnsPaginator,
ListTagsForResourcePaginator,
ListTypedLinkFacetAttributesPaginator,
ListTypedLinkFacetNamesPaginator,
LookupPolicyPaginator,
)
client: CloudDirectoryClient = Session().client("clouddirectory")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_applied_schema_arns_paginator: ListAppliedSchemaArnsPaginator = client.get_paginator(
"list_applied_schema_arns"
)
list_attached_indices_paginator: ListAttachedIndicesPaginator = client.get_paginator(
"list_attached_indices"
)
list_development_schema_arns_paginator: ListDevelopmentSchemaArnsPaginator = client.get_paginator(
"list_development_schema_arns"
)
list_directories_paginator: ListDirectoriesPaginator = client.get_paginator("list_directories")
list_facet_attributes_paginator: ListFacetAttributesPaginator = client.get_paginator(
"list_facet_attributes"
)
list_facet_names_paginator: ListFacetNamesPaginator = client.get_paginator("list_facet_names")
list_incoming_typed_links_paginator: ListIncomingTypedLinksPaginator = client.get_paginator(
"list_incoming_typed_links"
)
list_index_paginator: ListIndexPaginator = client.get_paginator("list_index")
list_managed_schema_arns_paginator: ListManagedSchemaArnsPaginator = client.get_paginator(
"list_managed_schema_arns"
)
list_object_attributes_paginator: ListObjectAttributesPaginator = client.get_paginator(
"list_object_attributes"
)
list_object_parent_paths_paginator: ListObjectParentPathsPaginator = client.get_paginator(
"list_object_parent_paths"
)
list_object_policies_paginator: ListObjectPoliciesPaginator = client.get_paginator(
"list_object_policies"
)
list_outgoing_typed_links_paginator: ListOutgoingTypedLinksPaginator = client.get_paginator(
"list_outgoing_typed_links"
)
list_policy_attachments_paginator: ListPolicyAttachmentsPaginator = client.get_paginator(
"list_policy_attachments"
)
list_published_schema_arns_paginator: ListPublishedSchemaArnsPaginator = client.get_paginator(
"list_published_schema_arns"
)
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
list_typed_link_facet_attributes_paginator: ListTypedLinkFacetAttributesPaginator = (
client.get_paginator("list_typed_link_facet_attributes")
)
list_typed_link_facet_names_paginator: ListTypedLinkFacetNamesPaginator = client.get_paginator(
"list_typed_link_facet_names"
)
lookup_policy_paginator: LookupPolicyPaginator = client.get_paginator("lookup_policy")
```
### Literals
`mypy_boto3_clouddirectory.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_clouddirectory.literals import (
BatchReadExceptionTypeType,
ConsistencyLevelType,
DirectoryStateType,
FacetAttributeTypeType,
FacetStyleType,
ListAppliedSchemaArnsPaginatorName,
ListAttachedIndicesPaginatorName,
ListDevelopmentSchemaArnsPaginatorName,
ListDirectoriesPaginatorName,
ListFacetAttributesPaginatorName,
ListFacetNamesPaginatorName,
ListIncomingTypedLinksPaginatorName,
ListIndexPaginatorName,
ListManagedSchemaArnsPaginatorName,
ListObjectAttributesPaginatorName,
ListObjectParentPathsPaginatorName,
ListObjectPoliciesPaginatorName,
ListOutgoingTypedLinksPaginatorName,
ListPolicyAttachmentsPaginatorName,
ListPublishedSchemaArnsPaginatorName,
ListTagsForResourcePaginatorName,
ListTypedLinkFacetAttributesPaginatorName,
ListTypedLinkFacetNamesPaginatorName,
LookupPolicyPaginatorName,
ObjectTypeType,
RangeModeType,
RequiredAttributeBehaviorType,
RuleTypeType,
UpdateActionTypeType,
CloudDirectoryServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: BatchReadExceptionTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_clouddirectory.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_clouddirectory.type_defs import (
ObjectReferenceTypeDef,
SchemaFacetTypeDef,
ApplySchemaRequestRequestTypeDef,
ResponseMetadataTypeDef,
TypedLinkSchemaAndFacetNameTypeDef,
AttributeKeyTypeDef,
TypedAttributeValueTypeDef,
BatchAttachObjectResponseTypeDef,
BatchAttachToIndexResponseTypeDef,
BatchCreateIndexResponseTypeDef,
BatchCreateObjectResponseTypeDef,
BatchDetachFromIndexResponseTypeDef,
BatchDetachObjectResponseTypeDef,
BatchListObjectChildrenResponseTypeDef,
PathToObjectIdentifiersTypeDef,
ObjectIdentifierAndLinkNameTupleTypeDef,
BatchListObjectPoliciesResponseTypeDef,
BatchListPolicyAttachmentsResponseTypeDef,
BatchReadExceptionTypeDef,
BatchUpdateObjectAttributesResponseTypeDef,
CreateDirectoryRequestRequestTypeDef,
CreateSchemaRequestRequestTypeDef,
DeleteDirectoryRequestRequestTypeDef,
DeleteFacetRequestRequestTypeDef,
DeleteSchemaRequestRequestTypeDef,
DeleteTypedLinkFacetRequestRequestTypeDef,
DirectoryTypeDef,
DisableDirectoryRequestRequestTypeDef,
EnableDirectoryRequestRequestTypeDef,
RuleTypeDef,
FacetAttributeReferenceTypeDef,
FacetTypeDef,
GetAppliedSchemaVersionRequestRequestTypeDef,
GetDirectoryRequestRequestTypeDef,
GetFacetRequestRequestTypeDef,
GetSchemaAsJsonRequestRequestTypeDef,
GetTypedLinkFacetInformationRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListAppliedSchemaArnsRequestRequestTypeDef,
ListDevelopmentSchemaArnsRequestRequestTypeDef,
ListDirectoriesRequestRequestTypeDef,
ListFacetAttributesRequestRequestTypeDef,
ListFacetNamesRequestRequestTypeDef,
ListManagedSchemaArnsRequestRequestTypeDef,
ListPublishedSchemaArnsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
TagTypeDef,
ListTypedLinkFacetAttributesRequestRequestTypeDef,
ListTypedLinkFacetNamesRequestRequestTypeDef,
PolicyAttachmentTypeDef,
PublishSchemaRequestRequestTypeDef,
PutSchemaFromJsonRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateSchemaRequestRequestTypeDef,
UpgradeAppliedSchemaRequestRequestTypeDef,
UpgradePublishedSchemaRequestRequestTypeDef,
AttachObjectRequestRequestTypeDef,
AttachPolicyRequestRequestTypeDef,
AttachToIndexRequestRequestTypeDef,
BatchAttachObjectTypeDef,
BatchAttachPolicyTypeDef,
BatchAttachToIndexTypeDef,
BatchDeleteObjectTypeDef,
BatchDetachFromIndexTypeDef,
BatchDetachObjectTypeDef,
BatchDetachPolicyTypeDef,
BatchGetObjectInformationTypeDef,
BatchListAttachedIndicesTypeDef,
BatchListObjectChildrenTypeDef,
BatchListObjectParentPathsTypeDef,
BatchListObjectParentsTypeDef,
BatchListObjectPoliciesTypeDef,
BatchListPolicyAttachmentsTypeDef,
BatchLookupPolicyTypeDef,
DeleteObjectRequestRequestTypeDef,
DetachFromIndexRequestRequestTypeDef,
DetachObjectRequestRequestTypeDef,
DetachPolicyRequestRequestTypeDef,
GetObjectInformationRequestRequestTypeDef,
ListAttachedIndicesRequestRequestTypeDef,
ListObjectChildrenRequestRequestTypeDef,
ListObjectParentPathsRequestRequestTypeDef,
ListObjectParentsRequestRequestTypeDef,
ListObjectPoliciesRequestRequestTypeDef,
ListPolicyAttachmentsRequestRequestTypeDef,
LookupPolicyRequestRequestTypeDef,
BatchGetObjectAttributesTypeDef,
BatchGetObjectInformationResponseTypeDef,
BatchListObjectAttributesTypeDef,
BatchRemoveFacetFromObjectTypeDef,
GetObjectAttributesRequestRequestTypeDef,
ListObjectAttributesRequestRequestTypeDef,
RemoveFacetFromObjectRequestRequestTypeDef,
ApplySchemaResponseTypeDef,
AttachObjectResponseTypeDef,
AttachToIndexResponseTypeDef,
CreateDirectoryResponseTypeDef,
CreateIndexResponseTypeDef,
CreateObjectResponseTypeDef,
CreateSchemaResponseTypeDef,
DeleteDirectoryResponseTypeDef,
DeleteSchemaResponseTypeDef,
DetachFromIndexResponseTypeDef,
DetachObjectResponseTypeDef,
DisableDirectoryResponseTypeDef,
EmptyResponseMetadataTypeDef,
EnableDirectoryResponseTypeDef,
GetAppliedSchemaVersionResponseTypeDef,
GetObjectInformationResponseTypeDef,
GetSchemaAsJsonResponseTypeDef,
GetTypedLinkFacetInformationResponseTypeDef,
ListAppliedSchemaArnsResponseTypeDef,
ListDevelopmentSchemaArnsResponseTypeDef,
ListFacetNamesResponseTypeDef,
ListManagedSchemaArnsResponseTypeDef,
ListObjectChildrenResponseTypeDef,
ListObjectPoliciesResponseTypeDef,
ListPolicyAttachmentsResponseTypeDef,
ListPublishedSchemaArnsResponseTypeDef,
ListTypedLinkFacetNamesResponseTypeDef,
PublishSchemaResponseTypeDef,
PutSchemaFromJsonResponseTypeDef,
UpdateObjectAttributesResponseTypeDef,
UpdateSchemaResponseTypeDef,
UpgradeAppliedSchemaResponseTypeDef,
UpgradePublishedSchemaResponseTypeDef,
BatchCreateIndexTypeDef,
CreateIndexRequestRequestTypeDef,
AttributeKeyAndValueTypeDef,
AttributeNameAndValueTypeDef,
LinkAttributeActionTypeDef,
ObjectAttributeActionTypeDef,
TypedAttributeValueRangeTypeDef,
BatchListObjectParentPathsResponseTypeDef,
ListObjectParentPathsResponseTypeDef,
BatchListObjectParentsResponseTypeDef,
ListObjectParentsResponseTypeDef,
GetDirectoryResponseTypeDef,
ListDirectoriesResponseTypeDef,
FacetAttributeDefinitionTypeDef,
TypedLinkAttributeDefinitionTypeDef,
GetFacetResponseTypeDef,
ListAppliedSchemaArnsRequestListAppliedSchemaArnsPaginateTypeDef,
ListAttachedIndicesRequestListAttachedIndicesPaginateTypeDef,
ListDevelopmentSchemaArnsRequestListDevelopmentSchemaArnsPaginateTypeDef,
ListDirectoriesRequestListDirectoriesPaginateTypeDef,
ListFacetAttributesRequestListFacetAttributesPaginateTypeDef,
ListFacetNamesRequestListFacetNamesPaginateTypeDef,
ListManagedSchemaArnsRequestListManagedSchemaArnsPaginateTypeDef,
ListObjectAttributesRequestListObjectAttributesPaginateTypeDef,
ListObjectParentPathsRequestListObjectParentPathsPaginateTypeDef,
ListObjectPoliciesRequestListObjectPoliciesPaginateTypeDef,
ListPolicyAttachmentsRequestListPolicyAttachmentsPaginateTypeDef,
ListPublishedSchemaArnsRequestListPublishedSchemaArnsPaginateTypeDef,
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef,
ListTypedLinkFacetAttributesRequestListTypedLinkFacetAttributesPaginateTypeDef,
ListTypedLinkFacetNamesRequestListTypedLinkFacetNamesPaginateTypeDef,
LookupPolicyRequestLookupPolicyPaginateTypeDef,
ListTagsForResourceResponseTypeDef,
TagResourceRequestRequestTypeDef,
PolicyToPathTypeDef,
AddFacetToObjectRequestRequestTypeDef,
BatchAddFacetToObjectTypeDef,
BatchCreateObjectTypeDef,
BatchGetLinkAttributesResponseTypeDef,
BatchGetObjectAttributesResponseTypeDef,
BatchListObjectAttributesResponseTypeDef,
CreateObjectRequestRequestTypeDef,
GetLinkAttributesResponseTypeDef,
GetObjectAttributesResponseTypeDef,
IndexAttachmentTypeDef,
ListObjectAttributesResponseTypeDef,
AttachTypedLinkRequestRequestTypeDef,
BatchAttachTypedLinkTypeDef,
TypedLinkSpecifierTypeDef,
LinkAttributeUpdateTypeDef,
ObjectAttributeUpdateTypeDef,
ObjectAttributeRangeTypeDef,
TypedLinkAttributeRangeTypeDef,
FacetAttributeTypeDef,
ListTypedLinkFacetAttributesResponseTypeDef,
TypedLinkFacetAttributeUpdateTypeDef,
TypedLinkFacetTypeDef,
BatchLookupPolicyResponseTypeDef,
LookupPolicyResponseTypeDef,
BatchListAttachedIndicesResponseTypeDef,
BatchListIndexResponseTypeDef,
ListAttachedIndicesResponseTypeDef,
ListIndexResponseTypeDef,
AttachTypedLinkResponseTypeDef,
BatchAttachTypedLinkResponseTypeDef,
BatchDetachTypedLinkTypeDef,
BatchGetLinkAttributesTypeDef,
BatchListIncomingTypedLinksResponseTypeDef,
BatchListOutgoingTypedLinksResponseTypeDef,
DetachTypedLinkRequestRequestTypeDef,
GetLinkAttributesRequestRequestTypeDef,
ListIncomingTypedLinksResponseTypeDef,
ListOutgoingTypedLinksResponseTypeDef,
BatchUpdateLinkAttributesTypeDef,
UpdateLinkAttributesRequestRequestTypeDef,
BatchUpdateObjectAttributesTypeDef,
UpdateObjectAttributesRequestRequestTypeDef,
BatchListIndexTypeDef,
ListIndexRequestListIndexPaginateTypeDef,
ListIndexRequestRequestTypeDef,
BatchListIncomingTypedLinksTypeDef,
BatchListOutgoingTypedLinksTypeDef,
ListIncomingTypedLinksRequestListIncomingTypedLinksPaginateTypeDef,
ListIncomingTypedLinksRequestRequestTypeDef,
ListOutgoingTypedLinksRequestListOutgoingTypedLinksPaginateTypeDef,
ListOutgoingTypedLinksRequestRequestTypeDef,
CreateFacetRequestRequestTypeDef,
FacetAttributeUpdateTypeDef,
ListFacetAttributesResponseTypeDef,
UpdateTypedLinkFacetRequestRequestTypeDef,
CreateTypedLinkFacetRequestRequestTypeDef,
BatchWriteOperationResponseTypeDef,
BatchReadSuccessfulResponseTypeDef,
BatchWriteOperationTypeDef,
BatchReadOperationTypeDef,
UpdateFacetRequestRequestTypeDef,
BatchWriteResponseTypeDef,
BatchReadOperationResponseTypeDef,
BatchWriteRequestRequestTypeDef,
BatchReadRequestRequestTypeDef,
BatchReadResponseTypeDef,
)
def get_structure() -> ObjectReferenceTypeDef:
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-clouddirectory` 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_clouddirectory/)
## 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-clouddirectory
Provides: python3-mypy-boto3-clouddirectory-doc
%description help
# mypy-boto3-clouddirectory
[![PyPI - mypy-boto3-clouddirectory](https://img.shields.io/pypi/v/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-clouddirectory.svg?color=blue)](https://pypi.org/project/mypy-boto3-clouddirectory)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-clouddirectory?color=blue)](https://pypistats.org/packages/mypy-boto3-clouddirectory)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.CloudDirectory 1.26.60](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/clouddirectory.html#CloudDirectory)
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.3](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-clouddirectory docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_clouddirectory/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-clouddirectory](#mypy-boto3-clouddirectory)
- [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)
- [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 `CloudDirectory`.
### From PyPI with pip
Install `boto3-stubs` for `CloudDirectory` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[clouddirectory]'
# 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[clouddirectory]'
# standalone installation
python -m pip install mypy-boto3-clouddirectory
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-clouddirectory
```
## 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[clouddirectory]'`
```
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[clouddirectory]'
```
- 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[clouddirectory]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
- 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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'`
```
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[clouddirectory]` in your environment:
```bash
python -m pip install 'boto3-stubs[clouddirectory]'
```
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
`CloudDirectoryClient` provides annotations for
`boto3.client("clouddirectory")`.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
client: CloudDirectoryClient = Session().client("clouddirectory")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_clouddirectory.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
from mypy_boto3_clouddirectory.paginator import (
ListAppliedSchemaArnsPaginator,
ListAttachedIndicesPaginator,
ListDevelopmentSchemaArnsPaginator,
ListDirectoriesPaginator,
ListFacetAttributesPaginator,
ListFacetNamesPaginator,
ListIncomingTypedLinksPaginator,
ListIndexPaginator,
ListManagedSchemaArnsPaginator,
ListObjectAttributesPaginator,
ListObjectParentPathsPaginator,
ListObjectPoliciesPaginator,
ListOutgoingTypedLinksPaginator,
ListPolicyAttachmentsPaginator,
ListPublishedSchemaArnsPaginator,
ListTagsForResourcePaginator,
ListTypedLinkFacetAttributesPaginator,
ListTypedLinkFacetNamesPaginator,
LookupPolicyPaginator,
)
client: CloudDirectoryClient = Session().client("clouddirectory")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_applied_schema_arns_paginator: ListAppliedSchemaArnsPaginator = client.get_paginator(
"list_applied_schema_arns"
)
list_attached_indices_paginator: ListAttachedIndicesPaginator = client.get_paginator(
"list_attached_indices"
)
list_development_schema_arns_paginator: ListDevelopmentSchemaArnsPaginator = client.get_paginator(
"list_development_schema_arns"
)
list_directories_paginator: ListDirectoriesPaginator = client.get_paginator("list_directories")
list_facet_attributes_paginator: ListFacetAttributesPaginator = client.get_paginator(
"list_facet_attributes"
)
list_facet_names_paginator: ListFacetNamesPaginator = client.get_paginator("list_facet_names")
list_incoming_typed_links_paginator: ListIncomingTypedLinksPaginator = client.get_paginator(
"list_incoming_typed_links"
)
list_index_paginator: ListIndexPaginator = client.get_paginator("list_index")
list_managed_schema_arns_paginator: ListManagedSchemaArnsPaginator = client.get_paginator(
"list_managed_schema_arns"
)
list_object_attributes_paginator: ListObjectAttributesPaginator = client.get_paginator(
"list_object_attributes"
)
list_object_parent_paths_paginator: ListObjectParentPathsPaginator = client.get_paginator(
"list_object_parent_paths"
)
list_object_policies_paginator: ListObjectPoliciesPaginator = client.get_paginator(
"list_object_policies"
)
list_outgoing_typed_links_paginator: ListOutgoingTypedLinksPaginator = client.get_paginator(
"list_outgoing_typed_links"
)
list_policy_attachments_paginator: ListPolicyAttachmentsPaginator = client.get_paginator(
"list_policy_attachments"
)
list_published_schema_arns_paginator: ListPublishedSchemaArnsPaginator = client.get_paginator(
"list_published_schema_arns"
)
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
list_typed_link_facet_attributes_paginator: ListTypedLinkFacetAttributesPaginator = (
client.get_paginator("list_typed_link_facet_attributes")
)
list_typed_link_facet_names_paginator: ListTypedLinkFacetNamesPaginator = client.get_paginator(
"list_typed_link_facet_names"
)
lookup_policy_paginator: LookupPolicyPaginator = client.get_paginator("lookup_policy")
```
### Literals
`mypy_boto3_clouddirectory.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_clouddirectory.literals import (
BatchReadExceptionTypeType,
ConsistencyLevelType,
DirectoryStateType,
FacetAttributeTypeType,
FacetStyleType,
ListAppliedSchemaArnsPaginatorName,
ListAttachedIndicesPaginatorName,
ListDevelopmentSchemaArnsPaginatorName,
ListDirectoriesPaginatorName,
ListFacetAttributesPaginatorName,
ListFacetNamesPaginatorName,
ListIncomingTypedLinksPaginatorName,
ListIndexPaginatorName,
ListManagedSchemaArnsPaginatorName,
ListObjectAttributesPaginatorName,
ListObjectParentPathsPaginatorName,
ListObjectPoliciesPaginatorName,
ListOutgoingTypedLinksPaginatorName,
ListPolicyAttachmentsPaginatorName,
ListPublishedSchemaArnsPaginatorName,
ListTagsForResourcePaginatorName,
ListTypedLinkFacetAttributesPaginatorName,
ListTypedLinkFacetNamesPaginatorName,
LookupPolicyPaginatorName,
ObjectTypeType,
RangeModeType,
RequiredAttributeBehaviorType,
RuleTypeType,
UpdateActionTypeType,
CloudDirectoryServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: BatchReadExceptionTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_clouddirectory.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_clouddirectory.type_defs import (
ObjectReferenceTypeDef,
SchemaFacetTypeDef,
ApplySchemaRequestRequestTypeDef,
ResponseMetadataTypeDef,
TypedLinkSchemaAndFacetNameTypeDef,
AttributeKeyTypeDef,
TypedAttributeValueTypeDef,
BatchAttachObjectResponseTypeDef,
BatchAttachToIndexResponseTypeDef,
BatchCreateIndexResponseTypeDef,
BatchCreateObjectResponseTypeDef,
BatchDetachFromIndexResponseTypeDef,
BatchDetachObjectResponseTypeDef,
BatchListObjectChildrenResponseTypeDef,
PathToObjectIdentifiersTypeDef,
ObjectIdentifierAndLinkNameTupleTypeDef,
BatchListObjectPoliciesResponseTypeDef,
BatchListPolicyAttachmentsResponseTypeDef,
BatchReadExceptionTypeDef,
BatchUpdateObjectAttributesResponseTypeDef,
CreateDirectoryRequestRequestTypeDef,
CreateSchemaRequestRequestTypeDef,
DeleteDirectoryRequestRequestTypeDef,
DeleteFacetRequestRequestTypeDef,
DeleteSchemaRequestRequestTypeDef,
DeleteTypedLinkFacetRequestRequestTypeDef,
DirectoryTypeDef,
DisableDirectoryRequestRequestTypeDef,
EnableDirectoryRequestRequestTypeDef,
RuleTypeDef,
FacetAttributeReferenceTypeDef,
FacetTypeDef,
GetAppliedSchemaVersionRequestRequestTypeDef,
GetDirectoryRequestRequestTypeDef,
GetFacetRequestRequestTypeDef,
GetSchemaAsJsonRequestRequestTypeDef,
GetTypedLinkFacetInformationRequestRequestTypeDef,
PaginatorConfigTypeDef,
ListAppliedSchemaArnsRequestRequestTypeDef,
ListDevelopmentSchemaArnsRequestRequestTypeDef,
ListDirectoriesRequestRequestTypeDef,
ListFacetAttributesRequestRequestTypeDef,
ListFacetNamesRequestRequestTypeDef,
ListManagedSchemaArnsRequestRequestTypeDef,
ListPublishedSchemaArnsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
TagTypeDef,
ListTypedLinkFacetAttributesRequestRequestTypeDef,
ListTypedLinkFacetNamesRequestRequestTypeDef,
PolicyAttachmentTypeDef,
PublishSchemaRequestRequestTypeDef,
PutSchemaFromJsonRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateSchemaRequestRequestTypeDef,
UpgradeAppliedSchemaRequestRequestTypeDef,
UpgradePublishedSchemaRequestRequestTypeDef,
AttachObjectRequestRequestTypeDef,
AttachPolicyRequestRequestTypeDef,
AttachToIndexRequestRequestTypeDef,
BatchAttachObjectTypeDef,
BatchAttachPolicyTypeDef,
BatchAttachToIndexTypeDef,
BatchDeleteObjectTypeDef,
BatchDetachFromIndexTypeDef,
BatchDetachObjectTypeDef,
BatchDetachPolicyTypeDef,
BatchGetObjectInformationTypeDef,
BatchListAttachedIndicesTypeDef,
BatchListObjectChildrenTypeDef,
BatchListObjectParentPathsTypeDef,
BatchListObjectParentsTypeDef,
BatchListObjectPoliciesTypeDef,
BatchListPolicyAttachmentsTypeDef,
BatchLookupPolicyTypeDef,
DeleteObjectRequestRequestTypeDef,
DetachFromIndexRequestRequestTypeDef,
DetachObjectRequestRequestTypeDef,
DetachPolicyRequestRequestTypeDef,
GetObjectInformationRequestRequestTypeDef,
ListAttachedIndicesRequestRequestTypeDef,
ListObjectChildrenRequestRequestTypeDef,
ListObjectParentPathsRequestRequestTypeDef,
ListObjectParentsRequestRequestTypeDef,
ListObjectPoliciesRequestRequestTypeDef,
ListPolicyAttachmentsRequestRequestTypeDef,
LookupPolicyRequestRequestTypeDef,
BatchGetObjectAttributesTypeDef,
BatchGetObjectInformationResponseTypeDef,
BatchListObjectAttributesTypeDef,
BatchRemoveFacetFromObjectTypeDef,
GetObjectAttributesRequestRequestTypeDef,
ListObjectAttributesRequestRequestTypeDef,
RemoveFacetFromObjectRequestRequestTypeDef,
ApplySchemaResponseTypeDef,
AttachObjectResponseTypeDef,
AttachToIndexResponseTypeDef,
CreateDirectoryResponseTypeDef,
CreateIndexResponseTypeDef,
CreateObjectResponseTypeDef,
CreateSchemaResponseTypeDef,
DeleteDirectoryResponseTypeDef,
DeleteSchemaResponseTypeDef,
DetachFromIndexResponseTypeDef,
DetachObjectResponseTypeDef,
DisableDirectoryResponseTypeDef,
EmptyResponseMetadataTypeDef,
EnableDirectoryResponseTypeDef,
GetAppliedSchemaVersionResponseTypeDef,
GetObjectInformationResponseTypeDef,
GetSchemaAsJsonResponseTypeDef,
GetTypedLinkFacetInformationResponseTypeDef,
ListAppliedSchemaArnsResponseTypeDef,
ListDevelopmentSchemaArnsResponseTypeDef,
ListFacetNamesResponseTypeDef,
ListManagedSchemaArnsResponseTypeDef,
ListObjectChildrenResponseTypeDef,
ListObjectPoliciesResponseTypeDef,
ListPolicyAttachmentsResponseTypeDef,
ListPublishedSchemaArnsResponseTypeDef,
ListTypedLinkFacetNamesResponseTypeDef,
PublishSchemaResponseTypeDef,
PutSchemaFromJsonResponseTypeDef,
UpdateObjectAttributesResponseTypeDef,
UpdateSchemaResponseTypeDef,
UpgradeAppliedSchemaResponseTypeDef,
UpgradePublishedSchemaResponseTypeDef,
BatchCreateIndexTypeDef,
CreateIndexRequestRequestTypeDef,
AttributeKeyAndValueTypeDef,
AttributeNameAndValueTypeDef,
LinkAttributeActionTypeDef,
ObjectAttributeActionTypeDef,
TypedAttributeValueRangeTypeDef,
BatchListObjectParentPathsResponseTypeDef,
ListObjectParentPathsResponseTypeDef,
BatchListObjectParentsResponseTypeDef,
ListObjectParentsResponseTypeDef,
GetDirectoryResponseTypeDef,
ListDirectoriesResponseTypeDef,
FacetAttributeDefinitionTypeDef,
TypedLinkAttributeDefinitionTypeDef,
GetFacetResponseTypeDef,
ListAppliedSchemaArnsRequestListAppliedSchemaArnsPaginateTypeDef,
ListAttachedIndicesRequestListAttachedIndicesPaginateTypeDef,
ListDevelopmentSchemaArnsRequestListDevelopmentSchemaArnsPaginateTypeDef,
ListDirectoriesRequestListDirectoriesPaginateTypeDef,
ListFacetAttributesRequestListFacetAttributesPaginateTypeDef,
ListFacetNamesRequestListFacetNamesPaginateTypeDef,
ListManagedSchemaArnsRequestListManagedSchemaArnsPaginateTypeDef,
ListObjectAttributesRequestListObjectAttributesPaginateTypeDef,
ListObjectParentPathsRequestListObjectParentPathsPaginateTypeDef,
ListObjectPoliciesRequestListObjectPoliciesPaginateTypeDef,
ListPolicyAttachmentsRequestListPolicyAttachmentsPaginateTypeDef,
ListPublishedSchemaArnsRequestListPublishedSchemaArnsPaginateTypeDef,
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef,
ListTypedLinkFacetAttributesRequestListTypedLinkFacetAttributesPaginateTypeDef,
ListTypedLinkFacetNamesRequestListTypedLinkFacetNamesPaginateTypeDef,
LookupPolicyRequestLookupPolicyPaginateTypeDef,
ListTagsForResourceResponseTypeDef,
TagResourceRequestRequestTypeDef,
PolicyToPathTypeDef,
AddFacetToObjectRequestRequestTypeDef,
BatchAddFacetToObjectTypeDef,
BatchCreateObjectTypeDef,
BatchGetLinkAttributesResponseTypeDef,
BatchGetObjectAttributesResponseTypeDef,
BatchListObjectAttributesResponseTypeDef,
CreateObjectRequestRequestTypeDef,
GetLinkAttributesResponseTypeDef,
GetObjectAttributesResponseTypeDef,
IndexAttachmentTypeDef,
ListObjectAttributesResponseTypeDef,
AttachTypedLinkRequestRequestTypeDef,
BatchAttachTypedLinkTypeDef,
TypedLinkSpecifierTypeDef,
LinkAttributeUpdateTypeDef,
ObjectAttributeUpdateTypeDef,
ObjectAttributeRangeTypeDef,
TypedLinkAttributeRangeTypeDef,
FacetAttributeTypeDef,
ListTypedLinkFacetAttributesResponseTypeDef,
TypedLinkFacetAttributeUpdateTypeDef,
TypedLinkFacetTypeDef,
BatchLookupPolicyResponseTypeDef,
LookupPolicyResponseTypeDef,
BatchListAttachedIndicesResponseTypeDef,
BatchListIndexResponseTypeDef,
ListAttachedIndicesResponseTypeDef,
ListIndexResponseTypeDef,
AttachTypedLinkResponseTypeDef,
BatchAttachTypedLinkResponseTypeDef,
BatchDetachTypedLinkTypeDef,
BatchGetLinkAttributesTypeDef,
BatchListIncomingTypedLinksResponseTypeDef,
BatchListOutgoingTypedLinksResponseTypeDef,
DetachTypedLinkRequestRequestTypeDef,
GetLinkAttributesRequestRequestTypeDef,
ListIncomingTypedLinksResponseTypeDef,
ListOutgoingTypedLinksResponseTypeDef,
BatchUpdateLinkAttributesTypeDef,
UpdateLinkAttributesRequestRequestTypeDef,
BatchUpdateObjectAttributesTypeDef,
UpdateObjectAttributesRequestRequestTypeDef,
BatchListIndexTypeDef,
ListIndexRequestListIndexPaginateTypeDef,
ListIndexRequestRequestTypeDef,
BatchListIncomingTypedLinksTypeDef,
BatchListOutgoingTypedLinksTypeDef,
ListIncomingTypedLinksRequestListIncomingTypedLinksPaginateTypeDef,
ListIncomingTypedLinksRequestRequestTypeDef,
ListOutgoingTypedLinksRequestListOutgoingTypedLinksPaginateTypeDef,
ListOutgoingTypedLinksRequestRequestTypeDef,
CreateFacetRequestRequestTypeDef,
FacetAttributeUpdateTypeDef,
ListFacetAttributesResponseTypeDef,
UpdateTypedLinkFacetRequestRequestTypeDef,
CreateTypedLinkFacetRequestRequestTypeDef,
BatchWriteOperationResponseTypeDef,
BatchReadSuccessfulResponseTypeDef,
BatchWriteOperationTypeDef,
BatchReadOperationTypeDef,
UpdateFacetRequestRequestTypeDef,
BatchWriteResponseTypeDef,
BatchReadOperationResponseTypeDef,
BatchWriteRequestRequestTypeDef,
BatchReadRequestRequestTypeDef,
BatchReadResponseTypeDef,
)
def get_structure() -> ObjectReferenceTypeDef:
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-clouddirectory` 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_clouddirectory/)
## 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-clouddirectory-1.26.60
%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-clouddirectory -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.60-1
- Package Spec generated