CloudDirectoryClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable
```
@Generated("software.amazon.awssdk:codegen")
public interface CloudDirectoryClient
extends AutoCloseable
```
Service client for accessing null. This can be created using the static builder() method. Amazon Cloud Directory
Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

Field Summary

Fields
Modifier and Type Field Description

static String SERVICE_NAME

Fields
Modifier and Type	Field	Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default AddFacetToObjectResponse`	`addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)`	Adds a new Facet to an object.
`default ApplySchemaResponse`	`applySchema(ApplySchemaRequest applySchemaRequest)`	Copies the input published schema into the Directory with the same name and version as that of the published schema .
`default AttachObjectResponse`	`attachObject(AttachObjectRequest attachObjectRequest)`	Attaches an existing object to another object.
`default AttachPolicyResponse`	`attachPolicy(AttachPolicyRequest attachPolicyRequest)`	Attaches a policy object to a regular object.
`default AttachToIndexResponse`	`attachToIndex(AttachToIndexRequest attachToIndexRequest)`	Attaches the specified object to the specified index.
`default AttachTypedLinkResponse`	`attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)`	Attaches a typed link to a specified source and target object.
`default BatchReadResponse`	`batchRead(BatchReadRequest batchReadRequest)`	Performs all the read operations in a batch.
`default BatchWriteResponse`	`batchWrite(BatchWriteRequest batchWriteRequest)`	Performs all the write operations in a batch.
`static CloudDirectoryClientBuilder`	`builder()`	Create a builder that can be used to configure and create a `CloudDirectoryClient`.
`static CloudDirectoryClient`	`create()`	Create a `CloudDirectoryClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CreateDirectoryResponse`	`createDirectory(CreateDirectoryRequest createDirectoryRequest)`	Creates a Directory by copying the published schema into the directory.
`default CreateFacetResponse`	`createFacet(CreateFacetRequest createFacetRequest)`	Creates a new Facet in a schema.
`default CreateIndexResponse`	`createIndex(CreateIndexRequest createIndexRequest)`	Creates an index object.
`default CreateObjectResponse`	`createObject(CreateObjectRequest createObjectRequest)`	Creates an object in a Directory.
`default CreateSchemaResponse`	`createSchema(CreateSchemaRequest createSchemaRequest)`	Creates a new schema in a development state.
`default CreateTypedLinkFacetResponse`	`createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest)`	Creates a TypedLinkFacet.
`default DeleteDirectoryResponse`	`deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)`	Deletes a directory.
`default DeleteFacetResponse`	`deleteFacet(DeleteFacetRequest deleteFacetRequest)`	Deletes a given Facet.
`default DeleteObjectResponse`	`deleteObject(DeleteObjectRequest deleteObjectRequest)`	Deletes an object and its associated attributes.
`default DeleteSchemaResponse`	`deleteSchema(DeleteSchemaRequest deleteSchemaRequest)`	Deletes a given schema.
`default DeleteTypedLinkFacetResponse`	`deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest)`	Deletes a TypedLinkFacet.
`default DetachFromIndexResponse`	`detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)`	Detaches the specified object from the specified index.
`default DetachObjectResponse`	`detachObject(DetachObjectRequest detachObjectRequest)`	Detaches a given object from the parent object.
`default DetachPolicyResponse`	`detachPolicy(DetachPolicyRequest detachPolicyRequest)`	Detaches a policy from an object.
`default DetachTypedLinkResponse`	`detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest)`	Detaches a typed link from a specified source and target object.
`default DisableDirectoryResponse`	`disableDirectory(DisableDirectoryRequest disableDirectoryRequest)`	Disables the specified directory.
`default EnableDirectoryResponse`	`enableDirectory(EnableDirectoryRequest enableDirectoryRequest)`	Enables the specified directory.
`default GetDirectoryResponse`	`getDirectory(GetDirectoryRequest getDirectoryRequest)`	Retrieves metadata about a directory.
`default GetFacetResponse`	`getFacet(GetFacetRequest getFacetRequest)`	Gets details of the Facet, such as facet name, attributes, Rules, or `ObjectType`.
`default GetObjectInformationResponse`	`getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)`	Retrieves metadata about an object.
`default GetSchemaAsJsonResponse`	`getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)`	Retrieves a JSON representation of the schema.
`default GetTypedLinkFacetInformationResponse`	`getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)`	Returns the identity attribute order for a specific TypedLinkFacet.
`default ListAppliedSchemaArnsResponse`	`listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)`	Lists schemas applied to a directory.
`default ListAttachedIndicesResponse`	`listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)`	Lists indices attached to an object.
`default ListDevelopmentSchemaArnsResponse`	`listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)`	Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
`default ListDirectoriesResponse`	`listDirectories(ListDirectoriesRequest listDirectoriesRequest)`	Lists directories created within an account.
`default ListFacetAttributesResponse`	`listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)`	Retrieves attributes attached to the facet.
`default ListFacetNamesResponse`	`listFacetNames(ListFacetNamesRequest listFacetNamesRequest)`	Retrieves the names of facets that exist in a schema.
`default ListIncomingTypedLinksResponse`	`listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest)`	Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
`default ListIndexResponse`	`listIndex(ListIndexRequest listIndexRequest)`	Lists objects attached to the specified index.
`default ListObjectAttributesResponse`	`listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)`	Lists all attributes that are associated with an object.
`default ListObjectChildrenResponse`	`listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)`	Returns a paginated list of child objects that are associated with a given object.
`default ListObjectParentPathsResponse`	`listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest)`	Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
`default ListObjectParentsResponse`	`listObjectParents(ListObjectParentsRequest listObjectParentsRequest)`	Lists parent objects that are associated with a given object in pagination fashion.
`default ListObjectPoliciesResponse`	`listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)`	Returns policies attached to an object in pagination fashion.
`default ListOutgoingTypedLinksResponse`	`listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest)`	Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
`default ListPolicyAttachmentsResponse`	`listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)`	Returns all of the `ObjectIdentifiers` to which a given policy is attached.
`default ListPublishedSchemaArnsResponse`	`listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)`	Retrieves each published schema Amazon Resource Name (ARN).
`default ListTagsForResourceResponse`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)`	Returns tags for a resource.
`default ListTypedLinkFacetAttributesResponse`	`listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)`	Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
`default ListTypedLinkFacetNamesResponse`	`listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)`	Returns a paginated list of `TypedLink` facet names for a particular schema.
`default LookupPolicyResponse`	`lookupPolicy(LookupPolicyRequest lookupPolicyRequest)`	Lists all policies from the root of the Directory to the object specified.
`default PublishSchemaResponse`	`publishSchema(PublishSchemaRequest publishSchemaRequest)`	Publishes a development schema with a version.
`default PutSchemaFromJsonResponse`	`putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)`	Allows a schema to be updated using JSON upload.
`default RemoveFacetFromObjectResponse`	`removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)`	Removes the specified facet from the specified object.
`static ServiceMetadata`	`serviceMetadata()`
`default TagResourceResponse`	`tagResource(TagResourceRequest tagResourceRequest)`	An API operation for adding tags to a resource.
`default UntagResourceResponse`	`untagResource(UntagResourceRequest untagResourceRequest)`	An API operation for removing tags from a resource.
`default UpdateFacetResponse`	`updateFacet(UpdateFacetRequest updateFacetRequest)`	Does the following:
`default UpdateObjectAttributesResponse`	`updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)`	Updates a given object's attributes.
`default UpdateSchemaResponse`	`updateSchema(UpdateSchemaRequest updateSchemaRequest)`	Updates the schema name with a new name.
`default UpdateTypedLinkFacetResponse`	`updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest)`	Updates a TypedLinkFacet.

