Skip to content

CloudDirectoryClient#

Index > CloudDirectory > CloudDirectoryClient

Auto-generated documentation for CloudDirectory type annotations stubs module mypy-boto3-clouddirectory.

CloudDirectoryClient#

Type annotations and code completion for boto3.client("clouddirectory"). boto3 documentation

# CloudDirectoryClient usage example

from boto3.session import Session
from mypy_boto3_clouddirectory.client import CloudDirectoryClient

def get_clouddirectory_client() -> CloudDirectoryClient:
    return Session().client("clouddirectory")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("clouddirectory").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("clouddirectory")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BatchWriteException,
    client.exceptions.CannotListParentOfRootException,
    client.exceptions.ClientError,
    client.exceptions.DirectoryAlreadyExistsException,
    client.exceptions.DirectoryDeletedException,
    client.exceptions.DirectoryNotDisabledException,
    client.exceptions.DirectoryNotEnabledException,
    client.exceptions.FacetAlreadyExistsException,
    client.exceptions.FacetInUseException,
    client.exceptions.FacetNotFoundException,
    client.exceptions.FacetValidationException,
    client.exceptions.IncompatibleSchemaException,
    client.exceptions.IndexedAttributeMissingException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidArnException,
    client.exceptions.InvalidAttachmentException,
    client.exceptions.InvalidFacetUpdateException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidRuleException,
    client.exceptions.InvalidSchemaDocException,
    client.exceptions.InvalidTaggingRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.LinkNameAlreadyInUseException,
    client.exceptions.NotIndexException,
    client.exceptions.NotNodeException,
    client.exceptions.NotPolicyException,
    client.exceptions.ObjectAlreadyDetachedException,
    client.exceptions.ObjectNotDetachedException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.RetryableConflictException,
    client.exceptions.SchemaAlreadyExistsException,
    client.exceptions.SchemaAlreadyPublishedException,
    client.exceptions.StillContainsLinksException,
    client.exceptions.UnsupportedIndexTypeException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_clouddirectory.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

add_facet_to_object#

Adds a new Facet to an object.

Type annotations and code completion for boto3.client("clouddirectory").add_facet_to_object method. boto3 documentation

# add_facet_to_object method definition

def add_facet_to_object(
    self,
    *,
    DirectoryArn: str,
    SchemaFacet: SchemaFacetTypeDef,  # (1)
    ObjectReference: ObjectReferenceTypeDef,  # (2)
    ObjectAttributeList: Sequence[AttributeKeyAndValueUnionTypeDef] = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See SchemaFacetTypeDef
  2. See ObjectReferenceTypeDef
  3. See AttributeKeyAndValueTypeDef AttributeKeyAndValueOutputTypeDef 
# add_facet_to_object method usage example with argument unpacking

kwargs: AddFacetToObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "SchemaFacet": ...,
    "ObjectReference": ...,
}

parent.add_facet_to_object(**kwargs)
  1. See AddFacetToObjectRequestRequestTypeDef

apply_schema#

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

Type annotations and code completion for boto3.client("clouddirectory").apply_schema method. boto3 documentation

# apply_schema method definition

def apply_schema(
    self,
    *,
    PublishedSchemaArn: str,
    DirectoryArn: str,
) -> ApplySchemaResponseTypeDef:  # (1)
    ...
  1. See ApplySchemaResponseTypeDef 
# apply_schema method usage example with argument unpacking

kwargs: ApplySchemaRequestRequestTypeDef = {  # (1)
    "PublishedSchemaArn": ...,
    "DirectoryArn": ...,
}

parent.apply_schema(**kwargs)
  1. See ApplySchemaRequestRequestTypeDef

attach_object#

Attaches an existing object to another object.

Type annotations and code completion for boto3.client("clouddirectory").attach_object method. boto3 documentation

# attach_object method definition

def attach_object(
    self,
    *,
    DirectoryArn: str,
    ParentReference: ObjectReferenceTypeDef,  # (1)
    ChildReference: ObjectReferenceTypeDef,  # (1)
    LinkName: str,
) -> AttachObjectResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef
  3. See AttachObjectResponseTypeDef 
# attach_object method usage example with argument unpacking

kwargs: AttachObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ParentReference": ...,
    "ChildReference": ...,
    "LinkName": ...,
}

parent.attach_object(**kwargs)
  1. See AttachObjectRequestRequestTypeDef

attach_policy#

Attaches a policy object to a regular object.

Type annotations and code completion for boto3.client("clouddirectory").attach_policy method. boto3 documentation

# attach_policy method definition

def attach_policy(
    self,
    *,
    DirectoryArn: str,
    PolicyReference: ObjectReferenceTypeDef,  # (1)
    ObjectReference: ObjectReferenceTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef 
# attach_policy method usage example with argument unpacking

kwargs: AttachPolicyRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "PolicyReference": ...,
    "ObjectReference": ...,
}

parent.attach_policy(**kwargs)
  1. See AttachPolicyRequestRequestTypeDef

attach_to_index#

Attaches the specified object to the specified index.

Type annotations and code completion for boto3.client("clouddirectory").attach_to_index method. boto3 documentation

# attach_to_index method definition

def attach_to_index(
    self,
    *,
    DirectoryArn: str,
    IndexReference: ObjectReferenceTypeDef,  # (1)
    TargetReference: ObjectReferenceTypeDef,  # (1)
) -> AttachToIndexResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef
  3. See AttachToIndexResponseTypeDef 
# attach_to_index method usage example with argument unpacking

kwargs: AttachToIndexRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "IndexReference": ...,
    "TargetReference": ...,
}

parent.attach_to_index(**kwargs)
  1. See AttachToIndexRequestRequestTypeDef

Attaches a typed link to a specified source and target object.

Type annotations and code completion for boto3.client("clouddirectory").attach_typed_link method. boto3 documentation

# attach_typed_link method definition

def attach_typed_link(
    self,
    *,
    DirectoryArn: str,
    SourceObjectReference: ObjectReferenceTypeDef,  # (1)
    TargetObjectReference: ObjectReferenceTypeDef,  # (1)
    TypedLinkFacet: TypedLinkSchemaAndFacetNameTypeDef,  # (3)
    Attributes: Sequence[AttributeNameAndValueUnionTypeDef],  # (4)
) -> AttachTypedLinkResponseTypeDef:  # (5)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef
  3. See TypedLinkSchemaAndFacetNameTypeDef
  4. See AttributeNameAndValueTypeDef AttributeNameAndValueOutputTypeDef
  5. See AttachTypedLinkResponseTypeDef 
# attach_typed_link method usage example with argument unpacking

kwargs: AttachTypedLinkRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "SourceObjectReference": ...,
    "TargetObjectReference": ...,
    "TypedLinkFacet": ...,
    "Attributes": ...,
}

parent.attach_typed_link(**kwargs)
  1. See AttachTypedLinkRequestRequestTypeDef

batch_read#

Performs all the read operations in a batch.

Type annotations and code completion for boto3.client("clouddirectory").batch_read method. boto3 documentation

# batch_read method definition

def batch_read(
    self,
    *,
    DirectoryArn: str,
    Operations: Sequence[BatchReadOperationTypeDef],  # (1)
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> BatchReadResponseTypeDef:  # (3)
    ...
  1. See BatchReadOperationTypeDef
  2. See ConsistencyLevelType
  3. See BatchReadResponseTypeDef 
# batch_read method usage example with argument unpacking

kwargs: BatchReadRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "Operations": ...,
}

parent.batch_read(**kwargs)
  1. See BatchReadRequestRequestTypeDef

batch_write#

Performs all the write operations in a batch.

Type annotations and code completion for boto3.client("clouddirectory").batch_write method. boto3 documentation

# batch_write method definition

def batch_write(
    self,
    *,
    DirectoryArn: str,
    Operations: Sequence[BatchWriteOperationTypeDef],  # (1)
) -> BatchWriteResponseTypeDef:  # (2)
    ...
  1. See BatchWriteOperationTypeDef
  2. See BatchWriteResponseTypeDef 
# batch_write method usage example with argument unpacking

kwargs: BatchWriteRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "Operations": ...,
}

parent.batch_write(**kwargs)
  1. See BatchWriteRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("clouddirectory").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("clouddirectory").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_directory#

Creates a Directory by copying the published schema into the directory.

Type annotations and code completion for boto3.client("clouddirectory").create_directory method. boto3 documentation

# create_directory method definition

def create_directory(
    self,
    *,
    Name: str,
    SchemaArn: str,
) -> CreateDirectoryResponseTypeDef:  # (1)
    ...
  1. See CreateDirectoryResponseTypeDef 
# create_directory method usage example with argument unpacking

kwargs: CreateDirectoryRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SchemaArn": ...,
}

parent.create_directory(**kwargs)
  1. See CreateDirectoryRequestRequestTypeDef

create_facet#

Creates a new Facet in a schema.

Type annotations and code completion for boto3.client("clouddirectory").create_facet method. boto3 documentation

# create_facet method definition

def create_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
    Attributes: Sequence[FacetAttributeUnionTypeDef] = ...,  # (1)
    ObjectType: ObjectTypeType = ...,  # (2)
    FacetStyle: FacetStyleType = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See FacetAttributeTypeDef FacetAttributeOutputTypeDef
  2. See ObjectTypeType
  3. See FacetStyleType 
# create_facet method usage example with argument unpacking

kwargs: CreateFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.create_facet(**kwargs)
  1. See CreateFacetRequestRequestTypeDef

create_index#

Creates an index object.

Type annotations and code completion for boto3.client("clouddirectory").create_index method. boto3 documentation

# create_index method definition

def create_index(
    self,
    *,
    DirectoryArn: str,
    OrderedIndexedAttributeList: Sequence[AttributeKeyTypeDef],  # (1)
    IsUnique: bool,
    ParentReference: ObjectReferenceTypeDef = ...,  # (2)
    LinkName: str = ...,
) -> CreateIndexResponseTypeDef:  # (3)
    ...
  1. See AttributeKeyTypeDef
  2. See ObjectReferenceTypeDef
  3. See CreateIndexResponseTypeDef 
# create_index method usage example with argument unpacking

kwargs: CreateIndexRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "OrderedIndexedAttributeList": ...,
    "IsUnique": ...,
}

parent.create_index(**kwargs)
  1. See CreateIndexRequestRequestTypeDef

create_object#

Creates an object in a Directory.

Type annotations and code completion for boto3.client("clouddirectory").create_object method. boto3 documentation

# create_object method definition

def create_object(
    self,
    *,
    DirectoryArn: str,
    SchemaFacets: Sequence[SchemaFacetTypeDef],  # (1)
    ObjectAttributeList: Sequence[AttributeKeyAndValueTypeDef] = ...,  # (2)
    ParentReference: ObjectReferenceTypeDef = ...,  # (3)
    LinkName: str = ...,
) -> CreateObjectResponseTypeDef:  # (4)
    ...
  1. See SchemaFacetTypeDef
  2. See AttributeKeyAndValueTypeDef
  3. See ObjectReferenceTypeDef
  4. See CreateObjectResponseTypeDef 
# create_object method usage example with argument unpacking

kwargs: CreateObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "SchemaFacets": ...,
}

