CloudDirectory module#
Index > CloudDirectory
Auto-generated documentation for CloudDirectory type annotations stubs module mypy-boto3-clouddirectory.
How to install#
VSCode extension#
Add AWS Boto3
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.
# 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#
python -m pip uninstall -y mypy-boto3-clouddirectory
Usage#
Code samples can be found in Examples.
CloudDirectoryClient#
Type annotations and code completion for boto3.client("clouddirectory")
as CloudDirectoryClient
boto3 documentation
# CloudDirectoryClient usage example
from boto3.session import Session
from mypy_boto3_clouddirectory.client import CloudDirectoryClient
def get_client() -> CloudDirectoryClient:
return Session().client("clouddirectory")
Paginators#
Type annotations and code completion for paginators
from boto3.client("clouddirectory").get_paginator("...")
.
# ListAppliedSchemaArnsPaginator usage example
from boto3.session import Session
from mypy_boto3_clouddirectory.paginator import ListAppliedSchemaArnsPaginator
def get_list_applied_schema_arns_paginator() -> ListAppliedSchemaArnsPaginator:
return Session().client("clouddirectory").get_paginator("list_applied_schema_arns"))
- ListAppliedSchemaArnsPaginator
- ListAttachedIndicesPaginator
- ListDevelopmentSchemaArnsPaginator
- ListDirectoriesPaginator
- ListFacetAttributesPaginator
- ListFacetNamesPaginator
- ListIncomingTypedLinksPaginator
- ListIndexPaginator
- ListManagedSchemaArnsPaginator
- ListObjectAttributesPaginator
- ListObjectParentPathsPaginator
- ListObjectPoliciesPaginator
- ListOutgoingTypedLinksPaginator
- ListPolicyAttachmentsPaginator
- ListPublishedSchemaArnsPaginator
- ListTagsForResourcePaginator
- ListTypedLinkFacetAttributesPaginator
- ListTypedLinkFacetNamesPaginator
- LookupPolicyPaginator
Literals#
Type annotations for literals used in methods and schemas.
# BatchReadExceptionTypeType usage example
from mypy_boto3_clouddirectory.literals import BatchReadExceptionTypeType
def get_value() -> BatchReadExceptionTypeType:
return "AccessDeniedException"
- 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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# ObjectReferenceTypeDef usage example
from mypy_boto3_clouddirectory.type_defs import ObjectReferenceTypeDef
def get_value() -> ObjectReferenceTypeDef:
return {
"Selector": ...,
}
- ObjectReferenceTypeDef
- SchemaFacetTypeDef
- ApplySchemaRequestRequestTypeDef
- ApplySchemaResponseTypeDef
- AttachObjectResponseTypeDef
- AttachToIndexResponseTypeDef
- TypedLinkSchemaAndFacetNameTypeDef
- AttributeKeyTypeDef
- TypedAttributeValueTypeDef
- BatchAttachObjectResponseTypeDef
- BatchAttachToIndexResponseTypeDef
- BatchCreateIndexResponseTypeDef
- BatchCreateObjectResponseTypeDef
- BatchDetachFromIndexResponseTypeDef
- BatchDetachObjectResponseTypeDef
- BatchListObjectChildrenResponseTypeDef
- PathToObjectIdentifiersTypeDef
- ObjectIdentifierAndLinkNameTupleTypeDef
- BatchListObjectPoliciesResponseTypeDef
- BatchListPolicyAttachmentsResponseTypeDef
- BatchReadExceptionTypeDef
- BatchUpdateObjectAttributesResponseTypeDef
- CreateDirectoryRequestRequestTypeDef
- CreateDirectoryResponseTypeDef
- CreateIndexResponseTypeDef
- CreateObjectResponseTypeDef
- CreateSchemaRequestRequestTypeDef
- CreateSchemaResponseTypeDef
- DeleteDirectoryRequestRequestTypeDef
- DeleteDirectoryResponseTypeDef
- DeleteFacetRequestRequestTypeDef
- DeleteSchemaRequestRequestTypeDef
- DeleteSchemaResponseTypeDef
- DeleteTypedLinkFacetRequestRequestTypeDef
- DetachFromIndexResponseTypeDef
- DetachObjectResponseTypeDef
- DirectoryTypeDef
- DisableDirectoryRequestRequestTypeDef
- DisableDirectoryResponseTypeDef
- EmptyResponseMetadataTypeDef
- EnableDirectoryRequestRequestTypeDef
- EnableDirectoryResponseTypeDef
- RuleTypeDef
- FacetAttributeReferenceTypeDef
- FacetTypeDef
- GetAppliedSchemaVersionRequestRequestTypeDef
- GetAppliedSchemaVersionResponseTypeDef
- GetDirectoryRequestRequestTypeDef
- GetFacetRequestRequestTypeDef
- GetSchemaAsJsonRequestRequestTypeDef
- GetSchemaAsJsonResponseTypeDef
- GetTypedLinkFacetInformationRequestRequestTypeDef
- GetTypedLinkFacetInformationResponseTypeDef
- ListAppliedSchemaArnsRequestListAppliedSchemaArnsPaginateTypeDef
- ListAppliedSchemaArnsRequestRequestTypeDef
- ListAppliedSchemaArnsResponseTypeDef
- ListDevelopmentSchemaArnsRequestListDevelopmentSchemaArnsPaginateTypeDef
- ListDevelopmentSchemaArnsRequestRequestTypeDef
- ListDevelopmentSchemaArnsResponseTypeDef
- ListDirectoriesRequestListDirectoriesPaginateTypeDef
- ListDirectoriesRequestRequestTypeDef
- ListFacetAttributesRequestListFacetAttributesPaginateTypeDef
- ListFacetAttributesRequestRequestTypeDef
- ListFacetNamesRequestListFacetNamesPaginateTypeDef
- ListFacetNamesRequestRequestTypeDef
- ListFacetNamesResponseTypeDef
- ListManagedSchemaArnsRequestListManagedSchemaArnsPaginateTypeDef
- ListManagedSchemaArnsRequestRequestTypeDef
- ListManagedSchemaArnsResponseTypeDef
- ListObjectChildrenResponseTypeDef
- ListObjectPoliciesResponseTypeDef
- ListPolicyAttachmentsResponseTypeDef
- ListPublishedSchemaArnsRequestListPublishedSchemaArnsPaginateTypeDef
- ListPublishedSchemaArnsRequestRequestTypeDef
- ListPublishedSchemaArnsResponseTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagTypeDef
- ListTypedLinkFacetAttributesRequestListTypedLinkFacetAttributesPaginateTypeDef
- ListTypedLinkFacetAttributesRequestRequestTypeDef
- ListTypedLinkFacetNamesRequestListTypedLinkFacetNamesPaginateTypeDef
- ListTypedLinkFacetNamesRequestRequestTypeDef
- ListTypedLinkFacetNamesResponseTypeDef
- PaginatorConfigTypeDef
- PolicyAttachmentTypeDef
- PublishSchemaRequestRequestTypeDef
- PublishSchemaResponseTypeDef
- PutSchemaFromJsonRequestRequestTypeDef
- PutSchemaFromJsonResponseTypeDef
- ResponseMetadataTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateObjectAttributesResponseTypeDef
- UpdateSchemaRequestRequestTypeDef
- UpdateSchemaResponseTypeDef
- UpgradeAppliedSchemaRequestRequestTypeDef
- UpgradeAppliedSchemaResponseTypeDef
- UpgradePublishedSchemaRequestRequestTypeDef
- UpgradePublishedSchemaResponseTypeDef
- AttachObjectRequestRequestTypeDef
- AttachPolicyRequestRequestTypeDef
- AttachToIndexRequestRequestTypeDef
- BatchAttachObjectTypeDef
- BatchAttachPolicyTypeDef
- BatchAttachToIndexTypeDef
- BatchDeleteObjectTypeDef
- BatchDetachFromIndexTypeDef
- BatchDetachObjectTypeDef
- BatchDetachPolicyTypeDef
- BatchGetObjectInformationTypeDef
- BatchListAttachedIndicesTypeDef
- BatchListObjectChildrenTypeDef
- BatchListObjectParentPathsTypeDef
- BatchListObjectParentsTypeDef
- BatchListObjectPoliciesTypeDef
- BatchListPolicyAttachmentsTypeDef
- BatchLookupPolicyTypeDef
- DeleteObjectRequestRequestTypeDef
- DetachFromIndexRequestRequestTypeDef
- DetachObjectRequestRequestTypeDef
- DetachPolicyRequestRequestTypeDef
- GetObjectInformationRequestRequestTypeDef
- ListAttachedIndicesRequestListAttachedIndicesPaginateTypeDef
- ListAttachedIndicesRequestRequestTypeDef
- ListObjectChildrenRequestRequestTypeDef
- ListObjectParentPathsRequestListObjectParentPathsPaginateTypeDef
- ListObjectParentPathsRequestRequestTypeDef
- ListObjectParentsRequestRequestTypeDef
- ListObjectPoliciesRequestListObjectPoliciesPaginateTypeDef
- ListObjectPoliciesRequestRequestTypeDef
- ListPolicyAttachmentsRequestListPolicyAttachmentsPaginateTypeDef
- ListPolicyAttachmentsRequestRequestTypeDef
- LookupPolicyRequestLookupPolicyPaginateTypeDef
- LookupPolicyRequestRequestTypeDef
- BatchGetObjectAttributesTypeDef
- BatchGetObjectInformationResponseTypeDef
- BatchListObjectAttributesTypeDef
- BatchRemoveFacetFromObjectTypeDef
- GetObjectAttributesRequestRequestTypeDef
- GetObjectInformationResponseTypeDef
- ListObjectAttributesRequestListObjectAttributesPaginateTypeDef
- ListObjectAttributesRequestRequestTypeDef
- RemoveFacetFromObjectRequestRequestTypeDef
- BatchCreateIndexTypeDef
- CreateIndexRequestRequestTypeDef
- AttributeKeyAndValueTypeDef
- AttributeNameAndValueTypeDef
- LinkAttributeActionTypeDef
- ObjectAttributeActionTypeDef
- TypedAttributeValueRangeTypeDef
- BatchListObjectParentPathsResponseTypeDef
- ListObjectParentPathsResponseTypeDef
- BatchListObjectParentsResponseTypeDef
- ListObjectParentsResponseTypeDef
- GetDirectoryResponseTypeDef
- ListDirectoriesResponseTypeDef
- FacetAttributeDefinitionTypeDef
- TypedLinkAttributeDefinitionTypeDef
- GetFacetResponseTypeDef
- 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