Methods inherited from interface java.lang.AutoCloseable
close

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
static CloudDirectoryClient create()
```
    Create a CloudDirectoryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static CloudDirectoryClientBuilder builder()
```
    Create a builder that can be used to configure and create a CloudDirectoryClient.
  - addFacetToObject
```
default AddFacetToObjectResponse addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)
                                           throws InternalServiceException,
                                                  InvalidArnException,
                                                  RetryableConflictException,
                                                  ValidationException,
                                                  LimitExceededException,
                                                  AccessDeniedException,
                                                  DirectoryNotEnabledException,
                                                  ResourceNotFoundException,
                                                  FacetValidationException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CloudDirectoryException
```
    Adds a new Facet to an object.
    
    Parameters:
    
    addFacetToObjectRequest -
    
    Returns:
    
    Result of the AddFacetToObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - applySchema
```
default ApplySchemaResponse applySchema(ApplySchemaRequest applySchemaRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        InvalidAttachmentException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    Copies the input published schema into the Directory with the same name and version as that of the published schema .
    
    Parameters:
    
    applySchemaRequest -
    
    Returns:
    
    Result of the ApplySchema operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - attachObject
```
default AttachObjectResponse attachObject(AttachObjectRequest attachObjectRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          LinkNameAlreadyInUseException,
                                          InvalidAttachmentException,
                                          FacetValidationException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Attaches an existing object to another object. An object can be accessed in two ways:
    1. Using the path
    2. Using ObjectIdentifier
    Parameters:
    
    attachObjectRequest -
    
    Returns:
    
    Result of the AttachObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
    
    InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - attachPolicy
```
default AttachPolicyResponse attachPolicy(AttachPolicyRequest attachPolicyRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          NotPolicyException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Attaches a policy object to a regular object. An object can have a limited number of attached policies.
    
    Parameters:
    
    attachPolicyRequest -
    
    Returns:
    
    Result of the AttachPolicy operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    NotPolicyException - Indicates that the requested operation can only operate on policy objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - attachToIndex
```
default AttachToIndexResponse attachToIndex(AttachToIndexRequest attachToIndexRequest)
                                     throws InternalServiceException,
                                            InvalidArnException,
                                            RetryableConflictException,
                                            ValidationException,
                                            LimitExceededException,
                                            AccessDeniedException,
                                            DirectoryNotEnabledException,
                                            ResourceNotFoundException,
                                            LinkNameAlreadyInUseException,
                                            IndexedAttributeMissingException,
                                            NotIndexException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CloudDirectoryException
```
    Attaches the specified object to the specified index.
    
    Parameters:
    
    attachToIndexRequest -
    
    Returns:
    
    Result of the AttachToIndex operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
    
    IndexedAttributeMissingException - An object has been attempted to be attached to an object that does not have the appropriate attribute value.
    
    NotIndexException - Indicates that the requested operation can only operate on index objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - attachTypedLink
```
default AttachTypedLinkResponse attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                ResourceNotFoundException,
                                                InvalidAttachmentException,
                                                FacetValidationException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Attaches a typed link to a specified source and target object. For more information, see Typed link.
    
    Parameters:
    
    attachTypedLinkRequest -
    
    Returns:
    
    Result of the AttachTypedLink operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - batchRead
```
default BatchReadResponse batchRead(BatchReadRequest batchReadRequest)
                             throws InternalServiceException,
                                    InvalidArnException,
                                    RetryableConflictException,
                                    ValidationException,
                                    LimitExceededException,
                                    AccessDeniedException,
                                    DirectoryNotEnabledException,
                                    SdkBaseException,
                                    SdkClientException,
                                    CloudDirectoryException
```
    Performs all the read operations in a batch.
    
    Parameters:
    
    batchReadRequest -
    
    Returns:
    
    Result of the BatchRead operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - batchWrite
```
default BatchWriteResponse batchWrite(BatchWriteRequest batchWriteRequest)
                               throws InternalServiceException,
                                      InvalidArnException,
                                      RetryableConflictException,
                                      ValidationException,
                                      LimitExceededException,
                                      AccessDeniedException,
                                      DirectoryNotEnabledException,
                                      BatchWriteException,
                                      SdkBaseException,
                                      SdkClientException,
                                      CloudDirectoryException
```
    Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.
    
    Parameters:
    
    batchWriteRequest -
    
    Returns:
    
    Result of the BatchWrite operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    BatchWriteException - A BatchWrite exception has occurred.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createDirectory
```
default CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                DirectoryAlreadyExistsException,
                                                ResourceNotFoundException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
    
    Parameters:
    
    createDirectoryRequest -
    
    Returns:
    
    Result of the CreateDirectory operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryAlreadyExistsException - Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createFacet
```
default CreateFacetResponse createFacet(CreateFacetRequest createFacetRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        FacetAlreadyExistsException,
                                        InvalidRuleException,
                                        FacetValidationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
    
    Parameters:
    
    createFacetRequest -
    
    Returns:
    
    Result of the CreateFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetAlreadyExistsException - A facet with the same name already exists.
    
    InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        DirectoryNotEnabledException,
                                        ResourceNotFoundException,
                                        FacetValidationException,
                                        LinkNameAlreadyInUseException,
                                        UnsupportedIndexTypeException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    Creates an index object. See Indexing for more information.
    
    Parameters:
    
    createIndexRequest -
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
    
    UnsupportedIndexTypeException - Indicates that the requested index type is not supported.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createObject
```
default CreateObjectResponse createObject(CreateObjectRequest createObjectRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          FacetValidationException,
                                          LinkNameAlreadyInUseException,
                                          UnsupportedIndexTypeException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.
    
    Parameters:
    
    createObjectRequest -
    
    Returns:
    
    Result of the CreateObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
    
    UnsupportedIndexTypeException - Indicates that the requested index type is not supported.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createSchema
```
default CreateSchemaResponse createSchema(CreateSchemaRequest createSchemaRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          SchemaAlreadyExistsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Creates a new schema in a development state. A schema can exist in three phases:
    - Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
    - Published: Published schemas are immutable and have a version associated with them.
    - Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.
    Parameters:
    
    createSchemaRequest -
    
    Returns:
    
    Result of the CreateSchema operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    SchemaAlreadyExistsException - Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - createTypedLinkFacet
```
default CreateTypedLinkFacetResponse createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest)
                                                   throws InternalServiceException,
                                                          InvalidArnException,
                                                          RetryableConflictException,
                                                          ValidationException,
                                                          LimitExceededException,
                                                          AccessDeniedException,
                                                          ResourceNotFoundException,
                                                          FacetAlreadyExistsException,
                                                          InvalidRuleException,
                                                          FacetValidationException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          CloudDirectoryException
```
    Creates a TypedLinkFacet. For more information, see Typed link.
    
    Parameters:
    
    createTypedLinkFacetRequest -
    
    Returns:
    
    Result of the CreateTypedLinkFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetAlreadyExistsException - A facet with the same name already exists.
    
    InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - deleteDirectory
```
default DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
                                         throws ResourceNotFoundException,
                                                DirectoryNotDisabledException,
                                                InternalServiceException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                DirectoryDeletedException,
                                                RetryableConflictException,
                                                InvalidArnException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
    
    Parameters:
    
    deleteDirectoryRequest -
    
    Returns:
    
    Result of the DeleteDirectory operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    DirectoryNotDisabledException - An operation can only operate on a disabled directory.
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - deleteFacet
```
default DeleteFacetResponse deleteFacet(DeleteFacetRequest deleteFacetRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        FacetNotFoundException,
                                        FacetInUseException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
    
    Parameters:
    
    deleteFacetRequest -
    
    Returns:
    
    Result of the DeleteFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    FacetInUseException - Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - deleteObject
```
default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          ObjectNotDetachedException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.
    
    Parameters:
    
    deleteObjectRequest -
    
    Returns:
    
    Result of the DeleteObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    ObjectNotDetachedException - Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - deleteSchema
```
default DeleteSchemaResponse deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          ResourceNotFoundException,
                                          StillContainsLinksException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Deletes a given schema. Schemas in a development and published state can only be deleted.
    
    Parameters:
    
    deleteSchemaRequest -
    
    Returns:
    
    Result of the DeleteSchema operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    StillContainsLinksException - The object could not be deleted because links still exist. Remove the links and then try the operation again.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - deleteTypedLinkFacet
```
default DeleteTypedLinkFacetResponse deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest)
                                                   throws InternalServiceException,
                                                          InvalidArnException,
                                                          RetryableConflictException,
                                                          ValidationException,
                                                          LimitExceededException,
                                                          AccessDeniedException,
                                                          ResourceNotFoundException,
                                                          FacetNotFoundException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          CloudDirectoryException
```
    Deletes a TypedLinkFacet. For more information, see Typed link.
    
    Parameters:
    
    deleteTypedLinkFacetRequest -
    
    Returns:
    
    Result of the DeleteTypedLinkFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - detachFromIndex
```
default DetachFromIndexResponse detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                DirectoryNotEnabledException,
                                                ResourceNotFoundException,
                                                ObjectAlreadyDetachedException,
                                                NotIndexException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Detaches the specified object from the specified index.
    
    Parameters:
    
    detachFromIndexRequest -
    
    Returns:
    
    Result of the DetachFromIndex operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    ObjectAlreadyDetachedException - Indicates that the object is not attached to the index.
    
    NotIndexException - Indicates that the requested operation can only operate on index objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - detachObject
```
default DetachObjectResponse detachObject(DetachObjectRequest detachObjectRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
    
    Parameters:
    
    detachObjectRequest -
    
    Returns:
    
    Result of the DetachObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - detachPolicy
```
default DetachPolicyResponse detachPolicy(DetachPolicyRequest detachPolicyRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          ResourceNotFoundException,
                                          NotPolicyException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Detaches a policy from an object.
    
    Parameters:
    
    detachPolicyRequest -
    
    Returns:
    
    Result of the DetachPolicy operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    NotPolicyException - Indicates that the requested operation can only operate on policy objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - detachTypedLink
```
default DetachTypedLinkResponse detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                ResourceNotFoundException,
                                                FacetValidationException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Detaches a typed link from a specified source and target object. For more information, see Typed link.
    
    Parameters:
    
    detachTypedLinkRequest -
    
    Returns:
    
    Result of the DetachTypedLink operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - disableDirectory
```
default DisableDirectoryResponse disableDirectory(DisableDirectoryRequest disableDirectoryRequest)
                                           throws ResourceNotFoundException,
                                                  DirectoryDeletedException,
                                                  InternalServiceException,
                                                  ValidationException,
                                                  LimitExceededException,
                                                  AccessDeniedException,
                                                  RetryableConflictException,
                                                  InvalidArnException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CloudDirectoryException
```
    Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
    
    Parameters:
    
    disableDirectoryRequest -
    
    Returns:
    
    Result of the DisableDirectory operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - enableDirectory
```
default EnableDirectoryResponse enableDirectory(EnableDirectoryRequest enableDirectoryRequest)
                                         throws ResourceNotFoundException,
                                                DirectoryDeletedException,
                                                InternalServiceException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                RetryableConflictException,
                                                InvalidArnException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
    
    Parameters:
    
    enableDirectoryRequest -
    
    Returns:
    
    Result of the EnableDirectory operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource could not be found.
    
    DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - getDirectory
```
default GetDirectoryResponse getDirectory(GetDirectoryRequest getDirectoryRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Retrieves metadata about a directory.
    
    Parameters:
    
    getDirectoryRequest -
    
    Returns:
    
    Result of the GetDirectory operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - getFacet
```
default GetFacetResponse getFacet(GetFacetRequest getFacetRequest)
                           throws InternalServiceException,
                                  InvalidArnException,
                                  RetryableConflictException,
                                  ValidationException,
                                  LimitExceededException,
                                  AccessDeniedException,
                                  ResourceNotFoundException,
                                  FacetNotFoundException,
                                  SdkBaseException,
                                  SdkClientException,
                                  CloudDirectoryException
```
    Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.
    
    Parameters:
    
    getFacetRequest -
    
    Returns:
    
    Result of the GetFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - getObjectInformation
```
default GetObjectInformationResponse getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)
                                                   throws InternalServiceException,
                                                          InvalidArnException,
                                                          RetryableConflictException,
                                                          ValidationException,
                                                          LimitExceededException,
                                                          AccessDeniedException,
                                                          DirectoryNotEnabledException,
                                                          ResourceNotFoundException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          CloudDirectoryException
```
    Retrieves metadata about an object.
    
    Parameters:
    
    getObjectInformationRequest -
    
    Returns:
    
    Result of the GetObjectInformation operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - getSchemaAsJson
```
default GetSchemaAsJsonResponse getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                ResourceNotFoundException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
    
    Parameters:
    
    getSchemaAsJsonRequest -
    
    Returns:
    
    Result of the GetSchemaAsJson operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - getTypedLinkFacetInformation
```
default GetTypedLinkFacetInformationResponse getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)
                                                                   throws InternalServiceException,
                                                                          InvalidArnException,
                                                                          RetryableConflictException,
                                                                          ValidationException,
                                                                          LimitExceededException,
                                                                          AccessDeniedException,
                                                                          ResourceNotFoundException,
                                                                          InvalidNextTokenException,
                                                                          FacetNotFoundException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          CloudDirectoryException
```
    Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.
    
    Parameters:
    
    getTypedLinkFacetInformationRequest -
    
    Returns:
    
    Result of the GetTypedLinkFacetInformation operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listAppliedSchemaArns
```
default ListAppliedSchemaArnsResponse listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
                                                     throws InternalServiceException,
                                                            InvalidArnException,
                                                            RetryableConflictException,
                                                            ValidationException,
                                                            LimitExceededException,
                                                            AccessDeniedException,
                                                            ResourceNotFoundException,
                                                            InvalidNextTokenException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            CloudDirectoryException
```
    Lists schemas applied to a directory.
    
    Parameters:
    
    listAppliedSchemaArnsRequest -
    
    Returns:
    
    Result of the ListAppliedSchemaArns operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listAttachedIndices
```
default ListAttachedIndicesResponse listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
                                                 throws InternalServiceException,
                                                        InvalidArnException,
                                                        RetryableConflictException,
                                                        ValidationException,
                                                        LimitExceededException,
                                                        AccessDeniedException,
                                                        DirectoryNotEnabledException,
                                                        ResourceNotFoundException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CloudDirectoryException
```
    Lists indices attached to an object.
    
    Parameters:
    
    listAttachedIndicesRequest -
    
    Returns:
    
    Result of the ListAttachedIndices operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listDevelopmentSchemaArns
```
default ListDevelopmentSchemaArnsResponse listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
                                                             throws InternalServiceException,
                                                                    InvalidArnException,
                                                                    RetryableConflictException,
                                                                    ValidationException,
                                                                    LimitExceededException,
                                                                    AccessDeniedException,
                                                                    ResourceNotFoundException,
                                                                    InvalidNextTokenException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    CloudDirectoryException
```
    Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
    
    Parameters:
    
    listDevelopmentSchemaArnsRequest -
    
    Returns:
    
    Result of the ListDevelopmentSchemaArns operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listDirectories
```
default ListDirectoriesResponse listDirectories(ListDirectoriesRequest listDirectoriesRequest)
                                         throws InternalServiceException,
                                                InvalidArnException,
                                                RetryableConflictException,
                                                ValidationException,
                                                LimitExceededException,
                                                AccessDeniedException,
                                                InvalidNextTokenException,
                                                SdkBaseException,
                                                SdkClientException,
                                                CloudDirectoryException
```
    Lists directories created within an account.
    
    Parameters:
    
    listDirectoriesRequest -
    
    Returns:
    
    Result of the ListDirectories operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listFacetAttributes
```
default ListFacetAttributesResponse listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)
                                                 throws InternalServiceException,
                                                        InvalidArnException,
                                                        RetryableConflictException,
                                                        ValidationException,
                                                        LimitExceededException,
                                                        AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        FacetNotFoundException,
                                                        InvalidNextTokenException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CloudDirectoryException
```
    Retrieves attributes attached to the facet.
    
    Parameters:
    
    listFacetAttributesRequest -
    
    Returns:
    
    Result of the ListFacetAttributes operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listFacetNames
```
default ListFacetNamesResponse listFacetNames(ListFacetNamesRequest listFacetNamesRequest)
                                       throws InternalServiceException,
                                              InvalidArnException,
                                              RetryableConflictException,
                                              ValidationException,
                                              LimitExceededException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              InvalidNextTokenException,
                                              SdkBaseException,
                                              SdkClientException,
                                              CloudDirectoryException
```
    Retrieves the names of facets that exist in a schema.
    
    Parameters:
    
    listFacetNamesRequest -
    
    Returns:
    
    Result of the ListFacetNames operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listIncomingTypedLinks
```
default ListIncomingTypedLinksResponse listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest)
                                                       throws InternalServiceException,
                                                              InvalidArnException,
                                                              RetryableConflictException,
                                                              ValidationException,
                                                              LimitExceededException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              InvalidNextTokenException,
                                                              FacetValidationException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CloudDirectoryException
```
    Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.
    
    Parameters:
    
    listIncomingTypedLinksRequest -
    
    Returns:
    
    Result of the ListIncomingTypedLinks operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listIndex
```
default ListIndexResponse listIndex(ListIndexRequest listIndexRequest)
                             throws InternalServiceException,
                                    InvalidArnException,
                                    RetryableConflictException,
                                    ValidationException,
                                    LimitExceededException,
                                    AccessDeniedException,
                                    DirectoryNotEnabledException,
                                    ResourceNotFoundException,
                                    NotIndexException,
                                    SdkBaseException,
                                    SdkClientException,
                                    CloudDirectoryException
```
    Lists objects attached to the specified index.
    
    Parameters:
    
    listIndexRequest -
    
    Returns:
    
    Result of the ListIndex operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    NotIndexException - Indicates that the requested operation can only operate on index objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listObjectAttributes
```
default ListObjectAttributesResponse listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)
                                                   throws InternalServiceException,
                                                          InvalidArnException,
                                                          RetryableConflictException,
                                                          ValidationException,
                                                          LimitExceededException,
                                                          AccessDeniedException,
                                                          DirectoryNotEnabledException,
                                                          ResourceNotFoundException,
                                                          InvalidNextTokenException,
                                                          FacetValidationException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          CloudDirectoryException
```
    Lists all attributes that are associated with an object.
    
    Parameters:
    
    listObjectAttributesRequest -
    
    Returns:
    
    Result of the ListObjectAttributes operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listObjectChildren
```
default ListObjectChildrenResponse listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)
                                               throws InternalServiceException,
                                                      InvalidArnException,
                                                      RetryableConflictException,
                                                      ValidationException,
                                                      LimitExceededException,
                                                      AccessDeniedException,
                                                      DirectoryNotEnabledException,
                                                      ResourceNotFoundException,
                                                      InvalidNextTokenException,
                                                      NotNodeException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      CloudDirectoryException
```
    Returns a paginated list of child objects that are associated with a given object.
    
    Parameters:
    
    listObjectChildrenRequest -
    
    Returns:
    
    Result of the ListObjectChildren operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    NotNodeException - Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listObjectParentPaths
```
default ListObjectParentPathsResponse listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest)
                                                     throws InternalServiceException,
                                                            InvalidArnException,
                                                            RetryableConflictException,
                                                            ValidationException,
                                                            LimitExceededException,
                                                            AccessDeniedException,
                                                            DirectoryNotEnabledException,
                                                            InvalidNextTokenException,
                                                            ResourceNotFoundException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            CloudDirectoryException
```
    Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.
    
    Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.
    
    Parameters:
    
    listObjectParentPathsRequest -
    
    Returns:
    
    Result of the ListObjectParentPaths operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listObjectParents
```
default ListObjectParentsResponse listObjectParents(ListObjectParentsRequest listObjectParentsRequest)
                                             throws InternalServiceException,
                                                    InvalidArnException,
                                                    RetryableConflictException,
                                                    ValidationException,
                                                    LimitExceededException,
                                                    AccessDeniedException,
                                                    DirectoryNotEnabledException,
                                                    ResourceNotFoundException,
                                                    InvalidNextTokenException,
                                                    CannotListParentOfRootException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CloudDirectoryException
```
    Lists parent objects that are associated with a given object in pagination fashion.
    
    Parameters:
    
    listObjectParentsRequest -
    
    Returns:
    
    Result of the ListObjectParents operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    CannotListParentOfRootException - Cannot list the parents of a Directory root.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listObjectPolicies
```
default ListObjectPoliciesResponse listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)
                                               throws InternalServiceException,
                                                      InvalidArnException,
                                                      RetryableConflictException,
                                                      ValidationException,
                                                      LimitExceededException,
                                                      AccessDeniedException,
                                                      DirectoryNotEnabledException,
                                                      ResourceNotFoundException,
                                                      InvalidNextTokenException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      CloudDirectoryException
