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.

Implementation 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 Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudDirectory.AmazonCloudDirectoryClient

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

Syntax

C#
public class AmazonCloudDirectoryClient : AmazonServiceClient
         IAmazonCloudDirectory, IAmazonService, IDisposable

The AmazonCloudDirectoryClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudDirectoryClient()

Constructs AmazonCloudDirectoryClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCloudDirectoryClient(RegionEndpoint)

Constructs AmazonCloudDirectoryClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCloudDirectoryClient(AmazonCloudDirectoryConfig)

Constructs AmazonCloudDirectoryClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCloudDirectoryClient(AWSCredentials)

Constructs AmazonCloudDirectoryClient with AWS Credentials

Public Method AmazonCloudDirectoryClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCloudDirectoryClient with AWS Credentials

Public Method AmazonCloudDirectoryClient(AWSCredentials, AmazonCloudDirectoryConfig)

Constructs AmazonCloudDirectoryClient with AWS Credentials and an AmazonCloudDirectoryClient Configuration object.

Public Method AmazonCloudDirectoryClient(string, string)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudDirectoryClient(string, string, RegionEndpoint)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudDirectoryClient(string, string, AmazonCloudDirectoryConfig)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudDirectoryClient Configuration object.

Public Method AmazonCloudDirectoryClient(string, string, string)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudDirectoryClient(string, string, string, RegionEndpoint)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudDirectoryClient(string, string, string, AmazonCloudDirectoryConfig)

Constructs AmazonCloudDirectoryClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudDirectoryClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.CloudDirectory.Model.ICloudDirectoryPaginatorFactory

Paginators for the service

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. An object can have more than one facet applied on it.

Public Method AddFacetToObjectAsync(AddFacetToObjectRequest, CancellationToken)

Adds a new Facet to an object. An object can have more than one facet applied on it.

Public Method ApplySchema(ApplySchemaRequest)

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

Public Method ApplySchemaAsync(ApplySchemaRequest, CancellationToken)

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

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)

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

  1. Using the path

  2. Using ObjectIdentifier

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)

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

Public Method AttachToIndex(AttachToIndexRequest)

Attaches the specified object to the specified index.

Public Method AttachToIndexAsync(AttachToIndexRequest, CancellationToken)

Attaches the specified object to the specified index.

Public Method AttachTypedLink(AttachTypedLinkRequest)

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

Public Method AttachTypedLinkAsync(AttachTypedLinkRequest, CancellationToken)

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

Public Method BatchRead(BatchReadRequest)

Performs all the read operations in a batch.

Public Method BatchReadAsync(BatchReadRequest, CancellationToken)

Performs all the read operations in a batch.

Public Method BatchWrite(BatchWriteRequest)

Performs all the write operations in a batch. Either all the operations succeed or none.

Public Method BatchWriteAsync(BatchWriteRequest, CancellationToken)

Performs all the write operations in a batch. Either all the operations succeed or none.

Public Method CreateDirectory(CreateDirectoryRequest)

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

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

Public Method CreateDirectoryAsync(CreateDirectoryRequest, CancellationToken)

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

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

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)

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

Public Method CreateIndex(CreateIndexRequest)

Creates an index object. See Indexing and search for more information.

Public Method CreateIndexAsync(CreateIndexRequest, CancellationToken)

Creates an index object. See Indexing and search for more information.

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)

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 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)

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 CreateTypedLinkFacet(CreateTypedLinkFacetRequest)

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

Public Method CreateTypedLinkFacetAsync(CreateTypedLinkFacetRequest, CancellationToken)

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

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)

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

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)

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 DeleteObject(DeleteObjectRequest)

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

Public Method DeleteObjectAsync(DeleteObjectRequest, CancellationToken)

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

Public Method DeleteSchema(DeleteSchemaRequest)

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

Public Method DeleteSchemaAsync(DeleteSchemaRequest, CancellationToken)

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

Public Method DeleteTypedLinkFacet(DeleteTypedLinkFacetRequest)

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

Public Method DeleteTypedLinkFacetAsync(DeleteTypedLinkFacetRequest, CancellationToken)

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

Public Method DetachFromIndex(DetachFromIndexRequest)

Detaches the specified object from the specified index.

Public Method DetachFromIndexAsync(DetachFromIndexRequest, CancellationToken)

Detaches the specified object from the specified index.

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)

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 DetachPolicy(DetachPolicyRequest)

Detaches a policy from an object.

Public Method DetachPolicyAsync(DetachPolicyRequest, CancellationToken)

Detaches a policy from an object.

Public Method DetachTypedLink(DetachTypedLinkRequest)

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

Public Method DetachTypedLinkAsync(DetachTypedLinkRequest, CancellationToken)

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

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

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)

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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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)

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

Public Method GetAppliedSchemaVersion(GetAppliedSchemaVersionRequest)

Returns current applied schema version ARN, including the minor version in use.

Public Method GetAppliedSchemaVersionAsync(GetAppliedSchemaVersionRequest, CancellationToken)

Returns current applied schema version ARN, including the minor version in use.

Public Method GetDirectory(GetDirectoryRequest)

Retrieves metadata about a directory.

Public Method GetDirectoryAsync(GetDirectoryRequest, CancellationToken)

Retrieves metadata about a directory.

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)

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 GetLinkAttributes(GetLinkAttributesRequest)

Retrieves attributes that are associated with a typed link.

Public Method GetLinkAttributesAsync(GetLinkAttributesRequest, CancellationToken)

Retrieves attributes that are associated with a typed link.

Public Method GetObjectAttributes(GetObjectAttributesRequest)

Retrieves attributes within a facet that are associated with an object.

Public Method GetObjectAttributesAsync(GetObjectAttributesRequest, CancellationToken)

Retrieves attributes within a facet that are associated with an object.

Public Method GetObjectInformation(GetObjectInformationRequest)

Retrieves metadata about an object.

Public Method GetObjectInformationAsync(GetObjectInformationRequest, CancellationToken)

Retrieves metadata about an object.

Public Method GetSchemaAsJson(GetSchemaAsJsonRequest)

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

Public Method GetSchemaAsJsonAsync(GetSchemaAsJsonRequest, CancellationToken)

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

Public Method GetTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest)

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

Public Method GetTypedLinkFacetInformationAsync(GetTypedLinkFacetInformationRequest, CancellationToken)

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

Public Method ListAppliedSchemaArns(ListAppliedSchemaArnsRequest)

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

Public Method ListAppliedSchemaArnsAsync(ListAppliedSchemaArnsRequest, CancellationToken)

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

Public Method ListAttachedIndices(ListAttachedIndicesRequest)

Lists indices attached to the specified object.

Public Method ListAttachedIndicesAsync(ListAttachedIndicesRequest, CancellationToken)

Lists indices attached to the specified object.

Public Method ListDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest)

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

Public Method ListDevelopmentSchemaArnsAsync(ListDevelopmentSchemaArnsRequest, CancellationToken)

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

Public Method ListDirectories(ListDirectoriesRequest)

Lists directories created within an account.

Public Method ListDirectoriesAsync(ListDirectoriesRequest, CancellationToken)

Lists directories created within an account.

Public Method ListFacetAttributes(ListFacetAttributesRequest)

Retrieves attributes attached to the facet.

Public Method ListFacetAttributesAsync(ListFacetAttributesRequest, CancellationToken)

Retrieves attributes attached to the facet.

Public Method ListFacetNames(ListFacetNamesRequest)

Retrieves the names of facets that exist in a schema.

Public Method ListFacetNamesAsync(ListFacetNamesRequest, CancellationToken)

Retrieves the names of facets that exist in a schema.

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 Links.

Public Method ListIncomingTypedLinksAsync(ListIncomingTypedLinksRequest, CancellationToken)

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Public Method ListIndex(ListIndexRequest)

Lists objects attached to the specified index.

Public Method ListIndexAsync(ListIndexRequest, CancellationToken)

Lists objects attached to the specified index.