parent.create_object(**kwargs)
  1. See CreateObjectRequestRequestTypeDef

create_schema#

Creates a new schema in a development state.

Type annotations and code completion for boto3.client("clouddirectory").create_schema method. boto3 documentation

# create_schema method definition

def create_schema(
    self,
    *,
    Name: str,
) -> CreateSchemaResponseTypeDef:  # (1)
    ...
  1. See CreateSchemaResponseTypeDef 
# create_schema method usage example with argument unpacking

kwargs: CreateSchemaRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_schema(**kwargs)
  1. See CreateSchemaRequestRequestTypeDef

Creates a TypedLinkFacet.

Type annotations and code completion for boto3.client("clouddirectory").create_typed_link_facet method. boto3 documentation

# create_typed_link_facet method definition

def create_typed_link_facet(
    self,
    *,
    SchemaArn: str,
    Facet: TypedLinkFacetTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TypedLinkFacetTypeDef 
# create_typed_link_facet method usage example with argument unpacking

kwargs: CreateTypedLinkFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Facet": ...,
}

parent.create_typed_link_facet(**kwargs)
  1. See CreateTypedLinkFacetRequestRequestTypeDef

delete_directory#

Deletes a directory.

Type annotations and code completion for boto3.client("clouddirectory").delete_directory method. boto3 documentation

# delete_directory method definition

def delete_directory(
    self,
    *,
    DirectoryArn: str,
) -> DeleteDirectoryResponseTypeDef:  # (1)
    ...
  1. See DeleteDirectoryResponseTypeDef 
# delete_directory method usage example with argument unpacking

kwargs: DeleteDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
}

parent.delete_directory(**kwargs)
  1. See DeleteDirectoryRequestRequestTypeDef

delete_facet#

Deletes a given Facet.

Type annotations and code completion for boto3.client("clouddirectory").delete_facet method. boto3 documentation

# delete_facet method definition

def delete_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_facet method usage example with argument unpacking

kwargs: DeleteFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.delete_facet(**kwargs)
  1. See DeleteFacetRequestRequestTypeDef

delete_object#

Deletes an object and its associated attributes.

Type annotations and code completion for boto3.client("clouddirectory").delete_object method. boto3 documentation

# delete_object method definition

def delete_object(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ObjectReferenceTypeDef 
# delete_object method usage example with argument unpacking

kwargs: DeleteObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.delete_object(**kwargs)
  1. See DeleteObjectRequestRequestTypeDef

delete_schema#

Deletes a given schema.

Type annotations and code completion for boto3.client("clouddirectory").delete_schema method. boto3 documentation

# delete_schema method definition

def delete_schema(
    self,
    *,
    SchemaArn: str,
) -> DeleteSchemaResponseTypeDef:  # (1)
    ...
  1. See DeleteSchemaResponseTypeDef 
# delete_schema method usage example with argument unpacking

kwargs: DeleteSchemaRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.delete_schema(**kwargs)
  1. See DeleteSchemaRequestRequestTypeDef

Deletes a TypedLinkFacet.

Type annotations and code completion for boto3.client("clouddirectory").delete_typed_link_facet method. boto3 documentation

# delete_typed_link_facet method definition

def delete_typed_link_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_typed_link_facet method usage example with argument unpacking

kwargs: DeleteTypedLinkFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.delete_typed_link_facet(**kwargs)
  1. See DeleteTypedLinkFacetRequestRequestTypeDef

detach_from_index#

Detaches the specified object from the specified index.

Type annotations and code completion for boto3.client("clouddirectory").detach_from_index method. boto3 documentation

# detach_from_index method definition

def detach_from_index(
    self,
    *,
    DirectoryArn: str,
    IndexReference: ObjectReferenceTypeDef,  # (1)
    TargetReference: ObjectReferenceTypeDef,  # (1)
) -> DetachFromIndexResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef
  3. See DetachFromIndexResponseTypeDef 
# detach_from_index method usage example with argument unpacking

kwargs: DetachFromIndexRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "IndexReference": ...,
    "TargetReference": ...,
}

parent.detach_from_index(**kwargs)
  1. See DetachFromIndexRequestRequestTypeDef

detach_object#

Detaches a given object from the parent object.

Type annotations and code completion for boto3.client("clouddirectory").detach_object method. boto3 documentation

# detach_object method definition

def detach_object(
    self,
    *,
    DirectoryArn: str,
    ParentReference: ObjectReferenceTypeDef,  # (1)
    LinkName: str,
) -> DetachObjectResponseTypeDef:  # (2)
    ...
  1. See ObjectReferenceTypeDef
  2. See DetachObjectResponseTypeDef 
# detach_object method usage example with argument unpacking

kwargs: DetachObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ParentReference": ...,
    "LinkName": ...,
}

parent.detach_object(**kwargs)
  1. See DetachObjectRequestRequestTypeDef

detach_policy#

Detaches a policy from an object.

Type annotations and code completion for boto3.client("clouddirectory").detach_policy method. boto3 documentation

# detach_policy method definition

def detach_policy(
    self,
    *,
    DirectoryArn: str,
    PolicyReference: ObjectReferenceTypeDef,  # (1)
    ObjectReference: ObjectReferenceTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectReferenceTypeDef 
# detach_policy method usage example with argument unpacking

kwargs: DetachPolicyRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "PolicyReference": ...,
    "ObjectReference": ...,
}

parent.detach_policy(**kwargs)
  1. See DetachPolicyRequestRequestTypeDef

Detaches a typed link from a specified source and target object.

Type annotations and code completion for boto3.client("clouddirectory").detach_typed_link method. boto3 documentation

# detach_typed_link method definition

def detach_typed_link(
    self,
    *,
    DirectoryArn: str,
    TypedLinkSpecifier: TypedLinkSpecifierTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TypedLinkSpecifierTypeDef
  2. See EmptyResponseMetadataTypeDef 
# detach_typed_link method usage example with argument unpacking

kwargs: DetachTypedLinkRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "TypedLinkSpecifier": ...,
}

parent.detach_typed_link(**kwargs)
  1. See DetachTypedLinkRequestRequestTypeDef

disable_directory#

Disables the specified directory.

Type annotations and code completion for boto3.client("clouddirectory").disable_directory method. boto3 documentation

# disable_directory method definition

def disable_directory(
    self,
    *,
    DirectoryArn: str,
) -> DisableDirectoryResponseTypeDef:  # (1)
    ...
  1. See DisableDirectoryResponseTypeDef 
# disable_directory method usage example with argument unpacking

kwargs: DisableDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
}

parent.disable_directory(**kwargs)
  1. See DisableDirectoryRequestRequestTypeDef

enable_directory#

Enables the specified directory.

Type annotations and code completion for boto3.client("clouddirectory").enable_directory method. boto3 documentation

# enable_directory method definition

def enable_directory(
    self,
    *,
    DirectoryArn: str,
) -> EnableDirectoryResponseTypeDef:  # (1)
    ...
  1. See EnableDirectoryResponseTypeDef 
# enable_directory method usage example with argument unpacking

kwargs: EnableDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
}

parent.enable_directory(**kwargs)
  1. See EnableDirectoryRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("clouddirectory").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_applied_schema_version#

Returns current applied schema version ARN, including the minor version in use.

Type annotations and code completion for boto3.client("clouddirectory").get_applied_schema_version method. boto3 documentation

# get_applied_schema_version method definition

def get_applied_schema_version(
    self,
    *,
    SchemaArn: str,
) -> GetAppliedSchemaVersionResponseTypeDef:  # (1)
    ...
  1. See GetAppliedSchemaVersionResponseTypeDef 
# get_applied_schema_version method usage example with argument unpacking

kwargs: GetAppliedSchemaVersionRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.get_applied_schema_version(**kwargs)
  1. See GetAppliedSchemaVersionRequestRequestTypeDef

get_directory#

Retrieves metadata about a directory.

Type annotations and code completion for boto3.client("clouddirectory").get_directory method. boto3 documentation

# get_directory method definition

def get_directory(
    self,
    *,
    DirectoryArn: str,
) -> GetDirectoryResponseTypeDef:  # (1)
    ...
  1. See GetDirectoryResponseTypeDef 
# get_directory method usage example with argument unpacking

kwargs: GetDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
}

parent.get_directory(**kwargs)
  1. See GetDirectoryRequestRequestTypeDef

get_facet#

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType.

Type annotations and code completion for boto3.client("clouddirectory").get_facet method. boto3 documentation

# get_facet method definition

def get_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
) -> GetFacetResponseTypeDef:  # (1)
    ...
  1. See GetFacetResponseTypeDef 
# get_facet method usage example with argument unpacking

kwargs: GetFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.get_facet(**kwargs)
  1. See GetFacetRequestRequestTypeDef

Retrieves attributes that are associated with a typed link.

Type annotations and code completion for boto3.client("clouddirectory").get_link_attributes method. boto3 documentation

# get_link_attributes method definition

def get_link_attributes(
    self,
    *,
    DirectoryArn: str,
    TypedLinkSpecifier: TypedLinkSpecifierTypeDef,  # (1)
    AttributeNames: Sequence[str],
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> GetLinkAttributesResponseTypeDef:  # (3)
    ...
  1. See TypedLinkSpecifierTypeDef
  2. See ConsistencyLevelType
  3. See GetLinkAttributesResponseTypeDef 
# get_link_attributes method usage example with argument unpacking

kwargs: GetLinkAttributesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "TypedLinkSpecifier": ...,
    "AttributeNames": ...,
}

parent.get_link_attributes(**kwargs)
  1. See GetLinkAttributesRequestRequestTypeDef

get_object_attributes#

Retrieves attributes within a facet that are associated with an object.

Type annotations and code completion for boto3.client("clouddirectory").get_object_attributes method. boto3 documentation

# get_object_attributes method definition

def get_object_attributes(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    SchemaFacet: SchemaFacetTypeDef,  # (2)
    AttributeNames: Sequence[str],
    ConsistencyLevel: ConsistencyLevelType = ...,  # (3)
) -> GetObjectAttributesResponseTypeDef:  # (4)
    ...
  1. See ObjectReferenceTypeDef
  2. See SchemaFacetTypeDef
  3. See ConsistencyLevelType
  4. See GetObjectAttributesResponseTypeDef 
# get_object_attributes method usage example with argument unpacking

kwargs: GetObjectAttributesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
    "SchemaFacet": ...,
    "AttributeNames": ...,
}

parent.get_object_attributes(**kwargs)
  1. See GetObjectAttributesRequestRequestTypeDef

get_object_information#

Retrieves metadata about an object.

Type annotations and code completion for boto3.client("clouddirectory").get_object_information method. boto3 documentation

# get_object_information method definition

def get_object_information(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> GetObjectInformationResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See GetObjectInformationResponseTypeDef 
# get_object_information method usage example with argument unpacking

kwargs: GetObjectInformationRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.get_object_information(**kwargs)
  1. See GetObjectInformationRequestRequestTypeDef

get_schema_as_json#

Retrieves a JSON representation of the schema.

Type annotations and code completion for boto3.client("clouddirectory").get_schema_as_json method. boto3 documentation

# get_schema_as_json method definition

def get_schema_as_json(
    self,
    *,
    SchemaArn: str,
) -> GetSchemaAsJsonResponseTypeDef:  # (1)
    ...
  1. See GetSchemaAsJsonResponseTypeDef 
# get_schema_as_json method usage example with argument unpacking

kwargs: GetSchemaAsJsonRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.get_schema_as_json(**kwargs)
  1. See GetSchemaAsJsonRequestRequestTypeDef

Returns the identity attribute order for a specific TypedLinkFacet.

Type annotations and code completion for boto3.client("clouddirectory").get_typed_link_facet_information method. boto3 documentation

# get_typed_link_facet_information method definition

def get_typed_link_facet_information(
    self,
    *,
    SchemaArn: str,
    Name: str,
) -> GetTypedLinkFacetInformationResponseTypeDef:  # (1)
    ...
  1. See GetTypedLinkFacetInformationResponseTypeDef 
# get_typed_link_facet_information method usage example with argument unpacking

kwargs: GetTypedLinkFacetInformationRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.get_typed_link_facet_information(**kwargs)
  1. See GetTypedLinkFacetInformationRequestRequestTypeDef

list_applied_schema_arns#

Lists schema major versions applied to a directory.

Type annotations and code completion for boto3.client("clouddirectory").list_applied_schema_arns method. boto3 documentation

# list_applied_schema_arns method definition

def list_applied_schema_arns(
    self,
    *,
    DirectoryArn: str,
    SchemaArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAppliedSchemaArnsResponseTypeDef:  # (1)
    ...
  1. See ListAppliedSchemaArnsResponseTypeDef 
# list_applied_schema_arns method usage example with argument unpacking

kwargs: ListAppliedSchemaArnsRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
}

parent.list_applied_schema_arns(**kwargs)
  1. See ListAppliedSchemaArnsRequestRequestTypeDef

list_attached_indices#

Lists indices attached to the specified object.

Type annotations and code completion for boto3.client("clouddirectory").list_attached_indices method. boto3 documentation

# list_attached_indices method definition

def list_attached_indices(
    self,
    *,
    DirectoryArn: str,
    TargetReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> ListAttachedIndicesResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See ListAttachedIndicesResponseTypeDef 
# list_attached_indices method usage example with argument unpacking

kwargs: ListAttachedIndicesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "TargetReference": ...,
}

parent.list_attached_indices(**kwargs)
  1. See ListAttachedIndicesRequestRequestTypeDef

list_development_schema_arns#

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

Type annotations and code completion for boto3.client("clouddirectory").list_development_schema_arns method. boto3 documentation

# list_development_schema_arns method definition

def list_development_schema_arns(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDevelopmentSchemaArnsResponseTypeDef:  # (1)
    ...
  1. See ListDevelopmentSchemaArnsResponseTypeDef 
# list_development_schema_arns method usage example with argument unpacking

kwargs: ListDevelopmentSchemaArnsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_development_schema_arns(**kwargs)
  1. See ListDevelopmentSchemaArnsRequestRequestTypeDef

list_directories#

Lists directories created within an account.

Type annotations and code completion for boto3.client("clouddirectory").list_directories method. boto3 documentation

# list_directories method definition

def list_directories(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    state: DirectoryStateType = ...,  # (1)
) -> ListDirectoriesResponseTypeDef:  # (2)
    ...
  1. See DirectoryStateType
  2. See ListDirectoriesResponseTypeDef 
# list_directories method usage example with argument unpacking

kwargs: ListDirectoriesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_directories(**kwargs)
  1. See ListDirectoriesRequestRequestTypeDef

list_facet_attributes#

Retrieves attributes attached to the facet.

Type annotations and code completion for boto3.client("clouddirectory").list_facet_attributes method. boto3 documentation

# list_facet_attributes method definition

def list_facet_attributes(
    self,
    *,
    SchemaArn: str,
    Name: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFacetAttributesResponseTypeDef:  # (1)
    ...
  1. See ListFacetAttributesResponseTypeDef 
# list_facet_attributes method usage example with argument unpacking

kwargs: ListFacetAttributesRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.list_facet_attributes(**kwargs)
  1. See ListFacetAttributesRequestRequestTypeDef

list_facet_names#

Retrieves the names of facets that exist in a schema.

Type annotations and code completion for boto3.client("clouddirectory").list_facet_names method. boto3 documentation

# list_facet_names method definition

def list_facet_names(
    self,
    *,
    SchemaArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFacetNamesResponseTypeDef:  # (1)
    ...
  1. See ListFacetNamesResponseTypeDef 
# list_facet_names method usage example with argument unpacking

kwargs: ListFacetNamesRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.list_facet_names(**kwargs)
  1. See ListFacetNamesRequestRequestTypeDef

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.

Type annotations and code completion for boto3.client("clouddirectory").list_incoming_typed_links method. boto3 documentation

# list_incoming_typed_links method definition

def list_incoming_typed_links(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    FilterAttributeRanges: Sequence[TypedLinkAttributeRangeTypeDef] = ...,  # (2)
    FilterTypedLink: TypedLinkSchemaAndFacetNameTypeDef = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (4)
) -> ListIncomingTypedLinksResponseTypeDef:  # (5)
    ...
  1. See ObjectReferenceTypeDef
  2. See TypedLinkAttributeRangeTypeDef
  3. See TypedLinkSchemaAndFacetNameTypeDef
  4. See ConsistencyLevelType
  5. See ListIncomingTypedLinksResponseTypeDef 
# list_incoming_typed_links method usage example with argument unpacking

kwargs: ListIncomingTypedLinksRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_incoming_typed_links(**kwargs)
  1. See ListIncomingTypedLinksRequestRequestTypeDef

list_index#

Lists objects attached to the specified index.

Type annotations and code completion for boto3.client("clouddirectory").list_index method. boto3 documentation

# list_index method definition

def list_index(
    self,
    *,
    DirectoryArn: str,
    IndexReference: ObjectReferenceTypeDef,  # (1)
    RangesOnIndexedValues: Sequence[ObjectAttributeRangeTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (3)
) -> ListIndexResponseTypeDef:  # (4)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectAttributeRangeTypeDef
  3. See ConsistencyLevelType
  4. See ListIndexResponseTypeDef 
# list_index method usage example with argument unpacking

kwargs: ListIndexRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "IndexReference": ...,
}

parent.list_index(**kwargs)
  1. See ListIndexRequestRequestTypeDef

list_managed_schema_arns#

Lists the major version families of each managed schema.

Type annotations and code completion for boto3.client("clouddirectory").list_managed_schema_arns method. boto3 documentation

# list_managed_schema_arns method definition

def list_managed_schema_arns(
    self,
    *,
    SchemaArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListManagedSchemaArnsResponseTypeDef:  # (1)
    ...
  1. See ListManagedSchemaArnsResponseTypeDef 
# list_managed_schema_arns method usage example with argument unpacking

kwargs: ListManagedSchemaArnsRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.list_managed_schema_arns(**kwargs)
  1. See ListManagedSchemaArnsRequestRequestTypeDef

list_object_attributes#

Lists all attributes that are associated with an object.

Type annotations and code completion for boto3.client("clouddirectory").list_object_attributes method. boto3 documentation

# list_object_attributes method definition

def list_object_attributes(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
    FacetFilter: SchemaFacetTypeDef = ...,  # (3)
) -> ListObjectAttributesResponseTypeDef:  # (4)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See SchemaFacetTypeDef
  4. See ListObjectAttributesResponseTypeDef 
# list_object_attributes method usage example with argument unpacking

kwargs: ListObjectAttributesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_object_attributes(**kwargs)
  1. See ListObjectAttributesRequestRequestTypeDef

list_object_children#

Returns a paginated list of child objects that are associated with a given object.

Type annotations and code completion for boto3.client("clouddirectory").list_object_children method. boto3 documentation

# list_object_children method definition

def list_object_children(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> ListObjectChildrenResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See ListObjectChildrenResponseTypeDef 
# list_object_children method usage example with argument unpacking

kwargs: ListObjectChildrenRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_object_children(**kwargs)
  1. See ListObjectChildrenRequestRequestTypeDef

list_object_parent_paths#

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.

Type annotations and code completion for boto3.client("clouddirectory").list_object_parent_paths method. boto3 documentation

# list_object_parent_paths method definition

def list_object_parent_paths(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListObjectParentPathsResponseTypeDef:  # (2)
    ...
  1. See ObjectReferenceTypeDef
  2. See ListObjectParentPathsResponseTypeDef 
# list_object_parent_paths method usage example with argument unpacking

kwargs: ListObjectParentPathsRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_object_parent_paths(**kwargs)
  1. See ListObjectParentPathsRequestRequestTypeDef

list_object_parents#

Lists parent objects that are associated with a given object in pagination fashion.

Type annotations and code completion for boto3.client("clouddirectory").list_object_parents method. boto3 documentation

# list_object_parents method definition

def list_object_parents(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
    IncludeAllLinksToEachParent: bool = ...,
) -> ListObjectParentsResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See ListObjectParentsResponseTypeDef 
# list_object_parents method usage example with argument unpacking

kwargs: ListObjectParentsRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_object_parents(**kwargs)
  1. See ListObjectParentsRequestRequestTypeDef

list_object_policies#

Returns policies attached to an object in pagination fashion.

Type annotations and code completion for boto3.client("clouddirectory").list_object_policies method. boto3 documentation

# list_object_policies method definition

def list_object_policies(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> ListObjectPoliciesResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See ListObjectPoliciesResponseTypeDef 
# list_object_policies method usage example with argument unpacking

kwargs: ListObjectPoliciesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_object_policies(**kwargs)
  1. See ListObjectPoliciesRequestRequestTypeDef

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.

Type annotations and code completion for boto3.client("clouddirectory").list_outgoing_typed_links method. boto3 documentation

# list_outgoing_typed_links method definition

def list_outgoing_typed_links(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    FilterAttributeRanges: Sequence[TypedLinkAttributeRangeTypeDef] = ...,  # (2)
    FilterTypedLink: TypedLinkSchemaAndFacetNameTypeDef = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (4)
) -> ListOutgoingTypedLinksResponseTypeDef:  # (5)
    ...
  1. See ObjectReferenceTypeDef
  2. See TypedLinkAttributeRangeTypeDef
  3. See TypedLinkSchemaAndFacetNameTypeDef
  4. See ConsistencyLevelType
  5. See ListOutgoingTypedLinksResponseTypeDef 
# list_outgoing_typed_links method usage example with argument unpacking

kwargs: ListOutgoingTypedLinksRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.list_outgoing_typed_links(**kwargs)
  1. See ListOutgoingTypedLinksRequestRequestTypeDef

list_policy_attachments#

Returns all of the ObjectIdentifiers to which a given policy is attached.

Type annotations and code completion for boto3.client("clouddirectory").list_policy_attachments method. boto3 documentation

# list_policy_attachments method definition

def list_policy_attachments(
    self,
    *,
    DirectoryArn: str,
    PolicyReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ConsistencyLevel: ConsistencyLevelType = ...,  # (2)
) -> ListPolicyAttachmentsResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ConsistencyLevelType
  3. See ListPolicyAttachmentsResponseTypeDef 
# list_policy_attachments method usage example with argument unpacking

kwargs: ListPolicyAttachmentsRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "PolicyReference": ...,
}

parent.list_policy_attachments(**kwargs)
  1. See ListPolicyAttachmentsRequestRequestTypeDef

list_published_schema_arns#

Lists the major version families of each published schema.

Type annotations and code completion for boto3.client("clouddirectory").list_published_schema_arns method. boto3 documentation

# list_published_schema_arns method definition

def list_published_schema_arns(
    self,
    *,
    SchemaArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPublishedSchemaArnsResponseTypeDef:  # (1)
    ...
  1. See ListPublishedSchemaArnsResponseTypeDef 
# list_published_schema_arns method usage example with argument unpacking

kwargs: ListPublishedSchemaArnsRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.list_published_schema_arns(**kwargs)
  1. See ListPublishedSchemaArnsRequestRequestTypeDef

list_tags_for_resource#

Returns tags for a resource.

Type annotations and code completion for boto3.client("clouddirectory").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.

Type annotations and code completion for boto3.client("clouddirectory").list_typed_link_facet_attributes method. boto3 documentation

# list_typed_link_facet_attributes method definition

def list_typed_link_facet_attributes(
    self,
    *,
    SchemaArn: str,
    Name: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTypedLinkFacetAttributesResponseTypeDef:  # (1)
    ...
  1. See ListTypedLinkFacetAttributesResponseTypeDef 
# list_typed_link_facet_attributes method usage example with argument unpacking

kwargs: ListTypedLinkFacetAttributesRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.list_typed_link_facet_attributes(**kwargs)
  1. See ListTypedLinkFacetAttributesRequestRequestTypeDef

Returns a paginated list of TypedLink facet names for a particular schema.

Type annotations and code completion for boto3.client("clouddirectory").list_typed_link_facet_names method. boto3 documentation

# list_typed_link_facet_names method definition

def list_typed_link_facet_names(
    self,
    *,
    SchemaArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTypedLinkFacetNamesResponseTypeDef:  # (1)
    ...
  1. See ListTypedLinkFacetNamesResponseTypeDef 
# list_typed_link_facet_names method usage example with argument unpacking

kwargs: ListTypedLinkFacetNamesRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
}

parent.list_typed_link_facet_names(**kwargs)
  1. See ListTypedLinkFacetNamesRequestRequestTypeDef

lookup_policy#

Lists all policies from the root of the Directory to the object specified.

Type annotations and code completion for boto3.client("clouddirectory").lookup_policy method. boto3 documentation

# lookup_policy method definition

def lookup_policy(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> LookupPolicyResponseTypeDef:  # (2)
    ...
  1. See ObjectReferenceTypeDef
  2. See LookupPolicyResponseTypeDef 
# lookup_policy method usage example with argument unpacking

kwargs: LookupPolicyRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
}

parent.lookup_policy(**kwargs)
  1. See LookupPolicyRequestRequestTypeDef

publish_schema#

Publishes a development schema with a major version and a recommended minor version.

Type annotations and code completion for boto3.client("clouddirectory").publish_schema method. boto3 documentation

# publish_schema method definition

def publish_schema(
    self,
    *,
    DevelopmentSchemaArn: str,
    Version: str,
    MinorVersion: str = ...,
    Name: str = ...,
) -> PublishSchemaResponseTypeDef:  # (1)
    ...
  1. See PublishSchemaResponseTypeDef 
# publish_schema method usage example with argument unpacking

kwargs: PublishSchemaRequestRequestTypeDef = {  # (1)
    "DevelopmentSchemaArn": ...,
    "Version": ...,
}

parent.publish_schema(**kwargs)
  1. See PublishSchemaRequestRequestTypeDef

put_schema_from_json#

Allows a schema to be updated using JSON upload.

Type annotations and code completion for boto3.client("clouddirectory").put_schema_from_json method. boto3 documentation

# put_schema_from_json method definition

def put_schema_from_json(
    self,
    *,
    SchemaArn: str,
    Document: str,
) -> PutSchemaFromJsonResponseTypeDef:  # (1)
    ...
  1. See PutSchemaFromJsonResponseTypeDef 
# put_schema_from_json method usage example with argument unpacking

kwargs: PutSchemaFromJsonRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Document": ...,
}

parent.put_schema_from_json(**kwargs)
  1. See PutSchemaFromJsonRequestRequestTypeDef

remove_facet_from_object#

Removes the specified facet from the specified object.

Type annotations and code completion for boto3.client("clouddirectory").remove_facet_from_object method. boto3 documentation

# remove_facet_from_object method definition

def remove_facet_from_object(
    self,
    *,
    DirectoryArn: str,
    SchemaFacet: SchemaFacetTypeDef,  # (1)
    ObjectReference: ObjectReferenceTypeDef,  # (2)
) -> Dict[str, Any]:
    ...
  1. See SchemaFacetTypeDef
  2. See ObjectReferenceTypeDef 
# remove_facet_from_object method usage example with argument unpacking

kwargs: RemoveFacetFromObjectRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "SchemaFacet": ...,
    "ObjectReference": ...,
}

parent.remove_facet_from_object(**kwargs)
  1. See RemoveFacetFromObjectRequestRequestTypeDef

tag_resource#

An API operation for adding tags to a resource.

Type annotations and code completion for boto3.client("clouddirectory").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

An API operation for removing tags from a resource.

Type annotations and code completion for boto3.client("clouddirectory").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_facet#

Does the following: * Adds new Attributes, Rules, or ObjectTypes.

Type annotations and code completion for boto3.client("clouddirectory").update_facet method. boto3 documentation

# update_facet method definition

def update_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
    AttributeUpdates: Sequence[FacetAttributeUpdateTypeDef] = ...,  # (1)
    ObjectType: ObjectTypeType = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See FacetAttributeUpdateTypeDef
  2. See ObjectTypeType 
# update_facet method usage example with argument unpacking

kwargs: UpdateFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.update_facet(**kwargs)
  1. See UpdateFacetRequestRequestTypeDef

Updates a given typed link's attributes.

Type annotations and code completion for boto3.client("clouddirectory").update_link_attributes method. boto3 documentation

# update_link_attributes method definition

def update_link_attributes(
    self,
    *,
    DirectoryArn: str,
    TypedLinkSpecifier: TypedLinkSpecifierTypeDef,  # (1)
    AttributeUpdates: Sequence[LinkAttributeUpdateTypeDef],  # (2)
) -> Dict[str, Any]:
    ...
  1. See TypedLinkSpecifierTypeDef
  2. See LinkAttributeUpdateTypeDef 
# update_link_attributes method usage example with argument unpacking

kwargs: UpdateLinkAttributesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "TypedLinkSpecifier": ...,
    "AttributeUpdates": ...,
}

parent.update_link_attributes(**kwargs)
  1. See UpdateLinkAttributesRequestRequestTypeDef

update_object_attributes#

Updates a given object's attributes.

Type annotations and code completion for boto3.client("clouddirectory").update_object_attributes method. boto3 documentation

# update_object_attributes method definition

def update_object_attributes(
    self,
    *,
    DirectoryArn: str,
    ObjectReference: ObjectReferenceTypeDef,  # (1)
    AttributeUpdates: Sequence[ObjectAttributeUpdateTypeDef],  # (2)
) -> UpdateObjectAttributesResponseTypeDef:  # (3)
    ...
  1. See ObjectReferenceTypeDef
  2. See ObjectAttributeUpdateTypeDef
  3. See UpdateObjectAttributesResponseTypeDef 
# update_object_attributes method usage example with argument unpacking

kwargs: UpdateObjectAttributesRequestRequestTypeDef = {  # (1)
    "DirectoryArn": ...,
    "ObjectReference": ...,
    "AttributeUpdates": ...,
}

parent.update_object_attributes(**kwargs)
  1. See UpdateObjectAttributesRequestRequestTypeDef

update_schema#

Updates the schema name with a new name.

Type annotations and code completion for boto3.client("clouddirectory").update_schema method. boto3 documentation

# update_schema method definition

def update_schema(
    self,
    *,
    SchemaArn: str,
    Name: str,
) -> UpdateSchemaResponseTypeDef:  # (1)
    ...
  1. See UpdateSchemaResponseTypeDef 
# update_schema method usage example with argument unpacking

kwargs: UpdateSchemaRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
}

parent.update_schema(**kwargs)
  1. See UpdateSchemaRequestRequestTypeDef

Updates a TypedLinkFacet.

Type annotations and code completion for boto3.client("clouddirectory").update_typed_link_facet method. boto3 documentation

# update_typed_link_facet method definition

def update_typed_link_facet(
    self,
    *,
    SchemaArn: str,
    Name: str,
    AttributeUpdates: Sequence[TypedLinkFacetAttributeUpdateTypeDef],  # (1)
    IdentityAttributeOrder: Sequence[str],
) -> Dict[str, Any]:
    ...
  1. See TypedLinkFacetAttributeUpdateTypeDef 
# update_typed_link_facet method usage example with argument unpacking

kwargs: UpdateTypedLinkFacetRequestRequestTypeDef = {  # (1)
    "SchemaArn": ...,
    "Name": ...,
    "AttributeUpdates": ...,
    "IdentityAttributeOrder": ...,
}

parent.update_typed_link_facet(**kwargs)
  1. See UpdateTypedLinkFacetRequestRequestTypeDef

upgrade_applied_schema#

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion.

Type annotations and code completion for boto3.client("clouddirectory").upgrade_applied_schema method. boto3 documentation

# upgrade_applied_schema method definition

def upgrade_applied_schema(
    self,
    *,
    PublishedSchemaArn: str,
    DirectoryArn: str,
    DryRun: bool = ...,
) -> UpgradeAppliedSchemaResponseTypeDef:  # (1)
    ...
  1. See UpgradeAppliedSchemaResponseTypeDef 
# upgrade_applied_schema method usage example with argument unpacking

kwargs: UpgradeAppliedSchemaRequestRequestTypeDef = {  # (1)
    "PublishedSchemaArn": ...,
    "DirectoryArn": ...,
}

parent.upgrade_applied_schema(**kwargs)
  1. See UpgradeAppliedSchemaRequestRequestTypeDef

upgrade_published_schema#

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Type annotations and code completion for boto3.client("clouddirectory").upgrade_published_schema method. boto3 documentation

# upgrade_published_schema method definition

def upgrade_published_schema(
    self,
    *,
    DevelopmentSchemaArn: str,
    PublishedSchemaArn: str,
    MinorVersion: str,
    DryRun: bool = ...,
) -> UpgradePublishedSchemaResponseTypeDef:  # (1)
    ...
  1. See UpgradePublishedSchemaResponseTypeDef 
# upgrade_published_schema method usage example with argument unpacking

kwargs: UpgradePublishedSchemaRequestRequestTypeDef = {  # (1)
    "DevelopmentSchemaArn": ...,
    "PublishedSchemaArn": ...,
    "MinorVersion": ...,
}

parent.upgrade_published_schema(**kwargs)
  1. See UpgradePublishedSchemaRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("clouddirectory").get_paginator method with overloads.