```
    Returns policies attached to an object in pagination fashion.
    
    Parameters:
    
    listObjectPoliciesRequest -
    
    Returns:
    
    Result of the ListObjectPolicies operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listOutgoingTypedLinks
```
default ListOutgoingTypedLinksResponse listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest)
                                                       throws InternalServiceException,
                                                              InvalidArnException,
                                                              RetryableConflictException,
                                                              ValidationException,
                                                              LimitExceededException,
                                                              AccessDeniedException,
                                                              ResourceNotFoundException,
                                                              InvalidNextTokenException,
                                                              FacetValidationException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CloudDirectoryException
```
    Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.
    
    Parameters:
    
    listOutgoingTypedLinksRequest -
    
    Returns:
    
    Result of the ListOutgoingTypedLinks operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listPolicyAttachments
```
default ListPolicyAttachmentsResponse listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
                                                     throws InternalServiceException,
                                                            InvalidArnException,
                                                            RetryableConflictException,
                                                            ValidationException,
                                                            LimitExceededException,
                                                            AccessDeniedException,
                                                            DirectoryNotEnabledException,
                                                            InvalidNextTokenException,
                                                            ResourceNotFoundException,
                                                            NotPolicyException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            CloudDirectoryException
```
    Returns all of the ObjectIdentifiers to which a given policy is attached.
    
    Parameters:
    
    listPolicyAttachmentsRequest -
    
    Returns:
    
    Result of the ListPolicyAttachments operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    NotPolicyException - Indicates that the requested operation can only operate on policy objects.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listPublishedSchemaArns
```
default ListPublishedSchemaArnsResponse listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
                                                         throws InternalServiceException,
                                                                InvalidArnException,
                                                                RetryableConflictException,
                                                                ValidationException,
                                                                LimitExceededException,
                                                                AccessDeniedException,
                                                                ResourceNotFoundException,
                                                                InvalidNextTokenException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                CloudDirectoryException
```
    Retrieves each published schema Amazon Resource Name (ARN).
    
    Parameters:
    
    listPublishedSchemaArnsRequest -
    
    Returns:
    
    Result of the ListPublishedSchemaArns operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServiceException,
                                                        InvalidArnException,
                                                        RetryableConflictException,
                                                        ValidationException,
                                                        LimitExceededException,
                                                        AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        InvalidTaggingRequestException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CloudDirectoryException
```
    Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listTypedLinkFacetAttributes
```
default ListTypedLinkFacetAttributesResponse listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)
                                                                   throws InternalServiceException,
                                                                          InvalidArnException,
                                                                          RetryableConflictException,
                                                                          ValidationException,
                                                                          LimitExceededException,
                                                                          AccessDeniedException,
                                                                          ResourceNotFoundException,
                                                                          FacetNotFoundException,
                                                                          InvalidNextTokenException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          CloudDirectoryException
```
    Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.
    
    Parameters:
    
    listTypedLinkFacetAttributesRequest -
    
    Returns:
    
    Result of the ListTypedLinkFacetAttributes operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - listTypedLinkFacetNames
```
default ListTypedLinkFacetNamesResponse listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)
                                                         throws InternalServiceException,
                                                                InvalidArnException,
                                                                RetryableConflictException,
                                                                ValidationException,
                                                                LimitExceededException,
                                                                AccessDeniedException,
                                                                ResourceNotFoundException,
                                                                InvalidNextTokenException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                CloudDirectoryException
```
    Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link.
    
    Parameters:
    
    listTypedLinkFacetNamesRequest -
    
    Returns:
    
    Result of the ListTypedLinkFacetNames operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - lookupPolicy
```
default LookupPolicyResponse lookupPolicy(LookupPolicyRequest lookupPolicyRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          DirectoryNotEnabledException,
                                          InvalidNextTokenException,
                                          ResourceNotFoundException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.
    
    Parameters:
    
    lookupPolicyRequest -
    
    Returns:
    
    Result of the LookupPolicy operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    InvalidNextTokenException - Indicates that the NextToken value is not valid.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - publishSchema
```
default PublishSchemaResponse publishSchema(PublishSchemaRequest publishSchemaRequest)
                                     throws InternalServiceException,
                                            InvalidArnException,
                                            RetryableConflictException,
                                            ValidationException,
                                            LimitExceededException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            SchemaAlreadyPublishedException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CloudDirectoryException
```
    Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.
    
    Parameters:
    
    publishSchemaRequest -
    
    Returns:
    
    Result of the PublishSchema operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SchemaAlreadyPublishedException - Indicates that a schema is already published.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - putSchemaFromJson
```
default PutSchemaFromJsonResponse putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)
                                             throws InternalServiceException,
                                                    InvalidArnException,
                                                    RetryableConflictException,
                                                    ValidationException,
                                                    LimitExceededException,
                                                    AccessDeniedException,
                                                    InvalidSchemaDocException,
                                                    InvalidRuleException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CloudDirectoryException
