AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CloudDirectory Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

Inheritance Hierarchy

Amazon.CloudDirectory.IAmazonCloudDirectory

Namespace: Amazon.CloudDirectory
Assembly: AWSSDK.CloudDirectory.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCloudDirectory
         IAmazonService, IDisposable

The IAmazonCloudDirectory type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddFacetToObject(AddFacetToObjectRequest)

Adds a new Facet to an object.

Public Method AddFacetToObjectAsync(AddFacetToObjectRequest, CancellationToken)

Initiates the asynchronous execution of the AddFacetToObject operation.

Public Method ApplySchema(ApplySchemaRequest)

Copies the input published schema into the Directory with the same name and version as that of the published schema .

Public Method ApplySchemaAsync(ApplySchemaRequest, CancellationToken)

Initiates the asynchronous execution of the ApplySchema operation.

Public Method AttachObject(AttachObjectRequest)

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

Public Method AttachObjectAsync(AttachObjectRequest, CancellationToken)

Initiates the asynchronous execution of the AttachObject operation.

Public Method AttachPolicy(AttachPolicyRequest)

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

Public Method AttachPolicyAsync(AttachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachPolicy operation.

Public Method AttachToIndex(AttachToIndexRequest)

Attaches the specified object to the specified index.

Public Method AttachToIndexAsync(AttachToIndexRequest, CancellationToken)

Initiates the asynchronous execution of the AttachToIndex operation.

Public Method AttachTypedLink(AttachTypedLinkRequest)

Attaches a typed link to a specified source and target object. For more information, see Typed link.

Public Method AttachTypedLinkAsync(AttachTypedLinkRequest, CancellationToken)

Initiates the asynchronous execution of the AttachTypedLink operation.

Public Method BatchRead(BatchReadRequest)

Performs all the read operations in a batch.

Public Method BatchReadAsync(BatchReadRequest, CancellationToken)

Initiates the asynchronous execution of the BatchRead operation.

Public Method BatchWrite(BatchWriteRequest)

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

Public Method BatchWriteAsync(BatchWriteRequest, CancellationToken)

Initiates the asynchronous execution of the BatchWrite operation.

Public Method CreateDirectory(CreateDirectoryRequest)

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

Public Method CreateDirectoryAsync(CreateDirectoryRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDirectory operation.

Public Method CreateFacet(CreateFacetRequest)

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Public Method CreateFacetAsync(CreateFacetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateFacet operation.

Public Method CreateIndex(CreateIndexRequest)

Creates an index object. See Indexing for more information.

Public Method CreateIndexAsync(CreateIndexRequest, CancellationToken)

Initiates the asynchronous execution of the CreateIndex operation.

Public Method CreateObject(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.

Public Method CreateObjectAsync(CreateObjectRequest, CancellationToken)

Initiates the asynchronous execution of the CreateObject operation.

Public Method CreateSchema(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.

Public Method CreateSchemaAsync(CreateSchemaRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSchema operation.

Public Method CreateTypedLinkFacet(CreateTypedLinkFacetRequest)

Creates a TypedLinkFacet. For more information, see Typed link.

Public Method CreateTypedLinkFacetAsync(CreateTypedLinkFacetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTypedLinkFacet operation.

Public Method DeleteDirectory(DeleteDirectoryRequest)

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

Public Method DeleteDirectoryAsync(DeleteDirectoryRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDirectory operation.

Public Method DeleteFacet(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.

Public Method DeleteFacetAsync(DeleteFacetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteFacet operation.

Public Method DeleteObject(DeleteObjectRequest)

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

Public Method DeleteObjectAsync(DeleteObjectRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteObject operation.

Public Method DeleteSchema(DeleteSchemaRequest)

Deletes a given schema. Schemas in a development and published state can only be deleted.

Public Method DeleteSchemaAsync(DeleteSchemaRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSchema operation.

Public Method DeleteTypedLinkFacet(DeleteTypedLinkFacetRequest)

Deletes a TypedLinkFacet. For more information, see Typed link.

Public Method DeleteTypedLinkFacetAsync(DeleteTypedLinkFacetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTypedLinkFacet operation.

Public Method DetachFromIndex(DetachFromIndexRequest)

Detaches the specified object from the specified index.

Public Method DetachFromIndexAsync(DetachFromIndexRequest, CancellationToken)

Initiates the asynchronous execution of the DetachFromIndex operation.

Public Method DetachObject(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.

Public Method DetachObjectAsync(DetachObjectRequest, CancellationToken)

Initiates the asynchronous execution of the DetachObject operation.

Public Method DetachPolicy(DetachPolicyRequest)

Detaches a policy from an object.

Public Method DetachPolicyAsync(DetachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachPolicy operation.

Public Method DetachTypedLink(DetachTypedLinkRequest)

Detaches a typed link from a specified source and target object. For more information, see Typed link.

Public Method DetachTypedLinkAsync(DetachTypedLinkRequest, CancellationToken)

Initiates the asynchronous execution of the DetachTypedLink operation.

Public Method DisableDirectory(DisableDirectoryRequest)

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

Public Method DisableDirectoryAsync(DisableDirectoryRequest, CancellationToken)

Initiates the asynchronous execution of the DisableDirectory operation.

Public Method EnableDirectory(EnableDirectoryRequest)

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Public Method EnableDirectoryAsync(EnableDirectoryRequest, CancellationToken)

Initiates the asynchronous execution of the EnableDirectory operation.

Public Method GetDirectory(GetDirectoryRequest)

Retrieves metadata about a directory.

Public Method GetDirectoryAsync(GetDirectoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetDirectory operation.

Public Method GetFacet(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.

Public Method GetFacetAsync(GetFacetRequest, CancellationToken)

Initiates the asynchronous execution of the GetFacet operation.

Public Method GetObjectInformation(GetObjectInformationRequest)

Retrieves metadata about an object.

Public Method GetObjectInformationAsync(GetObjectInformationRequest, CancellationToken)

Initiates the asynchronous execution of the GetObjectInformation operation.

Public Method GetSchemaAsJson(GetSchemaAsJsonRequest)

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

Public Method GetSchemaAsJsonAsync(GetSchemaAsJsonRequest, CancellationToken)

Initiates the asynchronous execution of the GetSchemaAsJson operation.

Public Method GetTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest)

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.

Public Method GetTypedLinkFacetInformationAsync(GetTypedLinkFacetInformationRequest, CancellationToken)

Initiates the asynchronous execution of the GetTypedLinkFacetInformation operation.

Public Method ListAppliedSchemaArns(ListAppliedSchemaArnsRequest)

Lists schemas applied to a directory.

Public Method ListAppliedSchemaArnsAsync(ListAppliedSchemaArnsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAppliedSchemaArns operation.

Public Method ListAttachedIndices(ListAttachedIndicesRequest)

Lists indices attached to an object.

Public Method ListAttachedIndicesAsync(ListAttachedIndicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttachedIndices operation.

Public Method ListDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest)

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

Public Method ListDevelopmentSchemaArnsAsync(ListDevelopmentSchemaArnsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDevelopmentSchemaArns operation.

Public Method ListDirectories(ListDirectoriesRequest)

Lists directories created within an account.

Public Method ListDirectoriesAsync(ListDirectoriesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDirectories operation.

Public Method ListFacetAttributes(ListFacetAttributesRequest)

Retrieves attributes attached to the facet.

Public Method ListFacetAttributesAsync(ListFacetAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the ListFacetAttributes operation.

Public Method ListFacetNames(ListFacetNamesRequest)

Retrieves the names of facets that exist in a schema.

Public Method ListFacetNamesAsync(ListFacetNamesRequest, CancellationToken)

Initiates the asynchronous execution of the ListFacetNames operation.

Public Method ListIncomingTypedLinks(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.

Public Method ListIncomingTypedLinksAsync(ListIncomingTypedLinksRequest, CancellationToken)

Initiates the asynchronous execution of the ListIncomingTypedLinks operation.

Public Method ListIndex(ListIndexRequest)

Lists objects attached to the specified index.

Public Method ListIndexAsync(ListIndexRequest, CancellationToken)

Initiates the asynchronous execution of the ListIndex operation.

Public Method ListObjectAttributes(ListObjectAttributesRequest)

Lists all attributes that are associated with an object.

Public Method ListObjectAttributesAsync(ListObjectAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the ListObjectAttributes operation.

Public Method ListObjectChildren(ListObjectChildrenRequest)

Returns a paginated list of child objects that are associated with a given object.

Public Method ListObjectChildrenAsync(ListObjectChildrenRequest, CancellationToken)

Initiates the asynchronous execution of the ListObjectChildren operation.

Public Method ListObjectParentPaths(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.

Public Method ListObjectParentPathsAsync(ListObjectParentPathsRequest, CancellationToken)

Initiates the asynchronous execution of the ListObjectParentPaths operation.

Public Method ListObjectParents(ListObjectParentsRequest)

Lists parent objects that are associated with a given object in pagination fashion.

Public Method ListObjectParentsAsync(ListObjectParentsRequest, CancellationToken)

Initiates the asynchronous execution of the ListObjectParents operation.

Public Method ListObjectPolicies(ListObjectPoliciesRequest)

Returns policies attached to an object in pagination fashion.

Public Method ListObjectPoliciesAsync(ListObjectPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListObjectPolicies operation.

Public Method ListOutgoingTypedLinks(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.

Public Method ListOutgoingTypedLinksAsync(ListOutgoingTypedLinksRequest, CancellationToken)

Initiates the asynchronous execution of the ListOutgoingTypedLinks operation.

Public Method ListPolicyAttachments(ListPolicyAttachmentsRequest)

Returns all of the ObjectIdentifiers to which a given policy is attached.

Public Method ListPolicyAttachmentsAsync(ListPolicyAttachmentsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicyAttachments operation.

Public Method ListPublishedSchemaArns(ListPublishedSchemaArnsRequest)

Retrieves each published schema Amazon Resource Name (ARN).

Public Method ListPublishedSchemaArnsAsync(ListPublishedSchemaArnsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPublishedSchemaArns operation.

Public Method ListTagsForResource(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.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method ListTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest)

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.

Public Method ListTypedLinkFacetAttributesAsync(ListTypedLinkFacetAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTypedLinkFacetAttributes operation.

Public Method ListTypedLinkFacetNames(ListTypedLinkFacetNamesRequest)

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link.

Public Method ListTypedLinkFacetNamesAsync(ListTypedLinkFacetNamesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTypedLinkFacetNames operation.

Public Method LookupPolicy(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.

Public Method LookupPolicyAsync(LookupPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the LookupPolicy operation.

Public Method PublishSchema(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.

Public Method PublishSchemaAsync(PublishSchemaRequest, CancellationToken)

Initiates the asynchronous execution of the PublishSchema operation.

Public Method PutSchemaFromJson(PutSchemaFromJsonRequest)

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

Public Method PutSchemaFromJsonAsync(PutSchemaFromJsonRequest, CancellationToken)

Initiates the asynchronous execution of the PutSchemaFromJson operation.

Public Method RemoveFacetFromObject(RemoveFacetFromObjectRequest)

Removes the specified facet from the specified object.

Public Method RemoveFacetFromObjectAsync(RemoveFacetFromObjectRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveFacetFromObject operation.

Public Method TagResource(TagResourceRequest)

An API operation for adding tags to a resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

An API operation for removing tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Public Method UpdateFacet(UpdateFacetRequest)

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

Public Method UpdateFacetAsync(UpdateFacetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateFacet operation.

Public Method UpdateObjectAttributes(UpdateObjectAttributesRequest)

Updates a given object's attributes.

Public Method UpdateObjectAttributesAsync(UpdateObjectAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateObjectAttributes operation.

Public Method UpdateSchema(UpdateSchemaRequest)

Updates the schema name with a new name. Only development schema names can be updated.

Public Method UpdateSchemaAsync(UpdateSchemaRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSchema operation.

Public Method UpdateTypedLinkFacet(UpdateTypedLinkFacetRequest)

Updates a TypedLinkFacet. For more information, see Typed link.

Public Method UpdateTypedLinkFacetAsync(UpdateTypedLinkFacetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTypedLinkFacet operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms