@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudDirectoryClient extends AmazonWebServiceClient implements AmazonCloudDirectory
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 Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonCloudDirectoryClient()
Deprecated.
|
AmazonCloudDirectoryClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonCloudDirectoryClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonCloudDirectoryClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonCloudDirectoryClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddFacetToObjectResult |
addFacetToObject(AddFacetToObjectRequest request)
Adds a new Facet to an object.
|
ApplySchemaResult |
applySchema(ApplySchemaRequest request)
Copies the input published schema, at the specified version, into the Directory with the same name and
version as that of the published schema.
|
AttachObjectResult |
attachObject(AttachObjectRequest request)
Attaches an existing object to another object.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest request)
Attaches a policy object to a regular object.
|
AttachToIndexResult |
attachToIndex(AttachToIndexRequest request)
Attaches the specified object to the specified index.
|
AttachTypedLinkResult |
attachTypedLink(AttachTypedLinkRequest request)
Attaches a typed link to a specified source and target object.
|
BatchReadResult |
batchRead(BatchReadRequest request)
Performs all the read operations in a batch.
|
BatchWriteResult |
batchWrite(BatchWriteRequest request)
Performs all the write operations in a batch.
|
static AmazonCloudDirectoryClientBuilder |
builder() |
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest request)
Creates a Directory by copying the published schema into the directory.
|
CreateFacetResult |
createFacet(CreateFacetRequest request)
Creates a new Facet in a schema.
|
CreateIndexResult |
createIndex(CreateIndexRequest request)
Creates an index object.
|
CreateObjectResult |
createObject(CreateObjectRequest request)
Creates an object in a Directory.
|
CreateSchemaResult |
createSchema(CreateSchemaRequest request)
Creates a new schema in a development state.
|
CreateTypedLinkFacetResult |
createTypedLinkFacet(CreateTypedLinkFacetRequest request)
Creates a TypedLinkFacet.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest request)
Deletes a directory.
|
DeleteFacetResult |
deleteFacet(DeleteFacetRequest request)
Deletes a given Facet.
|
DeleteObjectResult |
deleteObject(DeleteObjectRequest request)
Deletes an object and its associated attributes.
|
DeleteSchemaResult |
deleteSchema(DeleteSchemaRequest request)
Deletes a given schema.
|
DeleteTypedLinkFacetResult |
deleteTypedLinkFacet(DeleteTypedLinkFacetRequest request)
Deletes a TypedLinkFacet.
|
DetachFromIndexResult |
detachFromIndex(DetachFromIndexRequest request)
Detaches the specified object from the specified index.
|
DetachObjectResult |
detachObject(DetachObjectRequest request)
Detaches a given object from the parent object.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest request)
Detaches a policy from an object.
|
DetachTypedLinkResult |
detachTypedLink(DetachTypedLinkRequest request)
Detaches a typed link from a specified source and target object.
|
DisableDirectoryResult |
disableDirectory(DisableDirectoryRequest request)
Disables the specified directory.
|
EnableDirectoryResult |
enableDirectory(EnableDirectoryRequest request)
Enables the specified directory.
|
GetAppliedSchemaVersionResult |
getAppliedSchemaVersion(GetAppliedSchemaVersionRequest request)
Returns current applied schema version ARN, including the minor version in use.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDirectoryResult |
getDirectory(GetDirectoryRequest request)
Retrieves metadata about a directory.
|
GetFacetResult |
getFacet(GetFacetRequest request)
|
GetLinkAttributesResult |
getLinkAttributes(GetLinkAttributesRequest request)
Retrieves attributes that are associated with a typed link.
|
GetObjectAttributesResult |
getObjectAttributes(GetObjectAttributesRequest request)
Retrieves attributes within a facet that are associated with an object.
|
GetObjectInformationResult |
getObjectInformation(GetObjectInformationRequest request)
Retrieves metadata about an object.
|
GetSchemaAsJsonResult |
getSchemaAsJson(GetSchemaAsJsonRequest request)
Retrieves a JSON representation of the schema.
|
GetTypedLinkFacetInformationResult |
getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest request)
Returns the identity attribute order for a specific TypedLinkFacet.
|
ListAppliedSchemaArnsResult |
listAppliedSchemaArns(ListAppliedSchemaArnsRequest request)
Lists schema major versions applied to a directory.
|
ListAttachedIndicesResult |
listAttachedIndices(ListAttachedIndicesRequest request)
Lists indices attached to the specified object.
|
ListDevelopmentSchemaArnsResult |
listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest request)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
ListDirectoriesResult |
listDirectories(ListDirectoriesRequest request)
Lists directories created within an account.
|
ListFacetAttributesResult |
listFacetAttributes(ListFacetAttributesRequest request)
Retrieves attributes attached to the facet.
|
ListFacetNamesResult |
listFacetNames(ListFacetNamesRequest request)
Retrieves the names of facets that exist in a schema.
|
ListIncomingTypedLinksResult |
listIncomingTypedLinks(ListIncomingTypedLinksRequest request)
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
|
ListIndexResult |
listIndex(ListIndexRequest request)
Lists objects attached to the specified index.
|
ListManagedSchemaArnsResult |
listManagedSchemaArns(ListManagedSchemaArnsRequest request)
Lists the major version families of each managed schema.
|
ListObjectAttributesResult |
listObjectAttributes(ListObjectAttributesRequest request)
Lists all attributes that are associated with an object.
|
ListObjectChildrenResult |
listObjectChildren(ListObjectChildrenRequest request)
Returns a paginated list of child objects that are associated with a given object.
|
ListObjectParentPathsResult |
listObjectParentPaths(ListObjectParentPathsRequest request)
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
objects.
|
ListObjectParentsResult |
listObjectParents(ListObjectParentsRequest request)
Lists parent objects that are associated with a given object in pagination fashion.
|
ListObjectPoliciesResult |
listObjectPolicies(ListObjectPoliciesRequest request)
Returns policies attached to an object in pagination fashion.
|
ListOutgoingTypedLinksResult |
listOutgoingTypedLinks(ListOutgoingTypedLinksRequest request)
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
|
ListPolicyAttachmentsResult |
listPolicyAttachments(ListPolicyAttachmentsRequest request)
Returns all of the
ObjectIdentifiers to which a given policy is attached. |
ListPublishedSchemaArnsResult |
listPublishedSchemaArns(ListPublishedSchemaArnsRequest request)
Lists the major version families of each published schema.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns tags for a resource.
|
ListTypedLinkFacetAttributesResult |
listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest request)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
ListTypedLinkFacetNamesResult |
listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest request)
Returns a paginated list of
TypedLink facet names for a particular schema. |
LookupPolicyResult |
lookupPolicy(LookupPolicyRequest request)
Lists all policies from the root of the Directory to the object specified.
|
PublishSchemaResult |
publishSchema(PublishSchemaRequest request)
Publishes a development schema with a major version and a recommended minor version.
|
PutSchemaFromJsonResult |
putSchemaFromJson(PutSchemaFromJsonRequest request)
Allows a schema to be updated using JSON upload.
|
RemoveFacetFromObjectResult |
removeFacetFromObject(RemoveFacetFromObjectRequest request)
Removes the specified facet from the specified object.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
An API operation for adding tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
An API operation for removing tags from a resource.
|
UpdateFacetResult |
updateFacet(UpdateFacetRequest request)
Does the following:
|
UpdateLinkAttributesResult |
updateLinkAttributes(UpdateLinkAttributesRequest request)
Updates a given typed link’s attributes.
|
UpdateObjectAttributesResult |
updateObjectAttributes(UpdateObjectAttributesRequest request)
Updates a given object's attributes.
|
UpdateSchemaResult |
updateSchema(UpdateSchemaRequest request)
Updates the schema name with a new name.
|
UpdateTypedLinkFacetResult |
updateTypedLinkFacet(UpdateTypedLinkFacetRequest request)
Updates a TypedLinkFacet.
|
UpgradeAppliedSchemaResult |
upgradeAppliedSchema(UpgradeAppliedSchemaRequest request)
Upgrades a single directory in-place using the
PublishedSchemaArn with schema updates found in
MinorVersion . |
UpgradePublishedSchemaResult |
upgradePublishedSchema(UpgradePublishedSchemaRequest request)
Upgrades a published schema under a new minor version revision using the current contents of
DevelopmentSchemaArn . |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonCloudDirectoryClient()
AmazonCloudDirectoryClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonCloudDirectoryClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudDirectory (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonCloudDirectoryClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonCloudDirectoryClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonCloudDirectoryClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudDirectory (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudDirectory (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonCloudDirectoryClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudDirectory (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonCloudDirectoryClientBuilder builder()
public AddFacetToObjectResult addFacetToObject(AddFacetToObjectRequest request)
Adds a new Facet to an object. An object can have more than one facet applied on it.
addFacetToObject
in interface AmazonCloudDirectory
addFacetToObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ApplySchemaResult applySchema(ApplySchemaRequest request)
Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
applySchema
in interface AmazonCloudDirectory
applySchemaRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.public AttachObjectResult attachObject(AttachObjectRequest request)
Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using ObjectIdentifier
attachObject
in interface AmazonCloudDirectory
attachObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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 make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.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.public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
attachPolicy
in interface AmazonCloudDirectory
attachPolicyRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.public AttachToIndexResult attachToIndex(AttachToIndexRequest request)
Attaches the specified object to the specified index.
attachToIndex
in interface AmazonCloudDirectory
attachToIndexRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.InvalidAttachmentException
- Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.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.public AttachTypedLinkResult attachTypedLink(AttachTypedLinkRequest request)
Attaches a typed link to a specified source and target object. For more information, see Typed Links.
attachTypedLink
in interface AmazonCloudDirectory
attachTypedLinkRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.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.public BatchReadResult batchRead(BatchReadRequest request)
Performs all the read operations in a batch.
batchRead
in interface AmazonCloudDirectory
batchReadRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.public BatchWriteResult batchWrite(BatchWriteRequest request)
Performs all the write operations in a batch. Either all the operations succeed or none.
batchWrite
in interface AmazonCloudDirectory
batchWriteRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.BatchWriteException
- A BatchWrite
exception has occurred.public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
You can also quickly create a directory using a managed schema, called the QuickStartSchema
. For
more information, see Managed Schema
in the Amazon Cloud Directory Developer Guide.
createDirectory
in interface AmazonCloudDirectory
createDirectoryRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryAlreadyExistsException
- Indicates that a Directory could not be created due to a naming conflict. Choose a different name
and try again.ResourceNotFoundException
- The specified resource could not be found.public CreateFacetResult createFacet(CreateFacetRequest request)
Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
createFacet
in interface AmazonCloudDirectory
createFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public CreateIndexResult createIndex(CreateIndexRequest request)
Creates an index object. See Indexing and search for more information.
createIndex
in interface AmazonCloudDirectory
createIndexRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public CreateObjectResult createObject(CreateObjectRequest request)
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.
createObject
in interface AmazonCloudDirectory
createObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public CreateSchemaResult createSchema(CreateSchemaRequest request)
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.
createSchema
in interface AmazonCloudDirectory
createSchemaRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.public CreateTypedLinkFacetResult createTypedLinkFacet(CreateTypedLinkFacetRequest request)
Creates a TypedLinkFacet. For more information, see Typed Links.
createTypedLinkFacet
in interface AmazonCloudDirectory
createTypedLinkFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
deleteDirectory
in interface AmazonCloudDirectory
deleteDirectoryRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public DeleteFacetResult deleteFacet(DeleteFacetRequest request)
Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
deleteFacet
in interface AmazonCloudDirectory
deleteFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public DeleteObjectResult deleteObject(DeleteObjectRequest request)
Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.
deleteObject
in interface AmazonCloudDirectory
deleteObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public DeleteSchemaResult deleteSchema(DeleteSchemaRequest request)
Deletes a given schema. Schemas in a development and published state can only be deleted.
deleteSchema
in interface AmazonCloudDirectory
deleteSchemaRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public DeleteTypedLinkFacetResult deleteTypedLinkFacet(DeleteTypedLinkFacetRequest request)
Deletes a TypedLinkFacet. For more information, see Typed Links.
deleteTypedLinkFacet
in interface AmazonCloudDirectory
deleteTypedLinkFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.public DetachFromIndexResult detachFromIndex(DetachFromIndexRequest request)
Detaches the specified object from the specified index.
detachFromIndex
in interface AmazonCloudDirectory
detachFromIndexRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public DetachObjectResult detachObject(DetachObjectRequest request)
Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
detachObject
in interface AmazonCloudDirectory
detachObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.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.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
Detaches a policy from an object.
detachPolicy
in interface AmazonCloudDirectory
detachPolicyRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.public DetachTypedLinkResult detachTypedLink(DetachTypedLinkRequest request)
Detaches a typed link from a specified source and target object. For more information, see Typed Links.
detachTypedLink
in interface AmazonCloudDirectory
detachTypedLinkRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public DisableDirectoryResult disableDirectory(DisableDirectoryRequest request)
Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
disableDirectory
in interface AmazonCloudDirectory
disableDirectoryRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public EnableDirectoryResult enableDirectory(EnableDirectoryRequest request)
Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
enableDirectory
in interface AmazonCloudDirectory
enableDirectoryRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public GetAppliedSchemaVersionResult getAppliedSchemaVersion(GetAppliedSchemaVersionRequest request)
Returns current applied schema version ARN, including the minor version in use.
getAppliedSchemaVersion
in interface AmazonCloudDirectory
getAppliedSchemaVersionRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.public GetDirectoryResult getDirectory(GetDirectoryRequest request)
Retrieves metadata about a directory.
getDirectory
in interface AmazonCloudDirectory
getDirectoryRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.public GetFacetResult getFacet(GetFacetRequest request)
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.
getFacet
in interface AmazonCloudDirectory
getFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.public GetLinkAttributesResult getLinkAttributes(GetLinkAttributesRequest request)
Retrieves attributes that are associated with a typed link.
getLinkAttributes
in interface AmazonCloudDirectory
getLinkAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public GetObjectAttributesResult getObjectAttributes(GetObjectAttributesRequest request)
Retrieves attributes within a facet that are associated with an object.
getObjectAttributes
in interface AmazonCloudDirectory
getObjectAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public GetObjectInformationResult getObjectInformation(GetObjectInformationRequest request)
Retrieves metadata about an object.
getObjectInformation
in interface AmazonCloudDirectory
getObjectInformationRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.public GetSchemaAsJsonResult getSchemaAsJson(GetSchemaAsJsonRequest request)
Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
getSchemaAsJson
in interface AmazonCloudDirectory
getSchemaAsJsonRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public GetTypedLinkFacetInformationResult getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest request)
Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.
getTypedLinkFacetInformation
in interface AmazonCloudDirectory
getTypedLinkFacetInformationRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public ListAppliedSchemaArnsResult listAppliedSchemaArns(ListAppliedSchemaArnsRequest request)
Lists schema major versions applied to a directory. If SchemaArn
is provided, lists the minor
version.
listAppliedSchemaArns
in interface AmazonCloudDirectory
listAppliedSchemaArnsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListAttachedIndicesResult listAttachedIndices(ListAttachedIndicesRequest request)
Lists indices attached to the specified object.
listAttachedIndices
in interface AmazonCloudDirectory
listAttachedIndicesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.public ListDevelopmentSchemaArnsResult listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest request)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
listDevelopmentSchemaArns
in interface AmazonCloudDirectory
listDevelopmentSchemaArnsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListDirectoriesResult listDirectories(ListDirectoriesRequest request)
Lists directories created within an account.
listDirectories
in interface AmazonCloudDirectory
listDirectoriesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListFacetAttributesResult listFacetAttributes(ListFacetAttributesRequest request)
Retrieves attributes attached to the facet.
listFacetAttributes
in interface AmazonCloudDirectory
listFacetAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public ListFacetNamesResult listFacetNames(ListFacetNamesRequest request)
Retrieves the names of facets that exist in a schema.
listFacetNames
in interface AmazonCloudDirectory
listFacetNamesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListIncomingTypedLinksResult listIncomingTypedLinks(ListIncomingTypedLinksRequest request)
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 Links.
listIncomingTypedLinks
in interface AmazonCloudDirectory
listIncomingTypedLinksRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListIndexResult listIndex(ListIndexRequest request)
Lists objects attached to the specified index.
listIndex
in interface AmazonCloudDirectory
listIndexRequest
- 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.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotIndexException
- Indicates that the requested operation can only operate on index objects.public ListManagedSchemaArnsResult listManagedSchemaArns(ListManagedSchemaArnsRequest request)
Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.
listManagedSchemaArns
in interface AmazonCloudDirectory
listManagedSchemaArnsRequest
- 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.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.AccessDeniedException
- Access denied or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListObjectAttributesResult listObjectAttributes(ListObjectAttributesRequest request)
Lists all attributes that are associated with an object.
listObjectAttributes
in interface AmazonCloudDirectory
listObjectAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListObjectChildrenResult listObjectChildren(ListObjectChildrenRequest request)
Returns a paginated list of child objects that are associated with a given object.
listObjectChildren
in interface AmazonCloudDirectory
listObjectChildrenRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListObjectParentPathsResult listObjectParentPaths(ListObjectParentPathsRequest request)
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.
listObjectParentPaths
in interface AmazonCloudDirectory
listObjectParentPathsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.public ListObjectParentsResult listObjectParents(ListObjectParentsRequest request)
Lists parent objects that are associated with a given object in pagination fashion.
listObjectParents
in interface AmazonCloudDirectory
listObjectParentsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListObjectPoliciesResult listObjectPolicies(ListObjectPoliciesRequest request)
Returns policies attached to an object in pagination fashion.
listObjectPolicies
in interface AmazonCloudDirectory
listObjectPoliciesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListOutgoingTypedLinksResult listOutgoingTypedLinks(ListOutgoingTypedLinksRequest request)
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 Links.
listOutgoingTypedLinks
in interface AmazonCloudDirectory
listOutgoingTypedLinksRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListPolicyAttachmentsResult listPolicyAttachments(ListPolicyAttachmentsRequest request)
Returns all of the ObjectIdentifiers
to which a given policy is attached.
listPolicyAttachments
in interface AmazonCloudDirectory
listPolicyAttachmentsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public ListPublishedSchemaArnsResult listPublishedSchemaArns(ListPublishedSchemaArnsRequest request)
Lists the major version families of each published schema. If a major version ARN is provided as
SchemaArn
, the minor version revisions in that family are listed instead.
listPublishedSchemaArns
in interface AmazonCloudDirectory
listPublishedSchemaArnsRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AmazonCloudDirectory
listTagsForResourceRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public ListTypedLinkFacetAttributesResult listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest request)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.
listTypedLinkFacetAttributes
in interface AmazonCloudDirectory
listTypedLinkFacetAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public ListTypedLinkFacetNamesResult listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest request)
Returns a paginated list of TypedLink
facet names for a particular schema. For more information, see
Typed Links.
listTypedLinkFacetNames
in interface AmazonCloudDirectory
listTypedLinkFacetNamesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.public LookupPolicyResult lookupPolicy(LookupPolicyRequest request)
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.
lookupPolicy
in interface AmazonCloudDirectory
lookupPolicyRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.public PublishSchemaResult publishSchema(PublishSchemaRequest request)
Publishes a development schema with a major version and a recommended minor version.
publishSchema
in interface AmazonCloudDirectory
publishSchemaRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.SchemaAlreadyPublishedException
- Indicates that a schema is already published.public PutSchemaFromJsonResult putSchemaFromJson(PutSchemaFromJsonRequest request)
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
putSchemaFromJson
in interface AmazonCloudDirectory
putSchemaFromJsonRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public RemoveFacetFromObjectResult removeFacetFromObject(RemoveFacetFromObjectRequest request)
Removes the specified facet from the specified object.
removeFacetFromObject
in interface AmazonCloudDirectory
removeFacetFromObjectRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public TagResourceResult tagResource(TagResourceRequest request)
An API operation for adding tags to a resource.
tagResource
in interface AmazonCloudDirectory
tagResourceRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public UntagResourceResult untagResource(UntagResourceRequest request)
An API operation for removing tags from a resource.
untagResource
in interface AmazonCloudDirectory
untagResourceRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public UpdateFacetResult updateFacet(UpdateFacetRequest request)
Does the following:
Adds new Attributes
, Rules
, or ObjectTypes
.
Updates existing Attributes
, Rules
, or ObjectTypes
.
Deletes existing Attributes
, Rules
, or ObjectTypes
.
updateFacet
in interface AmazonCloudDirectory
updateFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.InvalidFacetUpdateException
- An attempt to modify a Facet resulted in an invalid schema exception.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.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.public UpdateLinkAttributesResult updateLinkAttributes(UpdateLinkAttributesRequest request)
Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s
identity, as defined by its IdentityAttributeOrder
.
updateLinkAttributes
in interface AmazonCloudDirectory
updateLinkAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.public UpdateObjectAttributesResult updateObjectAttributes(UpdateObjectAttributesRequest request)
Updates a given object's attributes.
updateObjectAttributes
in interface AmazonCloudDirectory
updateObjectAttributesRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.DirectoryNotEnabledException
- Operations are only permitted on enabled directories.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.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.public UpdateSchemaResult updateSchema(UpdateSchemaRequest request)
Updates the schema name with a new name. Only development schema names can be updated.
updateSchema
in interface AmazonCloudDirectory
updateSchemaRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.public UpdateTypedLinkFacetResult updateTypedLinkFacet(UpdateTypedLinkFacetRequest request)
Updates a TypedLinkFacet. For more information, see Typed Links.
updateTypedLinkFacet
in interface AmazonCloudDirectory
updateTypedLinkFacetRequest
- 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 or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and 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.public UpgradeAppliedSchemaResult upgradeAppliedSchema(UpgradeAppliedSchemaRequest request)
Upgrades a single directory in-place using the PublishedSchemaArn
with schema updates found in
MinorVersion
. Backwards-compatible minor version upgrades are instantaneously available for readers
on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given
directory per call. To upgrade multiple directories from one schema, you would need to call this API on each
directory.
upgradeAppliedSchema
in interface AmazonCloudDirectory
upgradeAppliedSchemaRequest
- 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.IncompatibleSchemaException
- Indicates a failure occurred while performing a check for backward compatibility between the specified
schema and the schema that is currently applied to the directory.AccessDeniedException
- Access denied or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.SchemaAlreadyExistsException
- Indicates that a schema could not be created due to a naming conflict. Please select a different name and
then try again.public UpgradePublishedSchemaResult upgradePublishedSchema(UpgradePublishedSchemaRequest request)
Upgrades a published schema under a new minor version revision using the current contents of
DevelopmentSchemaArn
.
upgradePublishedSchema
in interface AmazonCloudDirectory
upgradePublishedSchemaRequest
- 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.IncompatibleSchemaException
- Indicates a failure occurred while performing a check for backward compatibility between the specified
schema and the schema that is currently applied to the directory.AccessDeniedException
- Access denied or directory not found. Either you don't have permissions for this directory or the
directory does not exist. Try calling ListDirectories and check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link
type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonCloudDirectory
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonCloudDirectory
shutdown
in class AmazonWebServiceClient