```
    Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
    
    Parameters:
    
    putSchemaFromJsonRequest -
    
    Returns:
    
    Result of the PutSchemaFromJson operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    InvalidSchemaDocException - Indicates that the provided SchemaDoc value is not valid.
    
    InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - removeFacetFromObject
```
default RemoveFacetFromObjectResponse removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)
                                                     throws InternalServiceException,
                                                            InvalidArnException,
                                                            RetryableConflictException,
                                                            ValidationException,
                                                            LimitExceededException,
                                                            AccessDeniedException,
                                                            DirectoryNotEnabledException,
                                                            ResourceNotFoundException,
                                                            FacetValidationException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            CloudDirectoryException
```
    Removes the specified facet from the specified object.
    
    Parameters:
    
    removeFacetFromObjectRequest -
    
    Returns:
    
    Result of the RemoveFacetFromObject operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        ResourceNotFoundException,
                                        InvalidTaggingRequestException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    An API operation for adding tags to a resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServiceException,
                                            InvalidArnException,
                                            RetryableConflictException,
                                            ValidationException,
                                            LimitExceededException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            InvalidTaggingRequestException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CloudDirectoryException
```
    An API operation for removing tags from a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - updateFacet
```
default UpdateFacetResponse updateFacet(UpdateFacetRequest updateFacetRequest)
                                 throws InternalServiceException,
                                        InvalidArnException,
                                        RetryableConflictException,
                                        ValidationException,
                                        LimitExceededException,
                                        AccessDeniedException,
                                        InvalidFacetUpdateException,
                                        ResourceNotFoundException,
                                        FacetNotFoundException,
                                        InvalidRuleException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudDirectoryException
```
    Does the following:
    1. Adds new Attributes, Rules, or ObjectTypes.
    2. Updates existing Attributes, Rules, or ObjectTypes.
    3. Deletes existing Attributes, Rules, or ObjectTypes.
    Parameters:
    
    updateFacetRequest -
    
    Returns:
    
    Result of the UpdateFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    InvalidFacetUpdateException - An attempt to modify a Facet resulted in an invalid schema exception.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - updateObjectAttributes