Public Method ListManagedSchemaArns(ListManagedSchemaArnsRequest)

Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Public Method ListManagedSchemaArnsAsync(ListManagedSchemaArnsRequest, CancellationToken)

Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Public Method ListObjectAttributes(ListObjectAttributesRequest)

Lists all attributes that are associated with an object.

Public Method ListObjectAttributesAsync(ListObjectAttributesRequest, CancellationToken)

Lists all attributes that are associated with an object.

Public Method ListObjectChildren(ListObjectChildrenRequest)

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

Public Method ListObjectChildrenAsync(ListObjectChildrenRequest, CancellationToken)

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

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)

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 ListObjectParents(ListObjectParentsRequest)

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

Public Method ListObjectParentsAsync(ListObjectParentsRequest, CancellationToken)

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

Public Method ListObjectPolicies(ListObjectPoliciesRequest)

Returns policies attached to an object in pagination fashion.

Public Method ListObjectPoliciesAsync(ListObjectPoliciesRequest, CancellationToken)

Returns policies attached to an object in pagination fashion.

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 Links.

Public Method ListOutgoingTypedLinksAsync(ListOutgoingTypedLinksRequest, CancellationToken)

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

Public Method ListPolicyAttachments(ListPolicyAttachmentsRequest)

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

Public Method ListPolicyAttachmentsAsync(ListPolicyAttachmentsRequest, CancellationToken)

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

Public Method ListPublishedSchemaArns(ListPublishedSchemaArnsRequest)

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Public Method ListPublishedSchemaArnsAsync(ListPublishedSchemaArnsRequest, CancellationToken)

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

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)

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 ListTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest)

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

Public Method ListTypedLinkFacetAttributesAsync(ListTypedLinkFacetAttributesRequest, CancellationToken)

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

Public Method ListTypedLinkFacetNames(ListTypedLinkFacetNamesRequest)

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

Public Method ListTypedLinkFacetNamesAsync(ListTypedLinkFacetNamesRequest, CancellationToken)

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

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)

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 PublishSchema(PublishSchemaRequest)

Publishes a development schema with a major version and a recommended minor version.

Public Method PublishSchemaAsync(PublishSchemaRequest, CancellationToken)

Publishes a development schema with a major version and a recommended minor version.

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)

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

Public Method RemoveFacetFromObject(RemoveFacetFromObjectRequest)

Removes the specified facet from the specified object.

Public Method RemoveFacetFromObjectAsync(RemoveFacetFromObjectRequest, CancellationToken)

Removes the specified facet from the specified object.

Public Method TagResource(TagResourceRequest)

An API operation for adding tags to a resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

An API operation for adding tags to a resource.

Public Method UntagResource(UntagResourceRequest)

An API operation for removing tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

An API operation for removing tags from a resource.

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)

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 UpdateLinkAttributes(UpdateLinkAttributesRequest)

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

Public Method UpdateLinkAttributesAsync(UpdateLinkAttributesRequest, CancellationToken)

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

Public Method UpdateObjectAttributes(UpdateObjectAttributesRequest)

Updates a given object's attributes.

Public Method UpdateObjectAttributesAsync(UpdateObjectAttributesRequest, CancellationToken)

Updates a given object's attributes.

Public Method UpdateSchema(UpdateSchemaRequest)

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

Public Method UpdateSchemaAsync(UpdateSchemaRequest, CancellationToken)

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

Public Method UpdateTypedLinkFacet(UpdateTypedLinkFacetRequest)

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

Public Method UpdateTypedLinkFacetAsync(UpdateTypedLinkFacetRequest, CancellationToken)

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

Public Method UpgradeAppliedSchema(UpgradeAppliedSchemaRequest)

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

Public Method UpgradeAppliedSchemaAsync(UpgradeAppliedSchemaRequest, CancellationToken)

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

Public Method UpgradePublishedSchema(UpgradePublishedSchemaRequest)

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Public Method UpgradePublishedSchemaAsync(UpgradePublishedSchemaRequest, CancellationToken)

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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