@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudDirectory
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudDirectory instead.
Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddFacetToObjectResult |
addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)
Adds a new Facet to an object.
|
ApplySchemaResult |
applySchema(ApplySchemaRequest applySchemaRequest)
Copies the input published schema into the Directory with the same name and version as that of the
published schema .
|
AttachObjectResult |
attachObject(AttachObjectRequest attachObjectRequest)
Attaches an existing object to another object.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy object to a regular object.
|
AttachToIndexResult |
attachToIndex(AttachToIndexRequest attachToIndexRequest)
Attaches the specified object to the specified index.
|
AttachTypedLinkResult |
attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)
Attaches a typed link to a specified source and target object.
|
BatchReadResult |
batchRead(BatchReadRequest batchReadRequest)
Performs all the read operations in a batch.
|
BatchWriteResult |
batchWrite(BatchWriteRequest batchWriteRequest)
Performs all the write operations in a batch.
|
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Directory by copying the published schema into the directory.
|
CreateFacetResult |
createFacet(CreateFacetRequest createFacetRequest)
Creates a new Facet in a schema.
|
CreateIndexResult |
createIndex(CreateIndexRequest createIndexRequest)
Creates an index object.
|
CreateObjectResult |
createObject(CreateObjectRequest createObjectRequest)
Creates an object in a Directory.
|
CreateSchemaResult |
createSchema(CreateSchemaRequest createSchemaRequest)
Creates a new schema in a development state.
|
CreateTypedLinkFacetResult |
createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest)
Creates a TypedLinkFacet.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes a directory.
|
DeleteFacetResult |
deleteFacet(DeleteFacetRequest deleteFacetRequest)
Deletes a given Facet.
|
DeleteObjectResult |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Deletes an object and its associated attributes.
|
DeleteSchemaResult |
deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a given schema.
|
DeleteTypedLinkFacetResult |
deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest)
Deletes a TypedLinkFacet.
|
DetachFromIndexResult |
detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)
Detaches the specified object from the specified index.
|
DetachObjectResult |
detachObject(DetachObjectRequest detachObjectRequest)
Detaches a given object from the parent object.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from an object.
|
DetachTypedLinkResult |
detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest)
Detaches a typed link from a specified source and target object.
|
DisableDirectoryResult |
disableDirectory(DisableDirectoryRequest disableDirectoryRequest)
Disables the specified directory.
|
EnableDirectoryResult |
enableDirectory(EnableDirectoryRequest enableDirectoryRequest)
Enables the specified directory.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDirectoryResult |
getDirectory(GetDirectoryRequest getDirectoryRequest)
Retrieves metadata about a directory.
|
GetFacetResult |
getFacet(GetFacetRequest getFacetRequest)
|
GetObjectInformationResult |
getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)
Retrieves metadata about an object.
|
GetSchemaAsJsonResult |
getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)
Retrieves a JSON representation of the schema.
|
GetTypedLinkFacetInformationResult |
getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)
Returns the identity attribute order for a specific TypedLinkFacet.
|
ListAppliedSchemaArnsResult |
listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
ListAttachedIndicesResult |
listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
|
ListDevelopmentSchemaArnsResult |
listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
ListDirectoriesResult |
listDirectories(ListDirectoriesRequest listDirectoriesRequest)
Lists directories created within an account.
|
ListFacetAttributesResult |
listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)
Retrieves attributes attached to the facet.
|
ListFacetNamesResult |
listFacetNames(ListFacetNamesRequest listFacetNamesRequest)
Retrieves the names of facets that exist in a schema.
|
ListIncomingTypedLinksResult |
listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest)
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
|
ListIndexResult |
listIndex(ListIndexRequest listIndexRequest)
Lists objects attached to the specified index.
|
ListObjectAttributesResult |
listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)
Lists all attributes that are associated with an object.
|
ListObjectChildrenResult |
listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)
Returns a paginated list of child objects that are associated with a given object.
|
ListObjectParentPathsResult |
listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest)
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
objects.
|
ListObjectParentsResult |
listObjectParents(ListObjectParentsRequest listObjectParentsRequest)
Lists parent objects that are associated with a given object in pagination fashion.
|
ListObjectPoliciesResult |
listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)
Returns policies attached to an object in pagination fashion.
|
ListOutgoingTypedLinksResult |
listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest)
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
|
ListPolicyAttachmentsResult |
listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the
ObjectIdentifiers to which a given policy is attached. |
ListPublishedSchemaArnsResult |
listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns tags for a resource.
|
ListTypedLinkFacetAttributesResult |
listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
ListTypedLinkFacetNamesResult |
listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)
Returns a paginated list of
TypedLink facet names for a particular schema. |
LookupPolicyResult |
lookupPolicy(LookupPolicyRequest lookupPolicyRequest)
Lists all policies from the root of the Directory to the object specified.
|
PublishSchemaResult |
publishSchema(PublishSchemaRequest publishSchemaRequest)
Publishes a development schema with a version.
|
PutSchemaFromJsonResult |
putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)
Allows a schema to be updated using JSON upload.
|
RemoveFacetFromObjectResult |
removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)
Removes the specified facet from the specified object.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
An API operation for adding tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
An API operation for removing tags from a resource.
|
UpdateFacetResult |
updateFacet(UpdateFacetRequest updateFacetRequest)
Does the following:
|
UpdateObjectAttributesResult |
updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)
Updates a given object's attributes.
|
UpdateSchemaResult |
updateSchema(UpdateSchemaRequest updateSchemaRequest)
Updates the schema name with a new name.
|
UpdateTypedLinkFacetResult |
updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest)
Updates a TypedLinkFacet.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
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 void setRegion(Region region)
AwsClientBuilder#setRegion(String)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
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.
region - The region this client will communicate with. See 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AddFacetToObjectResult addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)
Adds a new Facet to an object.
addFacetToObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.ApplySchemaResult applySchema(ApplySchemaRequest applySchemaRequest)
Copies the input published schema into the Directory with the same name and version as that of the published schema .
applySchemaRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.AttachObjectResult attachObject(AttachObjectRequest attachObjectRequest)
Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using ObjectIdentifier
attachObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException - Indicates that your request is malformed in some manner. See the exception message.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.AttachPolicyResult attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
attachPolicyRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates that the requested operation can only operate on policy objects.AttachToIndexResult attachToIndex(AttachToIndexRequest attachToIndexRequest)
Attaches the specified object to the specified index.
attachToIndexRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.IndexedAttributeMissingException - An object has been attempted to be attached to an object that does not have the appropriate attribute
value.NotIndexException - Indicates that the requested operation can only operate on index objects.AttachTypedLinkResult attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)
Attaches a typed link to a specified source and target object. For more information, see Typed link.
attachTypedLinkRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.InvalidAttachmentException - Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException - Indicates that your request is malformed in some manner. See the exception message.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.BatchReadResult batchRead(BatchReadRequest batchReadRequest)
Performs all the read operations in a batch.
batchReadRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.BatchWriteResult batchWrite(BatchWriteRequest batchWriteRequest)
Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.
batchWriteRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.BatchWriteException - A BatchWrite exception has occurred.CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
createDirectoryRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryAlreadyExistsException - Indicates that a Directory could not be created due to a naming conflict. Choose a different name
and try again.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.CreateFacetResult createFacet(CreateFacetRequest createFacetRequest)
Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
createFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetAlreadyExistsException - A facet with the same name already exists.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
Creates an index object. See Indexing for more information.
createIndexRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException - Indicates that the requested index type is not supported.CreateObjectResult createObject(CreateObjectRequest createObjectRequest)
Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and
LinkName is specified. An object is simply a collection of Facet attributes. You can also use
this API call to create a policy object, if the facet from which you create the object is a policy facet.
createObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException - Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException - Indicates that the requested index type is not supported.CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest)
Creates a new schema in a development state. A schema can exist in three phases:
Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
Published: Published schemas are immutable and have a version associated with them.
Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.
createSchemaRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.SchemaAlreadyExistsException - Indicates that a schema could not be created due to a naming conflict. Please select a different name and
then try again.AccessDeniedException - Access denied. Check your permissions.CreateTypedLinkFacetResult createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest)
Creates a TypedLinkFacet. For more information, see Typed link.
createTypedLinkFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetAlreadyExistsException - A facet with the same name already exists.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
deleteDirectoryRequest - ResourceNotFoundException - The specified resource could not be found.DirectoryNotDisabledException - An operation can only operate on a disabled directory.InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException - Indicates that the provided ARN value is not valid.DeleteFacetResult deleteFacet(DeleteFacetRequest deleteFacetRequest)
Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
deleteFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.FacetInUseException - Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a
different facet.DeleteObjectResult deleteObject(DeleteObjectRequest deleteObjectRequest)
Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.
deleteObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.ObjectNotDetachedException - Indicates that the requested operation cannot be completed because the object has not been detached from
the tree.DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a given schema. Schemas in a development and published state can only be deleted.
deleteSchemaRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.StillContainsLinksException - The object could not be deleted because links still exist. Remove the links and then try the operation
again.DeleteTypedLinkFacetResult deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest)
Deletes a TypedLinkFacet. For more information, see Typed link.
deleteTypedLinkFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.DetachFromIndexResult detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)
Detaches the specified object from the specified index.
detachFromIndexRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.ObjectAlreadyDetachedException - Indicates that the object is not attached to the index.NotIndexException - Indicates that the requested operation can only operate on index objects.DetachObjectResult detachObject(DetachObjectRequest detachObjectRequest)
Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
detachObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.DetachPolicyResult detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from an object.
detachPolicyRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates that the requested operation can only operate on policy objects.DetachTypedLinkResult detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest)
Detaches a typed link from a specified source and target object. For more information, see Typed link.
detachTypedLinkRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.DisableDirectoryResult disableDirectory(DisableDirectoryRequest disableDirectoryRequest)
Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
disableDirectoryRequest - ResourceNotFoundException - The specified resource could not be found.DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException - Indicates that the provided ARN value is not valid.EnableDirectoryResult enableDirectory(EnableDirectoryRequest enableDirectoryRequest)
Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
enableDirectoryRequest - ResourceNotFoundException - The specified resource could not be found.DirectoryDeletedException - A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException - Indicates that the provided ARN value is not valid.GetDirectoryResult getDirectory(GetDirectoryRequest getDirectoryRequest)
Retrieves metadata about a directory.
getDirectoryRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.GetFacetResult getFacet(GetFacetRequest getFacetRequest)
Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You
can call this on all kinds of schema facets -- published, development, or applied.
getFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.GetObjectInformationResult getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)
Retrieves metadata about an object.
getObjectInformationRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.GetSchemaAsJsonResult getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)
Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
getSchemaAsJsonRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.ValidationException - Indicates that your request is malformed in some manner. See the exception message.GetTypedLinkFacetInformationResult getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)
Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.
getTypedLinkFacetInformationRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.FacetNotFoundException - The specified Facet could not be found.ListAppliedSchemaArnsResult listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
listAppliedSchemaArnsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListAttachedIndicesResult listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
listAttachedIndicesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.ListDevelopmentSchemaArnsResult listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
listDevelopmentSchemaArnsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListDirectoriesResult listDirectories(ListDirectoriesRequest listDirectoriesRequest)
Lists directories created within an account.
listDirectoriesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListFacetAttributesResult listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)
Retrieves attributes attached to the facet.
listFacetAttributesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListFacetNamesResult listFacetNames(ListFacetNamesRequest listFacetNamesRequest)
Retrieves the names of facets that exist in a schema.
listFacetNamesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListIncomingTypedLinksResult listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest)
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.
listIncomingTypedLinksRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.ListIndexResult listIndex(ListIndexRequest listIndexRequest)
Lists objects attached to the specified index.
listIndexRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.NotIndexException - Indicates that the requested operation can only operate on index objects.ListObjectAttributesResult listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)
Lists all attributes that are associated with an object.
listObjectAttributesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.ListObjectChildrenResult listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)
Returns a paginated list of child objects that are associated with a given object.
listObjectChildrenRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.NotNodeException - Occurs when any invalid operations are performed on an object that is not a node, such as calling
ListObjectChildren for a leaf node object.ListObjectParentPathsResult listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest)
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.
listObjectParentPathsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidNextTokenException - Indicates that the NextToken value is not valid.ResourceNotFoundException - The specified resource could not be found.ListObjectParentsResult listObjectParents(ListObjectParentsRequest listObjectParentsRequest)
Lists parent objects that are associated with a given object in pagination fashion.
listObjectParentsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.CannotListParentOfRootException - Cannot list the parents of a Directory root.ListObjectPoliciesResult listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)
Returns policies attached to an object in pagination fashion.
listObjectPoliciesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListOutgoingTypedLinksResult listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest)
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.
listOutgoingTypedLinksRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.ListPolicyAttachmentsResult listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the ObjectIdentifiers to which a given policy is attached.
listPolicyAttachmentsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.InvalidNextTokenException - Indicates that the NextToken value is not valid.ResourceNotFoundException - The specified resource could not be found.NotPolicyException - Indicates that the requested operation can only operate on policy objects.ListPublishedSchemaArnsResult listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
listPublishedSchemaArnsRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.
listTagsForResourceRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.ListTypedLinkFacetAttributesResult listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.
listTypedLinkFacetAttributesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.ListTypedLinkFacetNamesResult listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)
Returns a paginated list of TypedLink facet names for a particular schema. For more information, see
Typed
link.
listTypedLinkFacetNamesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidNextTokenException - Indicates that the NextToken value is not valid.LookupPolicyResult lookupPolicy(LookupPolicyRequest lookupPolicyRequest)
Lists all policies from the root of the Directory to the object specified. If there are no policies
present, an empty list is returned. If policies are present, and if some objects don't have the policies
attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns
ObjectIdentifier, policyId, and policyType. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
lookupPolicyRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.InvalidArnException - Indicates that the provided ARN value is not valid.InvalidNextTokenException - Indicates that the NextToken value is not valid.ResourceNotFoundException - The specified resource could not be found.PublishSchemaResult publishSchema(PublishSchemaRequest publishSchemaRequest)
Publishes a development schema with a version. If description and attributes are specified,
PublishSchema overrides the development schema description and attributes. If not, the development
schema description and attributes are used.
publishSchemaRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.SchemaAlreadyPublishedException - Indicates that a schema is already published.PutSchemaFromJsonResult putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
putSchemaFromJsonRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidSchemaDocException - Indicates that the provided SchemaDoc value is not valid.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.RemoveFacetFromObjectResult removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)
Removes the specified facet from the specified object.
removeFacetFromObjectRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
An API operation for adding tags to a resource.
tagResourceRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
An API operation for removing tags from a resource.
untagResourceRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.InvalidTaggingRequestException - Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.UpdateFacetResult updateFacet(UpdateFacetRequest updateFacetRequest)
Does the following:
Adds new Attributes, Rules, or ObjectTypes.
Updates existing Attributes, Rules, or ObjectTypes.
Deletes existing Attributes, Rules, or ObjectTypes.
updateFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.InvalidFacetUpdateException - An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.UpdateObjectAttributesResult updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)
Updates a given object's attributes.
updateObjectAttributesRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.DirectoryNotEnabledException - An operation can only operate on a directory that is not enabled.ResourceNotFoundException - The specified resource could not be found.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.UpdateSchemaResult updateSchema(UpdateSchemaRequest updateSchemaRequest)
Updates the schema name with a new name. Only development schema names can be updated.
updateSchemaRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.ResourceNotFoundException - The specified resource could not be found.UpdateTypedLinkFacetResult updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest)
Updates a TypedLinkFacet. For more information, see Typed link.
updateTypedLinkFacetRequest - InternalServiceException - Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException - Indicates that the provided ARN value is not valid.RetryableConflictException - Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException - Indicates that your request is malformed in some manner. See the exception message.LimitExceededException - Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException - Access denied. Check your permissions.FacetValidationException - The Facet that you provided was not well formed or could not be validated with the schema.InvalidFacetUpdateException - An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException - The specified resource could not be found.FacetNotFoundException - The specified Facet could not be found.InvalidRuleException - Occurs when any of the rule parameter keys or values are invalid.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.