```
default UpdateObjectAttributesResponse updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)
                                                       throws InternalServiceException,
                                                              InvalidArnException,
                                                              RetryableConflictException,
                                                              ValidationException,
                                                              LimitExceededException,
                                                              AccessDeniedException,
                                                              DirectoryNotEnabledException,
                                                              ResourceNotFoundException,
                                                              FacetValidationException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CloudDirectoryException
```
    Updates a given object's attributes.
    
    Parameters:
    
    updateObjectAttributesRequest -
    
    Returns:
    
    Result of the UpdateObjectAttributes operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - updateSchema
```
default UpdateSchemaResponse updateSchema(UpdateSchemaRequest updateSchemaRequest)
                                   throws InternalServiceException,
                                          InvalidArnException,
                                          RetryableConflictException,
                                          ValidationException,
                                          LimitExceededException,
                                          AccessDeniedException,
                                          ResourceNotFoundException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudDirectoryException
```
    Updates the schema name with a new name. Only development schema names can be updated.
    
    Parameters:
    
    updateSchemaRequest -
    
    Returns:
    
    Result of the UpdateSchema operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - updateTypedLinkFacet
```
default UpdateTypedLinkFacetResponse updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest)
                                                   throws InternalServiceException,
                                                          InvalidArnException,
                                                          RetryableConflictException,
                                                          ValidationException,
                                                          LimitExceededException,
                                                          AccessDeniedException,
                                                          FacetValidationException,
                                                          InvalidFacetUpdateException,
                                                          ResourceNotFoundException,
                                                          FacetNotFoundException,
                                                          InvalidRuleException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          CloudDirectoryException
```
    Updates a TypedLinkFacet. For more information, see Typed link.
    
    Parameters:
    
    updateTypedLinkFacetRequest -
    
    Returns:
    
    Result of the UpdateTypedLinkFacet operation returned by the service.
    
    Throws:
    
    InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
    
    InvalidArnException - Indicates that the provided ARN value is not valid.
    
    RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
    
    ValidationException - Indicates that your request is malformed in some manner. See the exception message.
    
    LimitExceededException - Indicates that limits are exceeded. See Limits for more information.
    
    AccessDeniedException - Access denied. Check your permissions.
    
    FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.
    
    InvalidFacetUpdateException - An attempt to modify a Facet resulted in an invalid schema exception.
    
    ResourceNotFoundException - The specified resource could not be found.
    
    FacetNotFoundException - The specified Facet could not be found.
    
    InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.
    
    SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)
    
    CloudDirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type
    
    See Also:
    
    AWS API Documentation
  - serviceMetadata
```
static ServiceMetadata serviceMetadata()
```

Interface CloudDirectoryClient

Field Summary

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE_NAME

Method Detail

create

builder

addFacetToObject

applySchema

attachObject

attachPolicy

attachToIndex

attachTypedLink

batchRead

batchWrite

createDirectory

createFacet

createIndex

createObject

createSchema

createTypedLinkFacet

deleteDirectory

deleteFacet

deleteObject

deleteSchema

deleteTypedLinkFacet

detachFromIndex

detachObject

detachPolicy

detachTypedLink

disableDirectory

enableDirectory

getDirectory

getFacet

getObjectInformation

getSchemaAsJson

getTypedLinkFacetInformation

listAppliedSchemaArns

listAttachedIndices

listDevelopmentSchemaArns

listDirectories

listFacetAttributes

listFacetNames

listIncomingTypedLinks

listIndex

listObjectAttributes

listObjectChildren

listObjectParentPaths

listObjectParents

listObjectPolicies

listOutgoingTypedLinks

listPolicyAttachments

listPublishedSchemaArns

listTagsForResource

listTypedLinkFacetAttributes

listTypedLinkFacetNames

lookupPolicy

publishSchema

putSchemaFromJson

removeFacetFromObject

tagResource

untagResource

updateFacet

updateObjectAttributes

updateSchema

updateTypedLinkFacet

serviceMetadata