@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 programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_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 addFacetToObjectRequest)
Adds a new Facet to an object.
|
ApplySchemaResult |
applySchema(ApplySchemaRequest applySchemaRequest)
Copies input published schema into Directory with same name and version as that of published schema .
|
AttachObjectResult |
attachObject(AttachObjectRequest attachObjectRequest)
Attaches an existing object to another object.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy object to a regular object.
|
AttachToIndexResult |
attachToIndex(AttachToIndexRequest attachToIndexRequest)
Attaches the specified object to the specified index.
|
BatchReadResult |
batchRead(BatchReadRequest batchReadRequest)
Performs all the read operations in a batch.
|
BatchWriteResult |
batchWrite(BatchWriteRequest batchWriteRequest)
Performs all the write operations in a batch.
|
static AmazonCloudDirectoryClientBuilder |
builder() |
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Directory by copying the published schema into the directory.
|
CreateFacetResult |
createFacet(CreateFacetRequest createFacetRequest)
Creates a new Facet in a schema.
|
CreateIndexResult |
createIndex(CreateIndexRequest createIndexRequest)
Creates an index object.
|
CreateObjectResult |
createObject(CreateObjectRequest createObjectRequest)
Creates an object in a Directory.
|
CreateSchemaResult |
createSchema(CreateSchemaRequest createSchemaRequest)
Creates a new schema in a development state.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes a directory.
|
DeleteFacetResult |
deleteFacet(DeleteFacetRequest deleteFacetRequest)
Deletes a given Facet.
|
DeleteObjectResult |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Deletes an object and its associated attributes.
|
DeleteSchemaResult |
deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a given schema.
|
DetachFromIndexResult |
detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)
Detaches the specified object from the specified index.
|
DetachObjectResult |
detachObject(DetachObjectRequest detachObjectRequest)
Detaches a given object from the parent object.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from an object.
|
DisableDirectoryResult |
disableDirectory(DisableDirectoryRequest disableDirectoryRequest)
Disables the specified directory.
|
EnableDirectoryResult |
enableDirectory(EnableDirectoryRequest enableDirectoryRequest)
Enables the specified directory.
|
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 getDirectoryRequest)
Retrieves metadata about a directory.
|
GetFacetResult |
getFacet(GetFacetRequest getFacetRequest)
|
GetObjectInformationResult |
getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)
Retrieves metadata about an object.
|
GetSchemaAsJsonResult |
getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)
Retrieves a JSON representation of the schema.
|
ListAppliedSchemaArnsResult |
listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
ListAttachedIndicesResult |
listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
|
ListDevelopmentSchemaArnsResult |
listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves the ARNs of schemas in the development state.
|
ListDirectoriesResult |
listDirectories(ListDirectoriesRequest listDirectoriesRequest)
Lists directories created within an account.
|
ListFacetAttributesResult |
listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)
Retrieves attributes attached to the facet.
|
ListFacetNamesResult |
listFacetNames(ListFacetNamesRequest listFacetNamesRequest)
Retrieves the names of facets that exist in a schema.
|
ListIndexResult |
listIndex(ListIndexRequest listIndexRequest)
Lists objects attached to the specified index.
|
ListObjectAttributesResult |
listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)
Lists all attributes associated with an object.
|
ListObjectChildrenResult |
listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)
Returns a paginated list of child objects associated with a given object.
|
ListObjectParentsResult |
listObjectParents(ListObjectParentsRequest listObjectParentsRequest)
Lists parent objects associated with a given object in pagination fashion.
|
ListObjectPoliciesResult |
listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)
Returns policies attached to an object in pagination fashion.
|
ListPolicyAttachmentsResult |
listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the ObjectIdentifiers to which a given policy is attached.
|
ListPublishedSchemaArnsResult |
listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves published schema ARNs.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns tags for a resource.
|
LookupPolicyResult |
lookupPolicy(LookupPolicyRequest lookupPolicyRequest)
Lists all policies from the root of the Directory to the object specified.
|
PublishSchemaResult |
publishSchema(PublishSchemaRequest publishSchemaRequest)
Publishes a development schema with a version.
|
PutSchemaFromJsonResult |
putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)
Allows a schema to be updated using JSON upload.
|
RemoveFacetFromObjectResult |
removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)
Removes the specified facet from the specified object.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
API for adding tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
API for removing tags from a resource.
|
UpdateFacetResult |
updateFacet(UpdateFacetRequest updateFacetRequest)
Does the following:
|
UpdateObjectAttributesResult |
updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)
Updates a given object's attributes.
|
UpdateSchemaResult |
updateSchema(UpdateSchemaRequest updateSchemaRequest)
Updates the schema name with a new name.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@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 addFacetToObjectRequest)
Adds a new Facet to an object.
addFacetToObject in interface AmazonCloudDirectoryaddFacetToObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet you provided was not well formed or could not be validated with the schema.public ApplySchemaResult applySchema(ApplySchemaRequest applySchemaRequest)
Copies input published schema into Directory with same name and version as that of published schema .
applySchema in interface AmazonCloudDirectoryapplySchemaRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with same name
has occurred. Rename the link or the schema and then try again.public AttachObjectResult attachObject(AttachObjectRequest attachObjectRequest)
Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using ObjectIdentifier
attachObject in interface AmazonCloudDirectoryattachObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with same name
has occurred. Rename the link or the schema and then try again.ValidationException - Indicates your request is malformed in some manner. See the exception message.public AttachPolicyResult attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
attachPolicy in interface AmazonCloudDirectoryattachPolicyRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates the requested operation can only operate on policy objects.public AttachToIndexResult attachToIndex(AttachToIndexRequest attachToIndexRequest)
Attaches the specified object to the specified index.
attachToIndex in interface AmazonCloudDirectoryattachToIndexRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.IndexedAttributeMissingException - An object has been attempted to be attached to an object that does not have the appropriate attribute
value.NotIndexException - Indicates the requested operation can only operate on index objects.public BatchReadResult batchRead(BatchReadRequest batchReadRequest)
Performs all the read operations in a batch.
batchRead in interface AmazonCloudDirectorybatchReadRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.public BatchWriteResult batchWrite(BatchWriteRequest batchWriteRequest)
Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.
batchWrite in interface AmazonCloudDirectorybatchWriteRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.BatchWriteException - A BatchWrite exception has occurred.public CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
createDirectory in interface AmazonCloudDirectorycreateDirectoryRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryAlreadyExistsException - Indicates that a Directory could not be created due to a naming conflict. Choose a different name
and try again.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.public CreateFacetResult createFacet(CreateFacetRequest createFacetRequest)
Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
createFacet in interface AmazonCloudDirectorycreateFacetRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetAlreadyExistsException - A facet with the same name already exists.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.public CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
Creates an index object. See Indexing for more information.
createIndex in interface AmazonCloudDirectorycreateIndexRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet 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 the requested index type is not supported.public CreateObjectResult createObject(CreateObjectRequest createObjectRequest)
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 AmazonCloudDirectorycreateObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet 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 the requested index type is not supported.public CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest)
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 AmazonCloudDirectorycreateSchemaRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.SchemaAlreadyExistsException - Indicates that a schema could not be created due to a naming conflict. Please select a different name and
then try again.AccessDeniedException - Access denied. Check your permissions.public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
deleteDirectory in interface AmazonCloudDirectorydeleteDirectoryRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryDeletedException - A directory that has been deleted has been attempted to be accessed. Note: The requested resource will
eventually cease to exist.public DeleteFacetResult deleteFacet(DeleteFacetRequest deleteFacetRequest)
Deletes a given Facet. All attributes and Rules associated with the facet will be deleted. Only development schema facets are allowed deletion.
deleteFacet in interface AmazonCloudDirectorydeleteFacetRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.FacetInUseException - Occurs when deleting a facet that contains an attribute which is a target to an attribute reference in a
different facet.public DeleteObjectResult deleteObject(DeleteObjectRequest deleteObjectRequest)
Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.
deleteObject in interface AmazonCloudDirectorydeleteObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.ObjectNotDetachedException - Indicates the requested operation cannot be completed because the object has not been detached from the
tree.public DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a given schema. Schemas in a development and published state can only be deleted.
deleteSchema in interface AmazonCloudDirectorydeleteSchemaRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.StillContainsLinksException - The object could not be deleted because links still exist. Remove the links and then try the operation
again.public DetachFromIndexResult detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)
Detaches the specified object from the specified index.
detachFromIndex in interface AmazonCloudDirectorydetachFromIndexRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.ObjectAlreadyDetachedException - Indicates the object is not attached to the index.NotIndexException - Indicates the requested operation can only operate on index objects.public DetachObjectResult detachObject(DetachObjectRequest detachObjectRequest)
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 AmazonCloudDirectorydetachObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.public DetachPolicyResult detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from an object.
detachPolicy in interface AmazonCloudDirectorydetachPolicyRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates the requested operation can only operate on policy objects.public DisableDirectoryResult disableDirectory(DisableDirectoryRequest disableDirectoryRequest)
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 AmazonCloudDirectorydisableDirectoryRequest - ResourceNotFoundException - The specified resource could not be found.DirectoryDeletedException - A directory that has been deleted has been attempted to be accessed. 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.public EnableDirectoryResult enableDirectory(EnableDirectoryRequest enableDirectoryRequest)
Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
enableDirectory in interface AmazonCloudDirectoryenableDirectoryRequest - ResourceNotFoundException - The specified resource could not be found.DirectoryDeletedException - A directory that has been deleted has been attempted to be accessed. 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.public GetDirectoryResult getDirectory(GetDirectoryRequest getDirectoryRequest)
Retrieves metadata about a directory.
getDirectory in interface AmazonCloudDirectorygetDirectoryRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.public GetFacetResult getFacet(GetFacetRequest getFacetRequest)
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 AmazonCloudDirectorygetFacetRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.public GetObjectInformationResult getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)
Retrieves metadata about an object.
getObjectInformation in interface AmazonCloudDirectorygetObjectInformationRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.public GetSchemaAsJsonResult getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)
Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
getSchemaAsJson in interface AmazonCloudDirectorygetSchemaAsJsonRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.ValidationException - Indicates your request is malformed in some manner. See the exception message.public ListAppliedSchemaArnsResult listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
listAppliedSchemaArns in interface AmazonCloudDirectorylistAppliedSchemaArnsRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListAttachedIndicesResult listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
listAttachedIndices in interface AmazonCloudDirectorylistAttachedIndicesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.public ListDevelopmentSchemaArnsResult listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves the ARNs of schemas in the development state.
listDevelopmentSchemaArns in interface AmazonCloudDirectorylistDevelopmentSchemaArnsRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListDirectoriesResult listDirectories(ListDirectoriesRequest listDirectoriesRequest)
Lists directories created within an account.
listDirectories in interface AmazonCloudDirectorylistDirectoriesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListFacetAttributesResult listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)
Retrieves attributes attached to the facet.
listFacetAttributes in interface AmazonCloudDirectorylistFacetAttributesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListFacetNamesResult listFacetNames(ListFacetNamesRequest listFacetNamesRequest)
Retrieves the names of facets that exist in a schema.
listFacetNames in interface AmazonCloudDirectorylistFacetNamesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListIndexResult listIndex(ListIndexRequest listIndexRequest)
Lists objects attached to the specified index.
listIndex in interface AmazonCloudDirectorylistIndexRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.NotIndexException - Indicates the requested operation can only operate on index objects.public ListObjectAttributesResult listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)
Lists all attributes associated with an object. This also supports common namespace prefix (key) listing. For
example, if you want to retrieve all attributes associated with facet1, key can be facet1. If key is
empty, all attributes are returned in a paginated list.
listObjectAttributes in interface AmazonCloudDirectorylistObjectAttributesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListObjectChildrenResult listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)
Returns a paginated list of child objects associated with a given object.
listObjectChildren in interface AmazonCloudDirectorylistObjectChildrenRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.NotNodeException - Occurs when any invalid operations are performed on an object which is not a node, such as calling
ListObjectChildren for a leaf node object.public ListObjectParentsResult listObjectParents(ListObjectParentsRequest listObjectParentsRequest)
Lists parent objects associated with a given object in pagination fashion.
listObjectParents in interface AmazonCloudDirectorylistObjectParentsRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.CannotListParentOfRootException - Cannot list the parents of a Directory root.public ListObjectPoliciesResult listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)
Returns policies attached to an object in pagination fashion.
listObjectPolicies in interface AmazonCloudDirectorylistObjectPoliciesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListPolicyAttachmentsResult listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the ObjectIdentifiers to which a given policy is attached.
listPolicyAttachments in interface AmazonCloudDirectorylistPolicyAttachmentsRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.InvalidNextTokenException - Indicates that the NextToken value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates the requested operation can only operate on policy objects.public ListPublishedSchemaArnsResult listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves published schema ARNs.
listPublishedSchemaArns in interface AmazonCloudDirectorylistPublishedSchemaArnsRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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 AmazonCloudDirectorylistTagsForResourceRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.public LookupPolicyResult lookupPolicy(LookupPolicyRequest lookupPolicyRequest)
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.
lookupPolicy in interface AmazonCloudDirectorylookupPolicyRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.InvalidNextTokenException - Indicates that the NextToken value is not valid.ResourceNotFoundException - The specified resource could not be found.public PublishSchemaResult publishSchema(PublishSchemaRequest publishSchemaRequest)
Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.
publishSchema in interface AmazonCloudDirectorypublishSchemaRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.SchemaAlreadyPublishedException - Indicates a schema is already published.public PutSchemaFromJsonResult putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
putSchemaFromJson in interface AmazonCloudDirectoryputSchemaFromJsonRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidSchemaDocException - Indicates that the provided SchemaDoc value is not valid.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.public RemoveFacetFromObjectResult removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)
Removes the specified facet from the specified object.
removeFacetFromObject in interface AmazonCloudDirectoryremoveFacetFromObjectRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet you provided was not well formed or could not be validated with the schema.public TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
API for adding tags to a resource.
tagResource in interface AmazonCloudDirectorytagResourceRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
API for removing tags from a resource.
untagResource in interface AmazonCloudDirectoryuntagResourceRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.public UpdateFacetResult updateFacet(UpdateFacetRequest updateFacetRequest)
Does the following:
Adds new Attributes, Rules, or ObjectTypes.
Updates existing Attributes, Rules, or ObjectTypes.
Deletes existing Attributes, Rules, or ObjectTypes.
updateFacet in interface AmazonCloudDirectoryupdateFacetRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidFacetUpdateException - An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.public UpdateObjectAttributesResult updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)
Updates a given object's attributes.
updateObjectAttributes in interface AmazonCloudDirectoryupdateObjectAttributesRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet you provided was not well formed or could not be validated with the schema.public UpdateSchemaResult updateSchema(UpdateSchemaRequest updateSchemaRequest)
Updates the schema name with a new name. Only development schema names can be updated.
updateSchema in interface AmazonCloudDirectoryupdateSchemaRequest - 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 your request is malformed in some manner. See the exception message.LimitExceededException - Indicates limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.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 AmazonCloudDirectoryrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.