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