Typed dictionaries
Index > CloudDirectory > Typed dictionaries
Auto-generated documentation for CloudDirectory type annotations stubs module mypy-boto3-clouddirectory.
ObjectReferenceTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ObjectReferenceTypeDef
def get_value() -> ObjectReferenceTypeDef:
return {
"Selector": ...,
}
SchemaFacetTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import SchemaFacetTypeDef
def get_value() -> SchemaFacetTypeDef:
return {
"SchemaArn": ...,
}
Definition
class SchemaFacetTypeDef(TypedDict):
SchemaArn: NotRequired[str],
FacetName: NotRequired[str],
ApplySchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ApplySchemaRequestRequestTypeDef
def get_value() -> ApplySchemaRequestRequestTypeDef:
return {
"PublishedSchemaArn": ...,
"DirectoryArn": ...,
}
Definition
class ApplySchemaRequestRequestTypeDef(TypedDict):
PublishedSchemaArn: str,
DirectoryArn: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TypedLinkSchemaAndFacetNameTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import TypedLinkSchemaAndFacetNameTypeDef
def get_value() -> TypedLinkSchemaAndFacetNameTypeDef:
return {
"SchemaArn": ...,
"TypedLinkName": ...,
}
AttributeKeyTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttributeKeyTypeDef
def get_value() -> AttributeKeyTypeDef:
return {
"SchemaArn": ...,
"FacetName": ...,
"Name": ...,
}
TypedAttributeValueTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import TypedAttributeValueTypeDef
def get_value() -> TypedAttributeValueTypeDef:
return {
"StringValue": ...,
}
Definition
class TypedAttributeValueTypeDef(TypedDict):
StringValue: NotRequired[str],
BinaryValue: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
BooleanValue: NotRequired[bool],
NumberValue: NotRequired[str],
DatetimeValue: NotRequired[Union[datetime, str]],
BatchAttachObjectResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchAttachObjectResponseTypeDef
def get_value() -> BatchAttachObjectResponseTypeDef:
return {
"attachedObjectIdentifier": ...,
}
Definition
class BatchAttachObjectResponseTypeDef(TypedDict):
attachedObjectIdentifier: NotRequired[str],
BatchAttachToIndexResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchAttachToIndexResponseTypeDef
def get_value() -> BatchAttachToIndexResponseTypeDef:
return {
"AttachedObjectIdentifier": ...,
}
Definition
class BatchAttachToIndexResponseTypeDef(TypedDict):
AttachedObjectIdentifier: NotRequired[str],
BatchCreateIndexResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchCreateIndexResponseTypeDef
def get_value() -> BatchCreateIndexResponseTypeDef:
return {
"ObjectIdentifier": ...,
}
BatchCreateObjectResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchCreateObjectResponseTypeDef
def get_value() -> BatchCreateObjectResponseTypeDef:
return {
"ObjectIdentifier": ...,
}
BatchDetachFromIndexResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDetachFromIndexResponseTypeDef
def get_value() -> BatchDetachFromIndexResponseTypeDef:
return {
"DetachedObjectIdentifier": ...,
}
Definition
class BatchDetachFromIndexResponseTypeDef(TypedDict):
DetachedObjectIdentifier: NotRequired[str],
BatchDetachObjectResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDetachObjectResponseTypeDef
def get_value() -> BatchDetachObjectResponseTypeDef:
return {
"detachedObjectIdentifier": ...,
}
Definition
class BatchDetachObjectResponseTypeDef(TypedDict):
detachedObjectIdentifier: NotRequired[str],
BatchListObjectChildrenResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectChildrenResponseTypeDef
def get_value() -> BatchListObjectChildrenResponseTypeDef:
return {
"Children": ...,
}
Definition
class BatchListObjectChildrenResponseTypeDef(TypedDict):
Children: NotRequired[Dict[str, str]],
NextToken: NotRequired[str],
PathToObjectIdentifiersTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import PathToObjectIdentifiersTypeDef
def get_value() -> PathToObjectIdentifiersTypeDef:
return {
"Path": ...,
}
Definition
class PathToObjectIdentifiersTypeDef(TypedDict):
Path: NotRequired[str],
ObjectIdentifiers: NotRequired[List[str]],
ObjectIdentifierAndLinkNameTupleTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ObjectIdentifierAndLinkNameTupleTypeDef
def get_value() -> ObjectIdentifierAndLinkNameTupleTypeDef:
return {
"ObjectIdentifier": ...,
}
Definition
class ObjectIdentifierAndLinkNameTupleTypeDef(TypedDict):
ObjectIdentifier: NotRequired[str],
LinkName: NotRequired[str],
BatchListObjectPoliciesResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectPoliciesResponseTypeDef
def get_value() -> BatchListObjectPoliciesResponseTypeDef:
return {
"AttachedPolicyIds": ...,
}
Definition
class BatchListObjectPoliciesResponseTypeDef(TypedDict):
AttachedPolicyIds: NotRequired[List[str]],
NextToken: NotRequired[str],
BatchListPolicyAttachmentsResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListPolicyAttachmentsResponseTypeDef
def get_value() -> BatchListPolicyAttachmentsResponseTypeDef:
return {
"ObjectIdentifiers": ...,
}
Definition
class BatchListPolicyAttachmentsResponseTypeDef(TypedDict):
ObjectIdentifiers: NotRequired[List[str]],
NextToken: NotRequired[str],
BatchReadExceptionTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchReadExceptionTypeDef
def get_value() -> BatchReadExceptionTypeDef:
return {
"Type": ...,
}
Definition
class BatchReadExceptionTypeDef(TypedDict):
Type: NotRequired[BatchReadExceptionTypeType], # (1)
Message: NotRequired[str],
BatchUpdateObjectAttributesResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchUpdateObjectAttributesResponseTypeDef
def get_value() -> BatchUpdateObjectAttributesResponseTypeDef:
return {
"ObjectIdentifier": ...,
}
Definition
class BatchUpdateObjectAttributesResponseTypeDef(TypedDict):
ObjectIdentifier: NotRequired[str],
CreateDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import CreateDirectoryRequestRequestTypeDef
def get_value() -> CreateDirectoryRequestRequestTypeDef:
return {
"Name": ...,
"SchemaArn": ...,
}
CreateSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import CreateSchemaRequestRequestTypeDef
def get_value() -> CreateSchemaRequestRequestTypeDef:
return {
"Name": ...,
}
DeleteDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DeleteDirectoryRequestRequestTypeDef
def get_value() -> DeleteDirectoryRequestRequestTypeDef:
return {
"DirectoryArn": ...,
}
DeleteFacetRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DeleteFacetRequestRequestTypeDef
def get_value() -> DeleteFacetRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
DeleteSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DeleteSchemaRequestRequestTypeDef
def get_value() -> DeleteSchemaRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
DeleteTypedLinkFacetRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DeleteTypedLinkFacetRequestRequestTypeDef
def get_value() -> DeleteTypedLinkFacetRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
DirectoryTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DirectoryTypeDef
def get_value() -> DirectoryTypeDef:
return {
"Name": ...,
}
Definition
class DirectoryTypeDef(TypedDict):
Name: NotRequired[str],
DirectoryArn: NotRequired[str],
State: NotRequired[DirectoryStateType], # (1)
CreationDateTime: NotRequired[datetime],
DisableDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DisableDirectoryRequestRequestTypeDef
def get_value() -> DisableDirectoryRequestRequestTypeDef:
return {
"DirectoryArn": ...,
}
EnableDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import EnableDirectoryRequestRequestTypeDef
def get_value() -> EnableDirectoryRequestRequestTypeDef:
return {
"DirectoryArn": ...,
}
RuleTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"Type": ...,
}
Definition
class RuleTypeDef(TypedDict):
Type: NotRequired[RuleTypeType], # (1)
Parameters: NotRequired[Mapping[str, str]],
- See RuleTypeType
FacetAttributeReferenceTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import FacetAttributeReferenceTypeDef
def get_value() -> FacetAttributeReferenceTypeDef:
return {
"TargetFacetName": ...,
"TargetAttributeName": ...,
}
Definition
class FacetAttributeReferenceTypeDef(TypedDict):
TargetFacetName: str,
TargetAttributeName: str,
FacetTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import FacetTypeDef
def get_value() -> FacetTypeDef:
return {
"Name": ...,
}
Definition
class FacetTypeDef(TypedDict):
Name: NotRequired[str],
ObjectType: NotRequired[ObjectTypeType], # (1)
FacetStyle: NotRequired[FacetStyleType], # (2)
- See ObjectTypeType
- See FacetStyleType
GetAppliedSchemaVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetAppliedSchemaVersionRequestRequestTypeDef
def get_value() -> GetAppliedSchemaVersionRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
GetDirectoryRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetDirectoryRequestRequestTypeDef
def get_value() -> GetDirectoryRequestRequestTypeDef:
return {
"DirectoryArn": ...,
}
GetFacetRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetFacetRequestRequestTypeDef
def get_value() -> GetFacetRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
GetSchemaAsJsonRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetSchemaAsJsonRequestRequestTypeDef
def get_value() -> GetSchemaAsJsonRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
GetTypedLinkFacetInformationRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetTypedLinkFacetInformationRequestRequestTypeDef
def get_value() -> GetTypedLinkFacetInformationRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
Definition
class GetTypedLinkFacetInformationRequestRequestTypeDef(TypedDict):
SchemaArn: str,
Name: str,
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAppliedSchemaArnsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListAppliedSchemaArnsRequestRequestTypeDef
def get_value() -> ListAppliedSchemaArnsRequestRequestTypeDef:
return {
"DirectoryArn": ...,
}
Definition
class ListAppliedSchemaArnsRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
SchemaArn: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDevelopmentSchemaArnsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListDevelopmentSchemaArnsRequestRequestTypeDef
def get_value() -> ListDevelopmentSchemaArnsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDevelopmentSchemaArnsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDirectoriesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListDirectoriesRequestRequestTypeDef
def get_value() -> ListDirectoriesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDirectoriesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
state: NotRequired[DirectoryStateType], # (1)
ListFacetAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListFacetAttributesRequestRequestTypeDef
def get_value() -> ListFacetAttributesRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
Definition
class ListFacetAttributesRequestRequestTypeDef(TypedDict):
SchemaArn: str,
Name: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListFacetNamesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListFacetNamesRequestRequestTypeDef
def get_value() -> ListFacetNamesRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
Definition
class ListFacetNamesRequestRequestTypeDef(TypedDict):
SchemaArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListManagedSchemaArnsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListManagedSchemaArnsRequestRequestTypeDef
def get_value() -> ListManagedSchemaArnsRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
Definition
class ListManagedSchemaArnsRequestRequestTypeDef(TypedDict):
SchemaArn: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListPublishedSchemaArnsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListPublishedSchemaArnsRequestRequestTypeDef
def get_value() -> ListPublishedSchemaArnsRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
Definition
class ListPublishedSchemaArnsRequestRequestTypeDef(TypedDict):
SchemaArn: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
TagTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
ListTypedLinkFacetAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListTypedLinkFacetAttributesRequestRequestTypeDef
def get_value() -> ListTypedLinkFacetAttributesRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
Definition
class ListTypedLinkFacetAttributesRequestRequestTypeDef(TypedDict):
SchemaArn: str,
Name: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTypedLinkFacetNamesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListTypedLinkFacetNamesRequestRequestTypeDef
def get_value() -> ListTypedLinkFacetNamesRequestRequestTypeDef:
return {
"SchemaArn": ...,
}
Definition
class ListTypedLinkFacetNamesRequestRequestTypeDef(TypedDict):
SchemaArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PolicyAttachmentTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import PolicyAttachmentTypeDef
def get_value() -> PolicyAttachmentTypeDef:
return {
"PolicyId": ...,
}
Definition
class PolicyAttachmentTypeDef(TypedDict):
PolicyId: NotRequired[str],
ObjectIdentifier: NotRequired[str],
PolicyType: NotRequired[str],
PublishSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import PublishSchemaRequestRequestTypeDef
def get_value() -> PublishSchemaRequestRequestTypeDef:
return {
"DevelopmentSchemaArn": ...,
"Version": ...,
}
Definition
class PublishSchemaRequestRequestTypeDef(TypedDict):
DevelopmentSchemaArn: str,
Version: str,
MinorVersion: NotRequired[str],
Name: NotRequired[str],
PutSchemaFromJsonRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import PutSchemaFromJsonRequestRequestTypeDef
def get_value() -> PutSchemaFromJsonRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Document": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import UpdateSchemaRequestRequestTypeDef
def get_value() -> UpdateSchemaRequestRequestTypeDef:
return {
"SchemaArn": ...,
"Name": ...,
}
UpgradeAppliedSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import UpgradeAppliedSchemaRequestRequestTypeDef
def get_value() -> UpgradeAppliedSchemaRequestRequestTypeDef:
return {
"PublishedSchemaArn": ...,
"DirectoryArn": ...,
}
Definition
class UpgradeAppliedSchemaRequestRequestTypeDef(TypedDict):
PublishedSchemaArn: str,
DirectoryArn: str,
DryRun: NotRequired[bool],
UpgradePublishedSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import UpgradePublishedSchemaRequestRequestTypeDef
def get_value() -> UpgradePublishedSchemaRequestRequestTypeDef:
return {
"DevelopmentSchemaArn": ...,
"PublishedSchemaArn": ...,
"MinorVersion": ...,
}
Definition
class UpgradePublishedSchemaRequestRequestTypeDef(TypedDict):
DevelopmentSchemaArn: str,
PublishedSchemaArn: str,
MinorVersion: str,
DryRun: NotRequired[bool],
AttachObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttachObjectRequestRequestTypeDef
def get_value() -> AttachObjectRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ParentReference": ...,
"ChildReference": ...,
"LinkName": ...,
}
Definition
class AttachObjectRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ParentReference: ObjectReferenceTypeDef, # (1)
ChildReference: ObjectReferenceTypeDef, # (1)
LinkName: str,
AttachPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttachPolicyRequestRequestTypeDef
def get_value() -> AttachPolicyRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"PolicyReference": ...,
"ObjectReference": ...,
}
Definition
class AttachPolicyRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
PolicyReference: ObjectReferenceTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (1)
AttachToIndexRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttachToIndexRequestRequestTypeDef
def get_value() -> AttachToIndexRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"IndexReference": ...,
"TargetReference": ...,
}
Definition
class AttachToIndexRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
IndexReference: ObjectReferenceTypeDef, # (1)
TargetReference: ObjectReferenceTypeDef, # (1)
BatchAttachObjectTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchAttachObjectTypeDef
def get_value() -> BatchAttachObjectTypeDef:
return {
"ParentReference": ...,
"ChildReference": ...,
"LinkName": ...,
}
Definition
class BatchAttachObjectTypeDef(TypedDict):
ParentReference: ObjectReferenceTypeDef, # (1)
ChildReference: ObjectReferenceTypeDef, # (1)
LinkName: str,
BatchAttachPolicyTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchAttachPolicyTypeDef
def get_value() -> BatchAttachPolicyTypeDef:
return {
"PolicyReference": ...,
"ObjectReference": ...,
}
Definition
class BatchAttachPolicyTypeDef(TypedDict):
PolicyReference: ObjectReferenceTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (1)
BatchAttachToIndexTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchAttachToIndexTypeDef
def get_value() -> BatchAttachToIndexTypeDef:
return {
"IndexReference": ...,
"TargetReference": ...,
}
Definition
class BatchAttachToIndexTypeDef(TypedDict):
IndexReference: ObjectReferenceTypeDef, # (1)
TargetReference: ObjectReferenceTypeDef, # (1)
BatchDeleteObjectTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDeleteObjectTypeDef
def get_value() -> BatchDeleteObjectTypeDef:
return {
"ObjectReference": ...,
}
BatchDetachFromIndexTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDetachFromIndexTypeDef
def get_value() -> BatchDetachFromIndexTypeDef:
return {
"IndexReference": ...,
"TargetReference": ...,
}
Definition
class BatchDetachFromIndexTypeDef(TypedDict):
IndexReference: ObjectReferenceTypeDef, # (1)
TargetReference: ObjectReferenceTypeDef, # (1)
BatchDetachObjectTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDetachObjectTypeDef
def get_value() -> BatchDetachObjectTypeDef:
return {
"ParentReference": ...,
"LinkName": ...,
}
Definition
class BatchDetachObjectTypeDef(TypedDict):
ParentReference: ObjectReferenceTypeDef, # (1)
LinkName: str,
BatchReferenceName: NotRequired[str],
BatchDetachPolicyTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchDetachPolicyTypeDef
def get_value() -> BatchDetachPolicyTypeDef:
return {
"PolicyReference": ...,
"ObjectReference": ...,
}
Definition
class BatchDetachPolicyTypeDef(TypedDict):
PolicyReference: ObjectReferenceTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (1)
BatchGetObjectInformationTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchGetObjectInformationTypeDef
def get_value() -> BatchGetObjectInformationTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchGetObjectInformationTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
BatchListAttachedIndicesTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListAttachedIndicesTypeDef
def get_value() -> BatchListAttachedIndicesTypeDef:
return {
"TargetReference": ...,
}
Definition
class BatchListAttachedIndicesTypeDef(TypedDict):
TargetReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchListObjectChildrenTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectChildrenTypeDef
def get_value() -> BatchListObjectChildrenTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchListObjectChildrenTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchListObjectParentPathsTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectParentPathsTypeDef
def get_value() -> BatchListObjectParentPathsTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchListObjectParentPathsTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchListObjectParentsTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectParentsTypeDef
def get_value() -> BatchListObjectParentsTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchListObjectParentsTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchListObjectPoliciesTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectPoliciesTypeDef
def get_value() -> BatchListObjectPoliciesTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchListObjectPoliciesTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchListPolicyAttachmentsTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListPolicyAttachmentsTypeDef
def get_value() -> BatchListPolicyAttachmentsTypeDef:
return {
"PolicyReference": ...,
}
Definition
class BatchListPolicyAttachmentsTypeDef(TypedDict):
PolicyReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchLookupPolicyTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchLookupPolicyTypeDef
def get_value() -> BatchLookupPolicyTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchLookupPolicyTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DeleteObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DeleteObjectRequestRequestTypeDef
def get_value() -> DeleteObjectRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class DeleteObjectRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
DetachFromIndexRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DetachFromIndexRequestRequestTypeDef
def get_value() -> DetachFromIndexRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"IndexReference": ...,
"TargetReference": ...,
}
Definition
class DetachFromIndexRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
IndexReference: ObjectReferenceTypeDef, # (1)
TargetReference: ObjectReferenceTypeDef, # (1)
DetachObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DetachObjectRequestRequestTypeDef
def get_value() -> DetachObjectRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ParentReference": ...,
"LinkName": ...,
}
Definition
class DetachObjectRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ParentReference: ObjectReferenceTypeDef, # (1)
LinkName: str,
DetachPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import DetachPolicyRequestRequestTypeDef
def get_value() -> DetachPolicyRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"PolicyReference": ...,
"ObjectReference": ...,
}
Definition
class DetachPolicyRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
PolicyReference: ObjectReferenceTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (1)
GetObjectInformationRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetObjectInformationRequestRequestTypeDef
def get_value() -> GetObjectInformationRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class GetObjectInformationRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
ListAttachedIndicesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListAttachedIndicesRequestRequestTypeDef
def get_value() -> ListAttachedIndicesRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"TargetReference": ...,
}
Definition
class ListAttachedIndicesRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
TargetReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
ListObjectChildrenRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListObjectChildrenRequestRequestTypeDef
def get_value() -> ListObjectChildrenRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class ListObjectChildrenRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
ListObjectParentPathsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListObjectParentPathsRequestRequestTypeDef
def get_value() -> ListObjectParentPathsRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class ListObjectParentPathsRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListObjectParentsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListObjectParentsRequestRequestTypeDef
def get_value() -> ListObjectParentsRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class ListObjectParentsRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
IncludeAllLinksToEachParent: NotRequired[bool],
ListObjectPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListObjectPoliciesRequestRequestTypeDef
def get_value() -> ListObjectPoliciesRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class ListObjectPoliciesRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
ListPolicyAttachmentsRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListPolicyAttachmentsRequestRequestTypeDef
def get_value() -> ListPolicyAttachmentsRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"PolicyReference": ...,
}
Definition
class ListPolicyAttachmentsRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
PolicyReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
LookupPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import LookupPolicyRequestRequestTypeDef
def get_value() -> LookupPolicyRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class LookupPolicyRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
BatchGetObjectAttributesTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchGetObjectAttributesTypeDef
def get_value() -> BatchGetObjectAttributesTypeDef:
return {
"ObjectReference": ...,
"SchemaFacet": ...,
"AttributeNames": ...,
}
Definition
class BatchGetObjectAttributesTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
SchemaFacet: SchemaFacetTypeDef, # (2)
AttributeNames: Sequence[str],
BatchGetObjectInformationResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchGetObjectInformationResponseTypeDef
def get_value() -> BatchGetObjectInformationResponseTypeDef:
return {
"SchemaFacets": ...,
}
Definition
class BatchGetObjectInformationResponseTypeDef(TypedDict):
SchemaFacets: NotRequired[List[SchemaFacetTypeDef]], # (1)
ObjectIdentifier: NotRequired[str],
BatchListObjectAttributesTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchListObjectAttributesTypeDef
def get_value() -> BatchListObjectAttributesTypeDef:
return {
"ObjectReference": ...,
}
Definition
class BatchListObjectAttributesTypeDef(TypedDict):
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
FacetFilter: NotRequired[SchemaFacetTypeDef], # (2)
BatchRemoveFacetFromObjectTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import BatchRemoveFacetFromObjectTypeDef
def get_value() -> BatchRemoveFacetFromObjectTypeDef:
return {
"SchemaFacet": ...,
"ObjectReference": ...,
}
Definition
class BatchRemoveFacetFromObjectTypeDef(TypedDict):
SchemaFacet: SchemaFacetTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (2)
GetObjectAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import GetObjectAttributesRequestRequestTypeDef
def get_value() -> GetObjectAttributesRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
"SchemaFacet": ...,
"AttributeNames": ...,
}
Definition
class GetObjectAttributesRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
SchemaFacet: SchemaFacetTypeDef, # (2)
AttributeNames: Sequence[str],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (3)
ListObjectAttributesRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ListObjectAttributesRequestRequestTypeDef
def get_value() -> ListObjectAttributesRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"ObjectReference": ...,
}
Definition
class ListObjectAttributesRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
ObjectReference: ObjectReferenceTypeDef, # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ConsistencyLevel: NotRequired[ConsistencyLevelType], # (2)
FacetFilter: NotRequired[SchemaFacetTypeDef], # (3)
RemoveFacetFromObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import RemoveFacetFromObjectRequestRequestTypeDef
def get_value() -> RemoveFacetFromObjectRequestRequestTypeDef:
return {
"DirectoryArn": ...,
"SchemaFacet": ...,
"ObjectReference": ...,
}
Definition
class RemoveFacetFromObjectRequestRequestTypeDef(TypedDict):
DirectoryArn: str,
SchemaFacet: SchemaFacetTypeDef, # (1)
ObjectReference: ObjectReferenceTypeDef, # (2)
ApplySchemaResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import ApplySchemaResponseTypeDef
def get_value() -> ApplySchemaResponseTypeDef:
return {
"AppliedSchemaArn": ...,
"DirectoryArn": ...,
"ResponseMetadata": ...,
}
Definition
class ApplySchemaResponseTypeDef(TypedDict):
AppliedSchemaArn: str,
DirectoryArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AttachObjectResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttachObjectResponseTypeDef
def get_value() -> AttachObjectResponseTypeDef:
return {
"AttachedObjectIdentifier": ...,
"ResponseMetadata": ...,
}
Definition
class AttachObjectResponseTypeDef(TypedDict):
AttachedObjectIdentifier: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AttachToIndexResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import AttachToIndexResponseTypeDef
def get_value() -> AttachToIndexResponseTypeDef:
return {
"AttachedObjectIdentifier": ...,
"ResponseMetadata": ...,
}
Definition
class AttachToIndexResponseTypeDef(TypedDict):
AttachedObjectIdentifier: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDirectoryResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import CreateDirectoryResponseTypeDef
def get_value() -> CreateDirectoryResponseTypeDef:
return {
"DirectoryArn": ...,
"Name": ...,
"ObjectIdentifier": ...,
"AppliedSchemaArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDirectoryResponseTypeDef(TypedDict):
DirectoryArn: str,
Name: str,
ObjectIdentifier: str,
AppliedSchemaArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIndexResponseTypeDef
Usage Example
from mypy_boto3_clouddirectory.type_defs import CreateIndexResponseTypeDef
def get_value() -> CreateIndexResponseTypeDef:
return {
"ObjectIdentifier": ...,
"ResponseMetadata": ...,
}