com.amazonaws.services.clouddirectory.AmazonCloudDirectory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-clouddirectory Show documentation
Show all versions of aws-java-sdk-clouddirectory Show documentation
The AWS Java SDK for Amazon CloudDirectory module holds the client classes that are used for communicating with Amazon CloudDirectory Service
The newest version!
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.clouddirectory;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.clouddirectory.model.*;
/**
* Interface for accessing Amazon CloudDirectory.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.clouddirectory.AbstractAmazonCloudDirectory} instead.
*
*
* Amazon Cloud Directory
*
* Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of
* cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call
* programmatically and includes detailed information on data types and errors. For information about Cloud Directory
* features, see AWS Directory Service and the Amazon Cloud
* Directory Developer Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudDirectory {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "clouddirectory";
/**
* Overrides the default endpoint for this client ("clouddirectory.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "clouddirectory.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "clouddirectory.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
* protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "clouddirectory.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "clouddirectory.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
* with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonCloudDirectory#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* Adds a new Facet to an object. An object can have more than one facet applied on it.
*
*
* @param addFacetToObjectRequest
* @return Result of the AddFacetToObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.AddFacetToObject
* @see AWS API Documentation
*/
AddFacetToObjectResult addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest);
/**
*
* Copies the input published schema, at the specified version, into the Directory with the same name and
* version as that of the published schema.
*
*
* @param applySchemaRequest
* @return Result of the ApplySchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws SchemaAlreadyExistsException
* Indicates that a schema could not be created due to a naming conflict. Please select a different name and
* then try again.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @sample AmazonCloudDirectory.ApplySchema
* @see AWS API
* Documentation
*/
ApplySchemaResult applySchema(ApplySchemaRequest applySchemaRequest);
/**
*
* Attaches an existing object to another object. An object can be accessed in two ways:
*
*
* -
*
* Using the path
*
*
* -
*
* Using ObjectIdentifier
*
*
*
*
* @param attachObjectRequest
* @return Result of the AttachObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws LinkNameAlreadyInUseException
* Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
* again.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.AttachObject
* @see AWS
* API Documentation
*/
AttachObjectResult attachObject(AttachObjectRequest attachObjectRequest);
/**
*
* Attaches a policy object to a regular object. An object can have a limited number of attached policies.
*
*
* @param attachPolicyRequest
* @return Result of the AttachPolicy operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws NotPolicyException
* Indicates that the requested operation can only operate on policy objects.
* @sample AmazonCloudDirectory.AttachPolicy
* @see AWS
* API Documentation
*/
AttachPolicyResult attachPolicy(AttachPolicyRequest attachPolicyRequest);
/**
*
* Attaches the specified object to the specified index.
*
*
* @param attachToIndexRequest
* @return Result of the AttachToIndex operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws LinkNameAlreadyInUseException
* Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
* again.
* @throws IndexedAttributeMissingException
* An object has been attempted to be attached to an object that does not have the appropriate attribute
* value.
* @throws NotIndexException
* Indicates that the requested operation can only operate on index objects.
* @sample AmazonCloudDirectory.AttachToIndex
* @see AWS
* API Documentation
*/
AttachToIndexResult attachToIndex(AttachToIndexRequest attachToIndexRequest);
/**
*
* Attaches a typed link to a specified source and target object. For more information, see Typed Links.
*
*
* @param attachTypedLinkRequest
* @return Result of the AttachTypedLink operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.AttachTypedLink
* @see AWS
* API Documentation
*/
AttachTypedLinkResult attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest);
/**
*
* Performs all the read operations in a batch.
*
*
* @param batchReadRequest
* @return Result of the BatchRead operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @sample AmazonCloudDirectory.BatchRead
* @see AWS API
* Documentation
*/
BatchReadResult batchRead(BatchReadRequest batchReadRequest);
/**
*
* Performs all the write operations in a batch. Either all the operations succeed or none.
*
*
* @param batchWriteRequest
* @return Result of the BatchWrite operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws BatchWriteException
* A BatchWrite exception has occurred.
* @sample AmazonCloudDirectory.BatchWrite
* @see AWS API
* Documentation
*/
BatchWriteResult batchWrite(BatchWriteRequest batchWriteRequest);
/**
*
* 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.
*
*
* @param createDirectoryRequest
* @return Result of the CreateDirectory operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryAlreadyExistsException
* Indicates that a Directory could not be created due to a naming conflict. Choose a different name
* and try again.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.CreateDirectory
* @see AWS
* API Documentation
*/
CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest);
/**
*
* Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
*
*
* @param createFacetRequest
* @return Result of the CreateFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetAlreadyExistsException
* A facet with the same name already exists.
* @throws InvalidRuleException
* Occurs when any of the rule parameter keys or values are invalid.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.CreateFacet
* @see AWS API
* Documentation
*/
CreateFacetResult createFacet(CreateFacetRequest createFacetRequest);
/**
*
* Creates an index object. See Indexing and
* search for more information.
*
*
* @param createIndexRequest
* @return Result of the CreateIndex operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @throws LinkNameAlreadyInUseException
* Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
* again.
* @throws UnsupportedIndexTypeException
* Indicates that the requested index type is not supported.
* @sample AmazonCloudDirectory.CreateIndex
* @see AWS API
* Documentation
*/
CreateIndexResult createIndex(CreateIndexRequest createIndexRequest);
/**
*
* 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.
*
*
* @param createObjectRequest
* @return Result of the CreateObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @throws LinkNameAlreadyInUseException
* Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
* again.
* @throws UnsupportedIndexTypeException
* Indicates that the requested index type is not supported.
* @sample AmazonCloudDirectory.CreateObject
* @see AWS
* API Documentation
*/
CreateObjectResult createObject(CreateObjectRequest createObjectRequest);
/**
*
* 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.
*
*
*
*
* @param createSchemaRequest
* @return Result of the CreateSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws SchemaAlreadyExistsException
* Indicates that a schema could not be created due to a naming conflict. Please select a different name and
* then try again.
* @throws 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.
* @sample AmazonCloudDirectory.CreateSchema
* @see AWS
* API Documentation
*/
CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest);
/**
*
* Creates a TypedLinkFacet. For more information, see Typed Links.
*
*
* @param createTypedLinkFacetRequest
* @return Result of the CreateTypedLinkFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetAlreadyExistsException
* A facet with the same name already exists.
* @throws InvalidRuleException
* Occurs when any of the rule parameter keys or values are invalid.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.CreateTypedLinkFacet
* @see AWS API Documentation
*/
CreateTypedLinkFacetResult createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest);
/**
*
* Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise
* extreme caution when deleting directories.
*
*
* @param deleteDirectoryRequest
* @return Result of the DeleteDirectory operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws DirectoryNotDisabledException
* An operation can only operate on a disabled directory.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryDeletedException
* A directory that has been deleted and to which access has been attempted. Note: The requested resource
* will eventually cease to exist.
* @throws 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.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @sample AmazonCloudDirectory.DeleteDirectory
* @see AWS
* API Documentation
*/
DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest);
/**
*
* Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted.
* Only development schema facets are allowed deletion.
*
*
* @param deleteFacetRequest
* @return Result of the DeleteFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @throws FacetInUseException
* Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a
* different facet.
* @sample AmazonCloudDirectory.DeleteFacet
* @see AWS API
* Documentation
*/
DeleteFacetResult deleteFacet(DeleteFacetRequest deleteFacetRequest);
/**
*
* 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.
*
*
* @param deleteObjectRequest
* @return Result of the DeleteObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ObjectNotDetachedException
* Indicates that the requested operation cannot be completed because the object has not been detached from
* the tree.
* @sample AmazonCloudDirectory.DeleteObject
* @see AWS
* API Documentation
*/
DeleteObjectResult deleteObject(DeleteObjectRequest deleteObjectRequest);
/**
*
* Deletes a given schema. Schemas in a development and published state can only be deleted.
*
*
* @param deleteSchemaRequest
* @return Result of the DeleteSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws StillContainsLinksException
* The object could not be deleted because links still exist. Remove the links and then try the operation
* again.
* @sample AmazonCloudDirectory.DeleteSchema
* @see AWS
* API Documentation
*/
DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest);
/**
*
* Deletes a TypedLinkFacet. For more information, see Typed Links.
*
*
* @param deleteTypedLinkFacetRequest
* @return Result of the DeleteTypedLinkFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @sample AmazonCloudDirectory.DeleteTypedLinkFacet
* @see AWS API Documentation
*/
DeleteTypedLinkFacetResult deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest);
/**
*
* Detaches the specified object from the specified index.
*
*
* @param detachFromIndexRequest
* @return Result of the DetachFromIndex operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ObjectAlreadyDetachedException
* Indicates that the object is not attached to the index.
* @throws NotIndexException
* Indicates that the requested operation can only operate on index objects.
* @sample AmazonCloudDirectory.DetachFromIndex
* @see AWS
* API Documentation
*/
DetachFromIndexResult detachFromIndex(DetachFromIndexRequest detachFromIndexRequest);
/**
*
* Detaches a given object from the parent object. The object that is to be detached from the parent is specified by
* the link name.
*
*
* @param detachObjectRequest
* @return Result of the DetachObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @sample AmazonCloudDirectory.DetachObject
* @see AWS
* API Documentation
*/
DetachObjectResult detachObject(DetachObjectRequest detachObjectRequest);
/**
*
* Detaches a policy from an object.
*
*
* @param detachPolicyRequest
* @return Result of the DetachPolicy operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws NotPolicyException
* Indicates that the requested operation can only operate on policy objects.
* @sample AmazonCloudDirectory.DetachPolicy
* @see AWS
* API Documentation
*/
DetachPolicyResult detachPolicy(DetachPolicyRequest detachPolicyRequest);
/**
*
* Detaches a typed link from a specified source and target object. For more information, see Typed Links.
*
*
* @param detachTypedLinkRequest
* @return Result of the DetachTypedLink operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.DetachTypedLink
* @see AWS
* API Documentation
*/
DetachTypedLinkResult detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest);
/**
*
* Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can
* be disabled. Disabled directories may be reenabled.
*
*
* @param disableDirectoryRequest
* @return Result of the DisableDirectory operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws DirectoryDeletedException
* A directory that has been deleted and to which access has been attempted. Note: The requested resource
* will eventually cease to exist.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws 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.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @sample AmazonCloudDirectory.DisableDirectory
* @see AWS API Documentation
*/
DisableDirectoryResult disableDirectory(DisableDirectoryRequest disableDirectoryRequest);
/**
*
* Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then
* be read and written to.
*
*
* @param enableDirectoryRequest
* @return Result of the EnableDirectory operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws DirectoryDeletedException
* A directory that has been deleted and to which access has been attempted. Note: The requested resource
* will eventually cease to exist.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws 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.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @sample AmazonCloudDirectory.EnableDirectory
* @see AWS
* API Documentation
*/
EnableDirectoryResult enableDirectory(EnableDirectoryRequest enableDirectoryRequest);
/**
*
* Returns current applied schema version ARN, including the minor version in use.
*
*
* @param getAppliedSchemaVersionRequest
* @return Result of the GetAppliedSchemaVersion operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.GetAppliedSchemaVersion
* @see AWS API Documentation
*/
GetAppliedSchemaVersionResult getAppliedSchemaVersion(GetAppliedSchemaVersionRequest getAppliedSchemaVersionRequest);
/**
*
* Retrieves metadata about a directory.
*
*
* @param getDirectoryRequest
* @return Result of the GetDirectory operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @sample AmazonCloudDirectory.GetDirectory
* @see AWS
* API Documentation
*/
GetDirectoryResult getDirectory(GetDirectoryRequest getDirectoryRequest);
/**
*
* 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.
*
*
* @param getFacetRequest
* @return Result of the GetFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @sample AmazonCloudDirectory.GetFacet
* @see AWS API
* Documentation
*/
GetFacetResult getFacet(GetFacetRequest getFacetRequest);
/**
*
* Retrieves attributes that are associated with a typed link.
*
*
* @param getLinkAttributesRequest
* @return Result of the GetLinkAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.GetLinkAttributes
* @see AWS API Documentation
*/
GetLinkAttributesResult getLinkAttributes(GetLinkAttributesRequest getLinkAttributesRequest);
/**
*
* Retrieves attributes within a facet that are associated with an object.
*
*
* @param getObjectAttributesRequest
* @return Result of the GetObjectAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.GetObjectAttributes
* @see AWS API Documentation
*/
GetObjectAttributesResult getObjectAttributes(GetObjectAttributesRequest getObjectAttributesRequest);
/**
*
* Retrieves metadata about an object.
*
*
* @param getObjectInformationRequest
* @return Result of the GetObjectInformation operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.GetObjectInformation
* @see AWS API Documentation
*/
GetObjectInformationResult getObjectInformation(GetObjectInformationRequest getObjectInformationRequest);
/**
*
* Retrieves a JSON representation of the schema. See JSON
* Schema Format for more information.
*
*
* @param getSchemaAsJsonRequest
* @return Result of the GetSchemaAsJson operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @sample AmazonCloudDirectory.GetSchemaAsJson
* @see AWS
* API Documentation
*/
GetSchemaAsJsonResult getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest);
/**
*
* Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.
*
*
* @param getTypedLinkFacetInformationRequest
* @return Result of the GetTypedLinkFacetInformation operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @sample AmazonCloudDirectory.GetTypedLinkFacetInformation
* @see AWS API Documentation
*/
GetTypedLinkFacetInformationResult getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest);
/**
*
* Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor
* version.
*
*
* @param listAppliedSchemaArnsRequest
* @return Result of the ListAppliedSchemaArns operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListAppliedSchemaArns
* @see AWS API Documentation
*/
ListAppliedSchemaArnsResult listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest);
/**
*
* Lists indices attached to the specified object.
*
*
* @param listAttachedIndicesRequest
* @return Result of the ListAttachedIndices operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.ListAttachedIndices
* @see AWS API Documentation
*/
ListAttachedIndicesResult listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest);
/**
*
* Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
*
*
* @param listDevelopmentSchemaArnsRequest
* @return Result of the ListDevelopmentSchemaArns operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListDevelopmentSchemaArns
* @see AWS API Documentation
*/
ListDevelopmentSchemaArnsResult listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest);
/**
*
* Lists directories created within an account.
*
*
* @param listDirectoriesRequest
* @return Result of the ListDirectories operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListDirectories
* @see AWS
* API Documentation
*/
ListDirectoriesResult listDirectories(ListDirectoriesRequest listDirectoriesRequest);
/**
*
* Retrieves attributes attached to the facet.
*
*
* @param listFacetAttributesRequest
* @return Result of the ListFacetAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListFacetAttributes
* @see AWS API Documentation
*/
ListFacetAttributesResult listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest);
/**
*
* Retrieves the names of facets that exist in a schema.
*
*
* @param listFacetNamesRequest
* @return Result of the ListFacetNames operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListFacetNames
* @see AWS
* API Documentation
*/
ListFacetNamesResult listFacetNames(ListFacetNamesRequest listFacetNamesRequest);
/**
*
* 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.
*
*
* @param listIncomingTypedLinksRequest
* @return Result of the ListIncomingTypedLinks operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.ListIncomingTypedLinks
* @see AWS API Documentation
*/
ListIncomingTypedLinksResult listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest);
/**
*
* Lists objects attached to the specified index.
*
*
* @param listIndexRequest
* @return Result of the ListIndex operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws NotIndexException
* Indicates that the requested operation can only operate on index objects.
* @sample AmazonCloudDirectory.ListIndex
* @see AWS API
* Documentation
*/
ListIndexResult listIndex(ListIndexRequest listIndexRequest);
/**
*
* 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.
*
*
* @param listManagedSchemaArnsRequest
* @return Result of the ListManagedSchemaArns operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListManagedSchemaArns
* @see AWS API Documentation
*/
ListManagedSchemaArnsResult listManagedSchemaArns(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest);
/**
*
* Lists all attributes that are associated with an object.
*
*
* @param listObjectAttributesRequest
* @return Result of the ListObjectAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.ListObjectAttributes
* @see AWS API Documentation
*/
ListObjectAttributesResult listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest);
/**
*
* Returns a paginated list of child objects that are associated with a given object.
*
*
* @param listObjectChildrenRequest
* @return Result of the ListObjectChildren operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws 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.
* @sample AmazonCloudDirectory.ListObjectChildren
* @see AWS API Documentation
*/
ListObjectChildrenResult listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest);
/**
*
* 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.
*
*
* @param listObjectParentPathsRequest
* @return Result of the ListObjectParentPaths operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.ListObjectParentPaths
* @see AWS API Documentation
*/
ListObjectParentPathsResult listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest);
/**
*
* Lists parent objects that are associated with a given object in pagination fashion.
*
*
* @param listObjectParentsRequest
* @return Result of the ListObjectParents operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws CannotListParentOfRootException
* Cannot list the parents of a Directory root.
* @sample AmazonCloudDirectory.ListObjectParents
* @see AWS API Documentation
*/
ListObjectParentsResult listObjectParents(ListObjectParentsRequest listObjectParentsRequest);
/**
*
* Returns policies attached to an object in pagination fashion.
*
*
* @param listObjectPoliciesRequest
* @return Result of the ListObjectPolicies operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListObjectPolicies
* @see AWS API Documentation
*/
ListObjectPoliciesResult listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest);
/**
*
* 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.
*
*
* @param listOutgoingTypedLinksRequest
* @return Result of the ListOutgoingTypedLinks operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.ListOutgoingTypedLinks
* @see AWS API Documentation
*/
ListOutgoingTypedLinksResult listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest);
/**
*
* Returns all of the ObjectIdentifiers to which a given policy is attached.
*
*
* @param listPolicyAttachmentsRequest
* @return Result of the ListPolicyAttachments operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws NotPolicyException
* Indicates that the requested operation can only operate on policy objects.
* @sample AmazonCloudDirectory.ListPolicyAttachments
* @see AWS API Documentation
*/
ListPolicyAttachmentsResult listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest);
/**
*
* 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.
*
*
* @param listPublishedSchemaArnsRequest
* @return Result of the ListPublishedSchemaArns operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListPublishedSchemaArns
* @see AWS API Documentation
*/
ListPublishedSchemaArnsResult listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @sample AmazonCloudDirectory.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more
* information, see Typed Links.
*
*
* @param listTypedLinkFacetAttributesRequest
* @return Result of the ListTypedLinkFacetAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListTypedLinkFacetAttributes
* @see AWS API Documentation
*/
ListTypedLinkFacetAttributesResult listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest);
/**
*
* Returns a paginated list of TypedLink facet names for a particular schema. For more information, see
* Typed Links.
*
*
* @param listTypedLinkFacetNamesRequest
* @return Result of the ListTypedLinkFacetNames operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @sample AmazonCloudDirectory.ListTypedLinkFacetNames
* @see AWS API Documentation
*/
ListTypedLinkFacetNamesResult listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest);
/**
*
* 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.
*
*
* @param lookupPolicyRequest
* @return Result of the LookupPolicy operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws InvalidNextTokenException
* Indicates that the NextToken value is not valid.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.LookupPolicy
* @see AWS
* API Documentation
*/
LookupPolicyResult lookupPolicy(LookupPolicyRequest lookupPolicyRequest);
/**
*
* Publishes a development schema with a major version and a recommended minor version.
*
*
* @param publishSchemaRequest
* @return Result of the PublishSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws SchemaAlreadyPublishedException
* Indicates that a schema is already published.
* @sample AmazonCloudDirectory.PublishSchema
* @see AWS
* API Documentation
*/
PublishSchemaResult publishSchema(PublishSchemaRequest publishSchemaRequest);
/**
*
* Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON
* Schema Format for more information.
*
*
* @param putSchemaFromJsonRequest
* @return Result of the PutSchemaFromJson operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws InvalidSchemaDocException
* Indicates that the provided SchemaDoc value is not valid.
* @throws InvalidRuleException
* Occurs when any of the rule parameter keys or values are invalid.
* @sample AmazonCloudDirectory.PutSchemaFromJson
* @see AWS API Documentation
*/
PutSchemaFromJsonResult putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest);
/**
*
* Removes the specified facet from the specified object.
*
*
* @param removeFacetFromObjectRequest
* @return Result of the RemoveFacetFromObject operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.RemoveFacetFromObject
* @see AWS API Documentation
*/
RemoveFacetFromObjectResult removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest);
/**
*
* An API operation for adding tags to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @sample AmazonCloudDirectory.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* An API operation for removing tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @sample AmazonCloudDirectory.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Does the following:
*
*
* -
*
* Adds new Attributes, Rules, or ObjectTypes.
*
*
* -
*
* Updates existing Attributes, Rules, or ObjectTypes.
*
*
* -
*
* Deletes existing Attributes, Rules, or ObjectTypes.
*
*
*
*
* @param updateFacetRequest
* @return Result of the UpdateFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws InvalidFacetUpdateException
* An attempt to modify a Facet resulted in an invalid schema exception.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @throws InvalidRuleException
* Occurs when any of the rule parameter keys or values are invalid.
* @sample AmazonCloudDirectory.UpdateFacet
* @see AWS API
* Documentation
*/
UpdateFacetResult updateFacet(UpdateFacetRequest updateFacetRequest);
/**
*
* 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.
*
*
* @param updateLinkAttributesRequest
* @return Result of the UpdateLinkAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.UpdateLinkAttributes
* @see AWS API Documentation
*/
UpdateLinkAttributesResult updateLinkAttributes(UpdateLinkAttributesRequest updateLinkAttributesRequest);
/**
*
* Updates a given object's attributes.
*
*
* @param updateObjectAttributesRequest
* @return Result of the UpdateObjectAttributes operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws DirectoryNotEnabledException
* Operations are only permitted on enabled directories.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws LinkNameAlreadyInUseException
* Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
* again.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @sample AmazonCloudDirectory.UpdateObjectAttributes
* @see AWS API Documentation
*/
UpdateObjectAttributesResult updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest);
/**
*
* Updates the schema name with a new name. Only development schema names can be updated.
*
*
* @param updateSchemaRequest
* @return Result of the UpdateSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @sample AmazonCloudDirectory.UpdateSchema
* @see AWS
* API Documentation
*/
UpdateSchemaResult updateSchema(UpdateSchemaRequest updateSchemaRequest);
/**
*
* Updates a TypedLinkFacet. For more information, see Typed Links.
*
*
* @param updateTypedLinkFacetRequest
* @return Result of the UpdateTypedLinkFacet operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @throws 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.
* @throws FacetValidationException
* The Facet that you provided was not well formed or could not be validated with the schema.
* @throws InvalidFacetUpdateException
* An attempt to modify a Facet resulted in an invalid schema exception.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws FacetNotFoundException
* The specified Facet could not be found.
* @throws InvalidRuleException
* Occurs when any of the rule parameter keys or values are invalid.
* @sample AmazonCloudDirectory.UpdateTypedLinkFacet
* @see AWS API Documentation
*/
UpdateTypedLinkFacetResult updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest);
/**
*
* 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.
*
*
* @param upgradeAppliedSchemaRequest
* @return Result of the UpgradeAppliedSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws 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.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @throws SchemaAlreadyExistsException
* Indicates that a schema could not be created due to a naming conflict. Please select a different name and
* then try again.
* @sample AmazonCloudDirectory.UpgradeAppliedSchema
* @see AWS API Documentation
*/
UpgradeAppliedSchemaResult upgradeAppliedSchema(UpgradeAppliedSchemaRequest upgradeAppliedSchemaRequest);
/**
*
* Upgrades a published schema under a new minor version revision using the current contents of
* DevelopmentSchemaArn.
*
*
* @param upgradePublishedSchemaRequest
* @return Result of the UpgradePublishedSchema operation returned by the service.
* @throws InternalServiceException
* Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
* which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
* operational issues with the service.
* @throws InvalidArnException
* Indicates that the provided ARN value is not valid.
* @throws 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.
* @throws ValidationException
* Indicates that your request is malformed in some manner. See the exception message.
* @throws 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.
* @throws 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.
* @throws ResourceNotFoundException
* The specified resource could not be found.
* @throws 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.
* @throws LimitExceededException
* Indicates that limits are exceeded. See Limits for more
* information.
* @sample AmazonCloudDirectory.UpgradePublishedSchema
* @see AWS API Documentation
*/
UpgradePublishedSchemaResult upgradePublishedSchema(UpgradePublishedSchemaRequest upgradePublishedSchemaRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy